vtkDataTransferHelper Class Reference

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
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkDataTransferHelper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	GetExtentIsValid (int *extent)
bool	GetCPUExtentIsValid ()
bool	GetGPUExtentIsValid ()
bool	GetTextureExtentIsValid ()
bool	Download ()
bool	GetShaderSupportsTextureInt ()
void	SetShaderSupportsTextureInt (bool value)
virtual int	IsA (const char *type)
vtkDataTransferHelper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	GetExtentIsValid (int *extent)
bool	GetCPUExtentIsValid ()
bool	GetGPUExtentIsValid ()
bool	GetTextureExtentIsValid ()
bool	Download ()
bool	GetShaderSupportsTextureInt ()
void	SetShaderSupportsTextureInt (bool value)
void	SetContext (vtkRenderWindow *context)
vtkRenderWindow *	GetContext ()
virtual void	SetCPUExtent (int, int, int, int, int, int)
virtual void	SetCPUExtent (int[6])
virtual int *	GetCPUExtent ()
virtual void	GetCPUExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetCPUExtent (int[6])
virtual void	SetGPUExtent (int, int, int, int, int, int)
virtual void	SetGPUExtent (int[6])
virtual int *	GetGPUExtent ()
virtual void	GetGPUExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetGPUExtent (int[6])
virtual void	SetTextureExtent (int, int, int, int, int, int)
virtual void	SetTextureExtent (int[6])
virtual int *	GetTextureExtent ()
virtual void	GetTextureExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetTextureExtent (int[6])
virtual void	SetMinTextureDimension (int)
virtual int	GetMinTextureDimension ()
virtual vtkDataArray *	GetArray ()
void	SetArray (vtkDataArray *array)
virtual vtkTextureObject *	GetTexture ()
void	SetTexture (vtkTextureObject *texture)
bool	Upload (int components=0, int *componentList=NULL)
bool	DownloadAsync1 ()
bool	DownloadAsync2 ()
void	SetContext (vtkRenderWindow *context)
vtkRenderWindow *	GetContext ()
virtual void	SetCPUExtent (int, int, int, int, int, int)
virtual void	SetCPUExtent (int[6])
virtual int *	GetCPUExtent ()
virtual void	GetCPUExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetCPUExtent (int[6])
virtual void	SetGPUExtent (int, int, int, int, int, int)
virtual void	SetGPUExtent (int[6])
virtual int *	GetGPUExtent ()
virtual void	GetGPUExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetGPUExtent (int[6])
virtual void	SetTextureExtent (int, int, int, int, int, int)
virtual void	SetTextureExtent (int[6])
virtual int *	GetTextureExtent ()
virtual void	GetTextureExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetTextureExtent (int[6])
virtual void	SetMinTextureDimension (int)
virtual int	GetMinTextureDimension ()
virtual vtkDataArray *	GetArray ()
void	SetArray (vtkDataArray *array)
virtual vtkTextureObject *	GetTexture ()
void	SetTexture (vtkTextureObject *texture)
bool	Upload (int components=0, int *componentList=NULL)
bool	DownloadAsync1 ()
bool	DownloadAsync2 ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkDataTransferHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkDataTransferHelper *	SafeDownCast (vtkObjectBase *o)
static vtkDataTransferHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkDataTransferHelper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
bool	LoadRequiredExtensions (vtkOpenGLExtensionManager *)
vtkPixelBufferObject *	GetPBO ()
virtual vtkObjectBase *	NewInstanceInternal () const
vtkPixelBufferObject *	GetPBO ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	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
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
static bool	IsSupported (vtkRenderWindow *renWin)
	vtkDataTransferHelper ()
	~vtkDataTransferHelper ()
static bool	IsSupported (vtkRenderWindow *renWin)
	vtkDataTransferHelper ()
	~vtkDataTransferHelper ()

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 44 of file vtkDataTransferHelper.h.

Member Typedef Documentation

typedef vtkObject vtkDataTransferHelper::Superclass

Definition at line 48 of file vtkDataTransferHelper.h.

typedef vtkObject vtkDataTransferHelper::Superclass

Definition at line 47 of file vtkDataTransferHelper.h.

Constructor & Destructor Documentation

vtkDataTransferHelper::vtkDataTransferHelper ( )

protected

Returns if the context supports the required extensions.

vtkDataTransferHelper::~vtkDataTransferHelper ( )

protected

Returns if the context supports the required extensions.

vtkDataTransferHelper::vtkDataTransferHelper ( )

protected

Returns if the context supports the required extensions.

vtkDataTransferHelper::~vtkDataTransferHelper ( )

protected

Returns if the context supports the required extensions.

Member Function Documentation

static vtkDataTransferHelper* vtkDataTransferHelper::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkDataTransferHelper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkDataTransferHelper* vtkDataTransferHelper::NewInstance

(

)

const

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

virtual

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 vtkObject.

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 is the OpenGL context does not support the required OpenGL extensions.

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 is the OpenGL context does not support the required OpenGL extensions.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

virtual int* vtkDataTransferHelper::GetTextureExtent ( )

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

bool vtkDataTransferHelper::GetExtentIsValid

(

int *

extent

)

Tells if the given extent (6 int) is valid. True if min extent<=max extent.

Precondition

extent_exists: extent!=0

bool vtkDataTransferHelper::GetCPUExtentIsValid

(

)

Tells if CPUExtent is valid. True if min extent<=max extent.

bool vtkDataTransferHelper::GetGPUExtentIsValid

(

)

Tells if GPUExtent is valid. True if min extent<=max extent.

bool vtkDataTransferHelper::GetTextureExtentIsValid

(

)

Tells if TextureExtent is valid. True if min extent<=max extent.

virtual void vtkDataTransferHelper::SetMinTextureDimension ( int  )

virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writing GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

virtual int vtkDataTransferHelper::GetMinTextureDimension ( )

virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writing GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

virtual vtkDataArray* vtkDataTransferHelper::GetArray ( )

virtual

Get/Set the CPU data buffer. Initial value is 0.

void vtkDataTransferHelper::SetArray

(

vtkDataArray *

array

)

Get/Set the CPU data buffer. Initial value is 0.

virtual vtkTextureObject* vtkDataTransferHelper::GetTexture ( )

virtual

Get/Set the GPU data buffer. Initial value is 0.

void vtkDataTransferHelper::SetTexture

(

vtkTextureObject *

texture

)

Get/Set the GPU data buffer. Initial value is 0.

bool vtkDataTransferHelper::Upload	(	int	components = 0,
		int *	componentList = NULL
	)

Old comment. Upload Extent from CPU data buffer to GPU. The WholeExtent must match the Array size. New comment. Upload GPUExtent from CPU vtkDataArray to GPU texture. It is possible to send a subset of the components or to specify and order of components or both. If components=0, componentList is ignored and all components are passed, a texture cannot have more than 4 components.

Precondition

array_exists: array!=0

array_not_empty: array->GetNumberOfTuples()>0

valid_cpu_extent: this->GetCPUExtentIsValid()

valid_cpu_extent_size: (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()

valid_gpu_extent: this->GetGPUExtentIsValid()

gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]

gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)

texture_can_exist_or_not: texture==0 || texture!=0

valid_components: (components==0 && componentList==0 && array->GetNumberOfComponents()<=4) || (components>=1 && components<=array->GetNumberOfComponents() && components<=4 && componentList!=0)

bool vtkDataTransferHelper::Download

(

)

old comment: Download Extent from GPU data buffer to CPU. GPU data size must exactly match Extent. CPU data buffer will be resized to match WholeExtent in which only the Extent will be filled with the GPU data. new comment: Download GPUExtent from GPU texture to CPU vtkDataArray. If Array is not provided, it will be created with the size of CPUExtent. But only the tuples covered by GPUExtent will be download. In this case, if GPUExtent does not cover all GPUExtent, some of the vtkDataArray will be uninitialized. Reminder: A=>B <=> !A||B

Precondition

texture_exists: texture!=0

array_not_empty: array==0 || array->GetNumberOfTuples()>0

valid_cpu_extent: this->GetCPUExtentIsValid()

valid_cpu_extent_size: array==0 || (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()

valid_gpu_extent: this->GetGPUExtentIsValid()

gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]

gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)

valid_components: array==0 || array->GetNumberOfComponents()<=4

components_match: array==0 || (texture->GetComponents()==array->GetNumberOfComponents())

bool vtkDataTransferHelper::DownloadAsync1

(

)

Splits the download in two operations * Asynchronously download from texture memory to PBO (DownloadAsync1()). * Copy from pbo to user array (DownloadAsync2()).

bool vtkDataTransferHelper::DownloadAsync2

(

)

Splits the download in two operations * Asynchronously download from texture memory to PBO (DownloadAsync1()). * Copy from pbo to user array (DownloadAsync2()).

bool vtkDataTransferHelper::GetShaderSupportsTextureInt

(

)

void vtkDataTransferHelper::SetShaderSupportsTextureInt

(

bool

value

)

static bool vtkDataTransferHelper::IsSupported ( vtkRenderWindow *  renWin )

static

Returns if the context supports the required extensions.

bool vtkDataTransferHelper::LoadRequiredExtensions ( vtkOpenGLExtensionManager *  )

protected

Load all necessary extensions.

vtkPixelBufferObject* vtkDataTransferHelper::GetPBO ( )

protected

static vtkDataTransferHelper* vtkDataTransferHelper::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkDataTransferHelper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkDataTransferHelper* vtkDataTransferHelper::NewInstance

(

)

const

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

virtual

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 vtkObject.

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 is the OpenGL context does not support the required OpenGL extensions.

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 is the OpenGL context does not support the required OpenGL extensions.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

virtual int* vtkDataTransferHelper::GetTextureExtent ( )

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

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

virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

bool vtkDataTransferHelper::GetExtentIsValid

(

int *

extent

)

Tells if the given extent (6 int) is valid. True if min extent<=max extent.

Precondition

extent_exists: extent!=0

bool vtkDataTransferHelper::GetCPUExtentIsValid

(

)

Tells if CPUExtent is valid. True if min extent<=max extent.

bool vtkDataTransferHelper::GetGPUExtentIsValid

(

)

Tells if GPUExtent is valid. True if min extent<=max extent.

bool vtkDataTransferHelper::GetTextureExtentIsValid

(

)

Tells if TextureExtent is valid. True if min extent<=max extent.

virtual void vtkDataTransferHelper::SetMinTextureDimension ( int  )

virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writing GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

virtual int vtkDataTransferHelper::GetMinTextureDimension ( )

virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writing GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

virtual vtkDataArray* vtkDataTransferHelper::GetArray ( )

virtual

Get/Set the CPU data buffer. Initial value is 0.

void vtkDataTransferHelper::SetArray

(

vtkDataArray *

array

)

Get/Set the CPU data buffer. Initial value is 0.

virtual vtkTextureObject* vtkDataTransferHelper::GetTexture ( )

virtual

Get/Set the GPU data buffer. Initial value is 0.

void vtkDataTransferHelper::SetTexture

(

vtkTextureObject *

texture

)

Get/Set the GPU data buffer. Initial value is 0.

bool vtkDataTransferHelper::Upload	(	int	components = 0,
		int *	componentList = NULL
	)

Old comment. Upload Extent from CPU data buffer to GPU. The WholeExtent must match the Array size. New comment. Upload GPUExtent from CPU vtkDataArray to GPU texture. It is possible to send a subset of the components or to specify and order of components or both. If components=0, componentList is ignored and all components are passed, a texture cannot have more than 4 components.

Precondition

array_exists: array!=0

array_not_empty: array->GetNumberOfTuples()>0

valid_cpu_extent: this->GetCPUExtentIsValid()

valid_cpu_extent_size: (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()

valid_gpu_extent: this->GetGPUExtentIsValid()

gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]

gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)

texture_can_exist_or_not: texture==0 || texture!=0

valid_components: (components==0 && componentList==0 && array->GetNumberOfComponents()<=4) || (components>=1 && components<=array->GetNumberOfComponents() && components<=4 && componentList!=0)

bool vtkDataTransferHelper::Download

(

)

old comment: Download Extent from GPU data buffer to CPU. GPU data size must exactly match Extent. CPU data buffer will be resized to match WholeExtent in which only the Extent will be filled with the GPU data. new comment: Download GPUExtent from GPU texture to CPU vtkDataArray. If Array is not provided, it will be created with the size of CPUExtent. But only the tuples covered by GPUExtent will be download. In this case, if GPUExtent does not cover all GPUExtent, some of the vtkDataArray will be uninitialized. Reminder: A=>B <=> !A||B

Precondition

texture_exists: texture!=0

array_not_empty: array==0 || array->GetNumberOfTuples()>0

valid_cpu_extent: this->GetCPUExtentIsValid()

valid_cpu_extent_size: array==0 || (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()

valid_gpu_extent: this->GetGPUExtentIsValid()

gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]

gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)

valid_components: array==0 || array->GetNumberOfComponents()<=4

components_match: array==0 || (texture->GetComponents()==array->GetNumberOfComponents())

bool vtkDataTransferHelper::DownloadAsync1

(

)

Splits the download in two operations * Asynchronously download from texture memory to PBO (DownloadAsync1()). * Copy from pbo to user array (DownloadAsync2()).

bool vtkDataTransferHelper::DownloadAsync2

(

)

Splits the download in two operations * Asynchronously download from texture memory to PBO (DownloadAsync1()). * Copy from pbo to user array (DownloadAsync2()).

bool vtkDataTransferHelper::GetShaderSupportsTextureInt

(

)

void vtkDataTransferHelper::SetShaderSupportsTextureInt

(

bool

value

)

static bool vtkDataTransferHelper::IsSupported ( vtkRenderWindow *  renWin )

static

Returns if the context supports the required extensions.

vtkPixelBufferObject* vtkDataTransferHelper::GetPBO ( )

protected

Member Data Documentation

int vtkDataTransferHelper::CPUExtent

protected

Definition at line 205 of file vtkDataTransferHelper.h.

int vtkDataTransferHelper::GPUExtent

protected

Definition at line 206 of file vtkDataTransferHelper.h.

int vtkDataTransferHelper::TextureExtent

protected

Definition at line 207 of file vtkDataTransferHelper.h.

vtkWeakPointer< vtkRenderWindow > vtkDataTransferHelper::Context

protected

Definition at line 209 of file vtkDataTransferHelper.h.

vtkTextureObject * vtkDataTransferHelper::Texture

protected

Definition at line 210 of file vtkDataTransferHelper.h.

vtkDataArray * vtkDataTransferHelper::Array

protected

Definition at line 211 of file vtkDataTransferHelper.h.

bool vtkDataTransferHelper::ShaderSupportsTextureInt

protected

Definition at line 212 of file vtkDataTransferHelper.h.

int vtkDataTransferHelper::MinTextureDimension

protected

Definition at line 213 of file vtkDataTransferHelper.h.

vtkSmartPointer< vtkPixelBufferObject > vtkDataTransferHelper::AsyncDownloadPBO

protected

Definition at line 215 of file vtkDataTransferHelper.h.

vtkSmartPointer< vtkPixelBufferObject > vtkDataTransferHelper::PBO

protected

Definition at line 220 of file vtkDataTransferHelper.h.

---

The documentation for this class was generated from the following file:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkDataTransferHelper.h