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

vtkPixelBufferObject - abstracts an OpenGL pixel buffer object. More...

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

List of all members.

Public Types

enum  DynamicCopy_WrapperEnum {
  DynamicCopy = 8, DynamicDraw = 6, DynamicRead = 7, NumberOfUsages = 9,
  StaticCopy = 5, StaticDraw = 3, StaticRead = 4, StreamCopy = 2,
  StreamDraw = 0, StreamRead = 1
}
 Undocumented Block. More...
enum  BufferType { PACKED_BUFFER = 0, UNPACKED_BUFFER = 1 }
 Inactivate the buffer. More...

Public Member Functions

 vtkPixelBufferObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPixelBufferObject ()
 Undocumented Block.
void Allocate (uint size, int type)
 Inactivate the buffer.
void Bind (vtkPixelBufferObject.BufferType buffer)
 Inactivate the buffer.
void BindToPackedBuffer ()
 For wrapping.
void BindToUnPackedBuffer ()
 For wrapping.
bool Download1D (int type, IntPtr data, uint dim, int numcomps, int increment)
 Download data from pixel buffer to the 1D array. The length of the array must be equal to the size of the data in the memory.
bool Download2D (int type, IntPtr data, IntPtr dims, int numcomps, IntPtr increments)
 Download data from pixel buffer to the 2D array. (lengthx * lengthy) must be equal to the size of the data in the memory.
bool Download3D (int type, IntPtr data, IntPtr dims, int numcomps, IntPtr increments)
 Download data from pixel buffer to the 3D array. (lengthx * lengthy * lengthz) must be equal to the size of the data in the memory.
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.
virtual uint GetHandle ()
 Get the openGL buffer handle.
virtual uint GetSize ()
 Get the size of the data loaded into the GPU. Size is in the number of elements of the uploaded Type.
virtual int GetTypeWrapper ()
 Get the type with which the data is loaded into the GPU. eg. VTK_FLOAT for float32, VTK_CHAR for byte, VTK_UNSIGNED_CHAR for unsigned byte etc.
virtual int GetUsage ()
 Usage is a performance hint. Valid values are:
override int IsA (string type)
 Undocumented Block.
new vtkPixelBufferObject NewInstance ()
 Undocumented Block.
void ReleaseMemory ()
 Inactivate the buffer.
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 SetUsage (int _arg)
 Usage is a performance hint. Valid values are:
void UnBind ()
 Inactivate the buffer.
bool Upload1D (int type, IntPtr data, uint numtuples, int comps, int increment)
 Upload data to GPU. The input data can be freed after this call. The data ptr is treated as an 1D array with the given number of tuples and given number of components in each tuple to be copied to the GPU. increment is the offset added after the last component in each tuple is transferred. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.
bool Upload2D (int type, IntPtr data, IntPtr dims, int comps, IntPtr increments)
 Update data to GPU sourcing it from a 2D array. The input data can be freed after this call. The data ptr is treated as a 2D array with increments indicating how to iterate over the data. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.
bool Upload3D (int type, IntPtr data, IntPtr dims, int comps, IntPtr increments, int components, IntPtr componentList)
 Update data to GPU sourcing it from a 3D array. The input data can be freed after this call. The data ptr is treated as a 3D array with increments indicating how to iterate over the data. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.

Static Public Member Functions

static new vtkPixelBufferObject New ()
 Undocumented Block.
static bool IsSupported (vtkRenderWindow renWin)
 Inactivate the buffer.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkPixelBufferObject SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkPixelBufferObject"
 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 vtkPixelBufferObject_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPixelBufferObject_Allocate_01 (HandleRef pThis, uint size, int type)
static internal void vtkPixelBufferObject_Bind_02 (HandleRef pThis, vtkPixelBufferObject.BufferType buffer)
static internal void vtkPixelBufferObject_BindToPackedBuffer_03 (HandleRef pThis)
static internal void vtkPixelBufferObject_BindToUnPackedBuffer_04 (HandleRef pThis)
static internal byte vtkPixelBufferObject_Download1D_05 (HandleRef pThis, int type, IntPtr data, uint dim, int numcomps, int increment)
static internal byte vtkPixelBufferObject_Download2D_06 (HandleRef pThis, int type, IntPtr data, IntPtr dims, int numcomps, IntPtr increments)
static internal byte vtkPixelBufferObject_Download3D_07 (HandleRef pThis, int type, IntPtr data, IntPtr dims, int numcomps, IntPtr increments)
static internal IntPtr vtkPixelBufferObject_GetContext_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkPixelBufferObject_GetHandle_09 (HandleRef pThis)
static internal uint vtkPixelBufferObject_GetSize_10 (HandleRef pThis)
static internal int vtkPixelBufferObject_GetType_11 (HandleRef pThis)
static internal int vtkPixelBufferObject_GetUsage_12 (HandleRef pThis)
static internal int vtkPixelBufferObject_IsA_13 (HandleRef pThis, string type)
static internal byte vtkPixelBufferObject_IsSupported_14 (HandleRef renWin)
static internal int vtkPixelBufferObject_IsTypeOf_15 (string type)
static internal IntPtr vtkPixelBufferObject_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPixelBufferObject_ReleaseMemory_18 (HandleRef pThis)
static internal IntPtr vtkPixelBufferObject_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPixelBufferObject_SetContext_20 (HandleRef pThis, HandleRef context)
static internal void vtkPixelBufferObject_SetUsage_21 (HandleRef pThis, int _arg)
static internal void vtkPixelBufferObject_UnBind_22 (HandleRef pThis)
static internal byte vtkPixelBufferObject_Upload1D_23 (HandleRef pThis, int type, IntPtr data, uint numtuples, int comps, int increment)
static internal byte vtkPixelBufferObject_Upload2D_24 (HandleRef pThis, int type, IntPtr data, IntPtr dims, int comps, IntPtr increments)
static internal byte vtkPixelBufferObject_Upload3D_25 (HandleRef pThis, int type, IntPtr data, IntPtr dims, int comps, IntPtr increments, int components, IntPtr componentList)

Static Private Member Functions

static vtkPixelBufferObject ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPixelBufferObject - abstracts an OpenGL pixel buffer object.

Description Provides low-level access to GPU memory. Used to pass raw data to GPU. The data is uploaded into a pixel buffer. Caveats Since most GPUs don't support double format all double data is converted to float and then uploaded. DON'T PLAY WITH IT YET.

OpenGL Pixel Buffer Object Extension Spec (ARB_pixel_buffer_object): http://www.opengl.org/registry/specs/ARB/pixel_buffer_object.txt


Member Enumeration Documentation

Inactivate the buffer.

Enumerator:
PACKED_BUFFER 

enum member

UNPACKED_BUFFER 

enum member

Undocumented Block.

Enumerator:
DynamicCopy 

enum member

DynamicDraw 

enum member

DynamicRead 

enum member

NumberOfUsages 

enum member

StaticCopy 

enum member

StaticDraw 

enum member

StaticRead 

enum member

StreamCopy 

enum member

StreamDraw 

enum member

StreamRead 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

void Kitware.VTK.vtkPixelBufferObject.Allocate ( uint  size,
int  type 
)

Inactivate the buffer.

Inactivate the buffer.

For wrapping.

For wrapping.

override void Kitware.VTK.vtkPixelBufferObject.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.

bool Kitware.VTK.vtkPixelBufferObject.Download1D ( int  type,
IntPtr  data,
uint  dim,
int  numcomps,
int  increment 
)

Download data from pixel buffer to the 1D array. The length of the array must be equal to the size of the data in the memory.

bool Kitware.VTK.vtkPixelBufferObject.Download2D ( int  type,
IntPtr  data,
IntPtr  dims,
int  numcomps,
IntPtr  increments 
)

Download data from pixel buffer to the 2D array. (lengthx * lengthy) must be equal to the size of the data in the memory.

bool Kitware.VTK.vtkPixelBufferObject.Download3D ( int  type,
IntPtr  data,
IntPtr  dims,
int  numcomps,
IntPtr  increments 
)

Download data from pixel buffer to the 3D array. (lengthx * lengthy * lengthz) must be equal to the size of the data in the memory.

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 uint Kitware.VTK.vtkPixelBufferObject.GetHandle ( ) [virtual]

Get the openGL buffer handle.

virtual uint Kitware.VTK.vtkPixelBufferObject.GetSize ( ) [virtual]

Get the size of the data loaded into the GPU. Size is in the number of elements of the uploaded Type.

Get the type with which the data is loaded into the GPU. eg. VTK_FLOAT for float32, VTK_CHAR for byte, VTK_UNSIGNED_CHAR for unsigned byte etc.

virtual int Kitware.VTK.vtkPixelBufferObject.GetUsage ( ) [virtual]

Usage is a performance hint. Valid values are:

  • StreamDraw specified once by A, used few times S
  • StreamRead specified once by R, queried a few times by A
  • StreamCopy specified once by R, used a few times S
  • StaticDraw specified once by A, used many times S
  • StaticRead specificed once by R, queried many times by A
  • StaticCopy specified once by R, used many times S
  • DynamicDraw respecified repeatedly by A, used many times S
  • DynamicRead respecified repeatedly by R, queried many times by A
  • DynamicCopy respecified repeatedly by R, used many times S A: the application S: as the source for GL drawing and image specification commands. R: reading data from the GL Initial value is StaticDraw, as in OpenGL spec.
override int Kitware.VTK.vtkPixelBufferObject.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Inactivate the buffer.

static new int Kitware.VTK.vtkPixelBufferObject.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.

Inactivate the buffer.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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.

virtual void Kitware.VTK.vtkPixelBufferObject.SetUsage ( int  _arg) [virtual]

Usage is a performance hint. Valid values are:

  • StreamDraw specified once by A, used few times S
  • StreamRead specified once by R, queried a few times by A
  • StreamCopy specified once by R, used a few times S
  • StaticDraw specified once by A, used many times S
  • StaticRead specificed once by R, queried many times by A
  • StaticCopy specified once by R, used many times S
  • DynamicDraw respecified repeatedly by A, used many times S
  • DynamicRead respecified repeatedly by R, queried many times by A
  • DynamicCopy respecified repeatedly by R, used many times S A: the application S: as the source for GL drawing and image specification commands. R: reading data from the GL Initial value is StaticDraw, as in OpenGL spec.

Inactivate the buffer.

bool Kitware.VTK.vtkPixelBufferObject.Upload1D ( int  type,
IntPtr  data,
uint  numtuples,
int  comps,
int  increment 
)

Upload data to GPU. The input data can be freed after this call. The data ptr is treated as an 1D array with the given number of tuples and given number of components in each tuple to be copied to the GPU. increment is the offset added after the last component in each tuple is transferred. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.

bool Kitware.VTK.vtkPixelBufferObject.Upload2D ( int  type,
IntPtr  data,
IntPtr  dims,
int  comps,
IntPtr  increments 
)

Update data to GPU sourcing it from a 2D array. The input data can be freed after this call. The data ptr is treated as a 2D array with increments indicating how to iterate over the data. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.

bool Kitware.VTK.vtkPixelBufferObject.Upload3D ( int  type,
IntPtr  data,
IntPtr  dims,
int  comps,
IntPtr  increments,
int  components,
IntPtr  componentList 
)

Update data to GPU sourcing it from a 3D array. The input data can be freed after this call. The data ptr is treated as a 3D array with increments indicating how to iterate over the data. Look at the documentation for ContinuousIncrements in vtkImageData for details about how increments are specified.

static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Allocate_01 ( HandleRef  pThis,
uint  size,
int  type 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Bind_02 ( HandleRef  pThis,
vtkPixelBufferObject.BufferType  buffer 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_BindToPackedBuffer_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_BindToUnPackedBuffer_04 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Download1D_05 ( HandleRef  pThis,
int  type,
IntPtr  data,
uint  dim,
int  numcomps,
int  increment 
) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Download2D_06 ( HandleRef  pThis,
int  type,
IntPtr  data,
IntPtr  dims,
int  numcomps,
IntPtr  increments 
) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Download3D_07 ( HandleRef  pThis,
int  type,
IntPtr  data,
IntPtr  dims,
int  numcomps,
IntPtr  increments 
) [private]
static internal IntPtr Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_GetContext_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_GetHandle_09 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_GetSize_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_GetType_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_GetUsage_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_IsA_13 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_IsSupported_14 ( HandleRef  renWin) [private]
static internal int Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_IsTypeOf_15 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_ReleaseMemory_18 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_SetContext_20 ( HandleRef  pThis,
HandleRef  context 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_SetUsage_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_UnBind_22 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Upload1D_23 ( HandleRef  pThis,
int  type,
IntPtr  data,
uint  numtuples,
int  comps,
int  increment 
) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Upload2D_24 ( HandleRef  pThis,
int  type,
IntPtr  data,
IntPtr  dims,
int  comps,
IntPtr  increments 
) [private]
static internal byte Kitware.VTK.vtkPixelBufferObject.vtkPixelBufferObject_Upload3D_25 ( HandleRef  pThis,
int  type,
IntPtr  data,
IntPtr  dims,
int  comps,
IntPtr  increments,
int  components,
IntPtr  componentList 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPixelBufferObject.MRClassNameKey = "20vtkPixelBufferObject" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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