is a helper class that aids in transferring data between CPU memory and GPU memory. More...

#include <vtkDataTransferHelper.h>

Inheritance diagram for vtkDataTransferHelper:

Collaboration diagram for vtkDataTransferHelper:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataTransferHelper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

bool	GetExtentIsValid (int *extent)
	Tells if the given extent (6 int) is valid.

bool	GetCPUExtentIsValid ()
	Tells if CPUExtent is valid.

bool	GetGPUExtentIsValid ()
	Tells if GPUExtent is valid.

bool	GetTextureExtentIsValid ()
	Tells if TextureExtent is valid.

bool	Upload (int components=0, int *componentList=nullptr)
	Old comment.

bool	Download ()
	old comment: Download Extent from GPU data buffer to CPU.

bool	GetShaderSupportsTextureInt ()

void	SetShaderSupportsTextureInt (bool value)


void	SetContext (vtkRenderWindow *context)
	Get/Set the context.

vtkRenderWindow *	GetContext ()
	Get/Set the context.


virtual void	SetCPUExtent (int, int, int, int, int, int)
	Set the CPU data extent.

virtual void	SetCPUExtent (int[6])
	Set the CPU data extent.

virtual int *	GetCPUExtent ()
	Set the CPU data extent.

virtual void	GetCPUExtent (int &, int &, int &, int &, int &, int &)
	Set the CPU data extent.

virtual void	GetCPUExtent (int[6])
	Set the CPU data extent.


virtual void	SetGPUExtent (int, int, int, int, int, int)
	Set the GPU data extent.

virtual void	SetGPUExtent (int[6])
	Set the GPU data extent.

virtual int *	GetGPUExtent ()
	Set the GPU data extent.

virtual void	GetGPUExtent (int &, int &, int &, int &, int &, int &)
	Set the GPU data extent.

virtual void	GetGPUExtent (int[6])
	Set the GPU data extent.


virtual void	SetTextureExtent (int, int, int, int, int, int)
	Set the texture data extent.

virtual void	SetTextureExtent (int[6])
	Set the texture data extent.

virtual int *	GetTextureExtent ()
	Set the texture data extent.

virtual void	GetTextureExtent (int &, int &, int &, int &, int &, int &)
	Set the texture data extent.

virtual void	GetTextureExtent (int[6])
	Set the texture data extent.


virtual void	SetMinTextureDimension (int)
	Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent.

virtual int	GetMinTextureDimension ()
	Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent.


virtual vtkDataArray *	GetArray ()
	Get/Set the CPU data buffer.

void	SetArray (vtkDataArray *array)
	Get/Set the CPU data buffer.


virtual vtkTextureObject *	GetTexture ()
	Get/Set the GPU data buffer.

void	SetTexture (vtkTextureObject *texture)
	Get/Set the GPU data buffer.


bool	DownloadAsync1 ()
	Splits the download in two operations.

bool	DownloadAsync2 ()
	Splits the download in two operations.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkDataTransferHelper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataTransferHelper *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkRenderWindow *renWin)
	Returns if the context supports the required extensions.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataTransferHelper ()

	~vtkDataTransferHelper () override

vtkPixelBufferObject *	GetPBO ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	CPUExtent [6]

int	GPUExtent [6]

int	TextureExtent [6]

vtkWeakPointer< vtkRenderWindow >	Context

vtkTextureObject *	Texture

vtkDataArray *	Array

bool	ShaderSupportsTextureInt

int	MinTextureDimension

vtkSmartPointer< vtkPixelBufferObject >	AsyncDownloadPBO

vtkSmartPointer< vtkPixelBufferObject >	PBO

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

is a helper class that aids in transferring data between CPU memory and GPU memory.

vtkDataTransferHelper is a helper class that aids in transferring data between the CPU memory and the GPU memory. The data in GPU memory is stored as textures which that in CPU memory is stored as vtkDataArray. vtkDataTransferHelper provides API to transfer only a sub-extent of CPU structured data to/from the GPU.

See also: vtkPixelBufferObject vtkTextureObject vtkOpenGLExtensionManager

Definition at line 33 of file vtkDataTransferHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDataTransferHelper::Superclass

Definition at line 37 of file vtkDataTransferHelper.h.

Constructor & Destructor Documentation

◆ vtkDataTransferHelper()

vtkDataTransferHelper::vtkDataTransferHelper ( )

protected

◆ ~vtkDataTransferHelper()

vtkDataTransferHelper::~vtkDataTransferHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDataTransferHelper * vtkDataTransferHelper::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkDataTransferHelper::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkDataTransferHelper::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkDataTransferHelper * vtkDataTransferHelper::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataTransferHelper::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkDataTransferHelper * vtkDataTransferHelper::NewInstance ( ) const

◆ PrintSelf()

void vtkDataTransferHelper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

◆ SetContext()

void vtkDataTransferHelper::SetContext ( vtkRenderWindow * context )

Get/Set the context.

Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error if the OpenGL context does not support the required OpenGL extensions.

◆ GetContext()

vtkRenderWindow * vtkDataTransferHelper::GetContext ( )

Get/Set the context.

Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error if the OpenGL context does not support the required OpenGL extensions.

◆ SetCPUExtent() [1/2]

virtual void vtkDataTransferHelper::SetCPUExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

virtual

Set the CPU data extent.

The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ SetCPUExtent() [2/2]

virtual void vtkDataTransferHelper::SetCPUExtent ( int [6] )

virtual

Set the CPU data extent.

The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetCPUExtent() [1/3]

virtual int * vtkDataTransferHelper::GetCPUExtent ( )

virtual

Set the CPU data extent.

The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetCPUExtent() [2/3]

virtual void vtkDataTransferHelper::GetCPUExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)

virtual

Set the CPU data extent.

The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetCPUExtent() [3/3]

virtual void vtkDataTransferHelper::GetCPUExtent ( int [6] )

virtual

Set the CPU data extent.

The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ SetGPUExtent() [1/2]

virtual void vtkDataTransferHelper::SetGPUExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

virtual

Set the GPU data extent.

This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ SetGPUExtent() [2/2]

virtual void vtkDataTransferHelper::SetGPUExtent ( int [6] )

virtual

Set the GPU data extent.

This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetGPUExtent() [1/3]

virtual int * vtkDataTransferHelper::GetGPUExtent ( )

virtual

Set the GPU data extent.

This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetGPUExtent() [2/3]

virtual void vtkDataTransferHelper::GetGPUExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)

virtual

Set the GPU data extent.

This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

◆ GetGPUExtent() [3/3]

virtual void vtkDataTransferHelper::GetGPUExtent ( int [6] )

virtual

Set the GPU data extent.

This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.