ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkDataTransferHelper Class Reference

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

Inheritance diagram for Kitware.VTK.vtkDataTransferHelper:
[legend]
Collaboration diagram for Kitware.VTK.vtkDataTransferHelper:
[legend]

List of all members.

Public Member Functions

 vtkDataTransferHelper (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDataTransferHelper ()
 Undocumented Block.
bool 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
bool DownloadAsync1 ()
 Splits the download in two operations Asynchronously download from texture memory to PBO (DownloadAsync1()). Copy from pbo to user array (DownloadAsync2()).
bool DownloadAsync2 ()
 Splits the download in two operations Asynchronously download from texture memory to PBO (DownloadAsync1()). Copy from pbo to user array (DownloadAsync2()).
virtual vtkDataArray GetArray ()
 Get/Set the CPU data buffer. Initial value is 0.
virtual int[] GetCPUExtent ()
 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 GetCPUExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 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 GetCPUExtent (IntPtr _arg)
 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.
bool GetCPUExtentIsValid ()
 Tells if CPUExtent is valid. True if min extent<=max extent.
vtkRenderWindow 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.
bool GetExtentIsValid (IntPtr extent)
 Tells if the given extent (6 int) is valid. True if min extent<=max extent.
virtual int[] GetGPUExtent ()
 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 GetGPUExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 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 GetGPUExtent (IntPtr _arg)
 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.
bool GetGPUExtentIsValid ()
 Tells if GPUExtent is valid. True if min extent<=max extent.
virtual int GetMinTextureDimension ()
 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 writting 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.
bool GetShaderSupportsTextureInt ()
 Splits the download in two operations Asynchronously download from texture memory to PBO (DownloadAsync1()). Copy from pbo to user array (DownloadAsync2()).
virtual vtkTextureObject GetTexture ()
 Get/Set the GPU data buffer. Initial value is 0.
virtual int[] GetTextureExtent ()
 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 GetTextureExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 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 GetTextureExtent (IntPtr _arg)
 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 GetTextureExtentIsValid ()
 Tells if TextureExtent is valid. True if min extent<=max extent.
override int IsA (string type)
 Undocumented Block.
new vtkDataTransferHelper NewInstance ()
 Undocumented Block.
void SetArray (vtkDataArray array)
 Get/Set the CPU data buffer. Initial value is 0.
virtual void SetCPUExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 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 SetCPUExtent (IntPtr _arg)
 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.
void 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.
virtual void SetGPUExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 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 SetGPUExtent (IntPtr _arg)
 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 SetMinTextureDimension (int _arg)
 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 writting 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.
void SetShaderSupportsTextureInt (bool value)
 Splits the download in two operations Asynchronously download from texture memory to PBO (DownloadAsync1()). Copy from pbo to user array (DownloadAsync2()).
void SetTexture (vtkTextureObject texture)
 Get/Set the GPU data buffer. Initial value is 0.
virtual void SetTextureExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 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 SetTextureExtent (IntPtr _arg)
 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 Upload (int components, IntPtr componentList)
 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.

Static Public Member Functions

static new vtkDataTransferHelper New ()
 Undocumented Block.
static bool IsSupported (vtkRenderWindow renWin)
 Returns if the context supports the required extensions.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkDataTransferHelper SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDataTransferHelper"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkDataTransferHelper"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkDataTransferHelper_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkDataTransferHelper_Download_01 (HandleRef pThis)
static internal byte vtkDataTransferHelper_DownloadAsync1_02 (HandleRef pThis)
static internal byte vtkDataTransferHelper_DownloadAsync2_03 (HandleRef pThis)
static internal IntPtr vtkDataTransferHelper_GetArray_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDataTransferHelper_GetCPUExtent_05 (HandleRef pThis)
static internal void vtkDataTransferHelper_GetCPUExtent_06 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkDataTransferHelper_GetCPUExtent_07 (HandleRef pThis, IntPtr _arg)
static internal byte vtkDataTransferHelper_GetCPUExtentIsValid_08 (HandleRef pThis)
static internal IntPtr vtkDataTransferHelper_GetContext_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkDataTransferHelper_GetExtentIsValid_10 (HandleRef pThis, IntPtr extent)
static internal IntPtr vtkDataTransferHelper_GetGPUExtent_11 (HandleRef pThis)
static internal void vtkDataTransferHelper_GetGPUExtent_12 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkDataTransferHelper_GetGPUExtent_13 (HandleRef pThis, IntPtr _arg)
static internal byte vtkDataTransferHelper_GetGPUExtentIsValid_14 (HandleRef pThis)
static internal int vtkDataTransferHelper_GetMinTextureDimension_15 (HandleRef pThis)
static internal byte vtkDataTransferHelper_GetShaderSupportsTextureInt_16 (HandleRef pThis)
static internal IntPtr vtkDataTransferHelper_GetTexture_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDataTransferHelper_GetTextureExtent_18 (HandleRef pThis)
static internal void vtkDataTransferHelper_GetTextureExtent_19 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkDataTransferHelper_GetTextureExtent_20 (HandleRef pThis, IntPtr _arg)
static internal byte vtkDataTransferHelper_GetTextureExtentIsValid_21 (HandleRef pThis)
static internal int vtkDataTransferHelper_IsA_22 (HandleRef pThis, string type)
static internal byte vtkDataTransferHelper_IsSupported_23 (HandleRef renWin)
static internal int vtkDataTransferHelper_IsTypeOf_24 (string type)
static internal IntPtr vtkDataTransferHelper_NewInstance_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDataTransferHelper_SafeDownCast_27 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDataTransferHelper_SetArray_28 (HandleRef pThis, HandleRef array)
static internal void vtkDataTransferHelper_SetCPUExtent_29 (HandleRef pThis, int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
static internal void vtkDataTransferHelper_SetCPUExtent_30 (HandleRef pThis, IntPtr _arg)
static internal void vtkDataTransferHelper_SetContext_31 (HandleRef pThis, HandleRef context)
static internal void vtkDataTransferHelper_SetGPUExtent_32 (HandleRef pThis, int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
static internal void vtkDataTransferHelper_SetGPUExtent_33 (HandleRef pThis, IntPtr _arg)
static internal void vtkDataTransferHelper_SetMinTextureDimension_34 (HandleRef pThis, int _arg)
static internal void vtkDataTransferHelper_SetShaderSupportsTextureInt_35 (HandleRef pThis, byte value)
static internal void vtkDataTransferHelper_SetTexture_36 (HandleRef pThis, HandleRef texture)
static internal void vtkDataTransferHelper_SetTextureExtent_37 (HandleRef pThis, int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
static internal void vtkDataTransferHelper_SetTextureExtent_38 (HandleRef pThis, IntPtr _arg)
static internal byte vtkDataTransferHelper_Upload_39 (HandleRef pThis, int components, IntPtr componentList)

Static Private Member Functions

static vtkDataTransferHelper ()
 Automatically generated type registration mechanics.

Detailed Description

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

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

vtkPixelBufferObject vtkTextureObject vtkOpenGLExtensionManager


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkDataTransferHelper.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

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())

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

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

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

Here is the call graph for this function:

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.

Here is the call graph for this function:

virtual int [] Kitware.VTK.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 Kitware.VTK.vtkDataTransferHelper.GetCPUExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.GetCPUExtent ( IntPtr  _arg) [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.

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

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

Precondition:
extent_exists: extent!=0
virtual int [] Kitware.VTK.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 Kitware.VTK.vtkDataTransferHelper.GetGPUExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.GetGPUExtent ( IntPtr  _arg) [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.

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

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

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

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

Here is the call graph for this function:

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 Kitware.VTK.vtkDataTransferHelper.GetTextureExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.GetTextureExtent ( IntPtr  _arg) [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.

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

override int Kitware.VTK.vtkDataTransferHelper.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Returns if the context supports the required extensions.

static new int Kitware.VTK.vtkDataTransferHelper.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

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

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 Kitware.VTK.vtkDataTransferHelper.SetCPUExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.SetCPUExtent ( IntPtr  _arg) [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 Kitware.VTK.vtkDataTransferHelper.SetGPUExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.SetGPUExtent ( IntPtr  _arg) [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 Kitware.VTK.vtkDataTransferHelper.SetMinTextureDimension ( int  _arg) [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 writting 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.

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

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

virtual void Kitware.VTK.vtkDataTransferHelper.SetTextureExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [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 Kitware.VTK.vtkDataTransferHelper.SetTextureExtent ( IntPtr  _arg) [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 Kitware.VTK.vtkDataTransferHelper.Upload ( int  components,
IntPtr  componentList 
)

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)
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_Download_01 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_DownloadAsync1_02 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_DownloadAsync2_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetArray_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetContext_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetCPUExtent_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetCPUExtent_06 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetCPUExtent_07 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetCPUExtentIsValid_08 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetExtentIsValid_10 ( HandleRef  pThis,
IntPtr  extent 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetGPUExtent_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetGPUExtent_12 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetGPUExtent_13 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetGPUExtentIsValid_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetTexture_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetTextureExtent_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetTextureExtent_19 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_GetTextureExtent_20 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_IsA_22 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_IsSupported_23 ( HandleRef  renWin) [private]
static internal int Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_IsTypeOf_24 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_NewInstance_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SafeDownCast_27 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetArray_28 ( HandleRef  pThis,
HandleRef  array 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetContext_31 ( HandleRef  pThis,
HandleRef  context 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetCPUExtent_29 ( HandleRef  pThis,
int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetCPUExtent_30 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetGPUExtent_32 ( HandleRef  pThis,
int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetGPUExtent_33 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetMinTextureDimension_34 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetShaderSupportsTextureInt_35 ( HandleRef  pThis,
byte  value 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetTexture_36 ( HandleRef  pThis,
HandleRef  texture 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetTextureExtent_37 ( HandleRef  pThis,
int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [private]
static internal void Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_SetTextureExtent_38 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal byte Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper_Upload_39 ( HandleRef  pThis,
int  components,
IntPtr  componentList 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDataTransferHelper.MRClassNameKey = "21vtkDataTransferHelper" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkDataTransferHelper.MRFullTypeName = "Kitware.VTK.vtkDataTransferHelper"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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