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.vtkFrameBufferObject Class Reference

vtkFrameBufferObject - internal class which encapsulates OpenGL frame buffer object. Not to be used directly. More...

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

List of all members.

Public Member Functions

 vtkFrameBufferObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkFrameBufferObject ()
 Undocumented Block.
void Bind ()
 Save the current framebuffer and make the frame buffer active. Multiple calls to Bind has no effect.
vtkTextureObject GetColorBuffer (uint index)
 All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.
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 bool GetDepthBufferNeeded ()
 If true, the frame buffer object will be initialized with a depth buffer. Initial value is true.
virtual int[] GetLastSize ()
 Dimensions in pixels of the framebuffer.
virtual void GetLastSize (ref int _arg1, ref int _arg2)
 Dimensions in pixels of the framebuffer.
virtual void GetLastSize (IntPtr _arg)
 Dimensions in pixels of the framebuffer.
uint GetMaximumNumberOfActiveTargets ()
 Returns the maximum number of targets that can be rendered to at one time. This limits the active targets set by SetActiveTargets(). The return value is valid only if GetContext is non-null.
uint GetMaximumNumberOfRenderTargets ()
 Returns the maximum number of render targets available. This limits the available attachement points for SetColorAttachment(). The return value is valid only if GetContext is non-null.
virtual uint GetNumberOfRenderTargets ()
 Set/Get the number of render targets to render into at once.
override int IsA (string type)
 Undocumented Block.
new vtkFrameBufferObject NewInstance ()
 Undocumented Block.
void RemoveAllColorBuffers ()
 All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.
void RemoveColorBuffer (uint index)
 All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.
void RemoveDepthBuffer ()
 Set the texture to use as depth buffer.
void RenderQuad (int minX, int maxX, int minY, int maxY)
 Renders a quad at the given location with pixel coordinates. This method is provided as a convenience, since we often render quads in a FBO.
void SetActiveBuffer (uint index)
 Choose the buffer to render into.
void SetActiveBuffers (int numbuffers, IntPtr indices)
 Choose the buffer to render into. This is available only if the GL_ARB_draw_buffers extension is supported by the card.
void SetColorBuffer (uint index, vtkTextureObject texture, uint zslice)
 All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.
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.
void SetDepthBuffer (vtkTextureObject depthTexture)
 Set the texture to use as depth buffer.
virtual void SetDepthBufferNeeded (bool _arg)
 If true, the frame buffer object will be initialized with a depth buffer. Initial value is true.
void SetNumberOfRenderTargets (uint arg0)
 Set/Get the number of render targets to render into at once.
bool Start (int width, int height, bool shaderSupportsTextureInt)
 User must take care that width/height match the dimensions of the user defined texture attachments. This method makes the "active buffers" the buffers that will get drawn into by subsequent drawing calls. Note that this does not clear the render buffers i.e. no glClear() calls are made by either of these methods. It's up to the caller to clear the buffers if needed.
bool StartNonOrtho (int width, int height, bool shaderSupportsTextureInt)
 User must take care that width/height match the dimensions of the user defined texture attachments. This method makes the "active buffers" the buffers that will get drawn into by subsequent drawing calls. Note that this does not clear the render buffers i.e. no glClear() calls are made by either of these methods. It's up to the caller to clear the buffers if needed.
void UnBind ()
 Restore the framebuffer saved with the call to Bind(). Multiple calls to UnBind has no effect.

Static Public Member Functions

static new vtkFrameBufferObject 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 vtkFrameBufferObject SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkFrameBufferObject"
 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 vtkFrameBufferObject_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkFrameBufferObject_Bind_01 (HandleRef pThis)
static internal IntPtr vtkFrameBufferObject_GetColorBuffer_02 (HandleRef pThis, uint index, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkFrameBufferObject_GetContext_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkFrameBufferObject_GetDepthBufferNeeded_04 (HandleRef pThis)
static internal IntPtr vtkFrameBufferObject_GetLastSize_05 (HandleRef pThis)
static internal void vtkFrameBufferObject_GetLastSize_06 (HandleRef pThis, ref int _arg1, ref int _arg2)
static internal void vtkFrameBufferObject_GetLastSize_07 (HandleRef pThis, IntPtr _arg)
static internal uint vtkFrameBufferObject_GetMaximumNumberOfActiveTargets_08 (HandleRef pThis)
static internal uint vtkFrameBufferObject_GetMaximumNumberOfRenderTargets_09 (HandleRef pThis)
static internal uint vtkFrameBufferObject_GetNumberOfRenderTargets_10 (HandleRef pThis)
static internal int vtkFrameBufferObject_IsA_11 (HandleRef pThis, string type)
static internal byte vtkFrameBufferObject_IsSupported_12 (HandleRef renWin)
static internal int vtkFrameBufferObject_IsTypeOf_13 (string type)
static internal IntPtr vtkFrameBufferObject_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkFrameBufferObject_RemoveAllColorBuffers_16 (HandleRef pThis)
static internal void vtkFrameBufferObject_RemoveColorBuffer_17 (HandleRef pThis, uint index)
static internal void vtkFrameBufferObject_RemoveDepthBuffer_18 (HandleRef pThis)
static internal void vtkFrameBufferObject_RenderQuad_19 (HandleRef pThis, int minX, int maxX, int minY, int maxY)
static internal IntPtr vtkFrameBufferObject_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkFrameBufferObject_SetActiveBuffer_21 (HandleRef pThis, uint index)
static internal void vtkFrameBufferObject_SetActiveBuffers_22 (HandleRef pThis, int numbuffers, IntPtr indices)
static internal void vtkFrameBufferObject_SetColorBuffer_23 (HandleRef pThis, uint index, HandleRef texture, uint zslice)
static internal void vtkFrameBufferObject_SetContext_24 (HandleRef pThis, HandleRef context)
static internal void vtkFrameBufferObject_SetDepthBuffer_25 (HandleRef pThis, HandleRef depthTexture)
static internal void vtkFrameBufferObject_SetDepthBufferNeeded_26 (HandleRef pThis, byte _arg)
static internal void vtkFrameBufferObject_SetNumberOfRenderTargets_27 (HandleRef pThis, uint arg0)
static internal byte vtkFrameBufferObject_Start_28 (HandleRef pThis, int width, int height, byte shaderSupportsTextureInt)
static internal byte vtkFrameBufferObject_StartNonOrtho_29 (HandleRef pThis, int width, int height, byte shaderSupportsTextureInt)
static internal void vtkFrameBufferObject_UnBind_30 (HandleRef pThis)

Static Private Member Functions

static vtkFrameBufferObject ()
 Automatically generated type registration mechanics.

Detailed Description

vtkFrameBufferObject - internal class which encapsulates OpenGL frame buffer object. Not to be used directly.

Description Encapsulates an OpenGL Frame Buffer Object. For use by vtkOpenGLFBORenderWindow, not to be used directly. Caveats DON'T PLAY WITH IT YET.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Save the current framebuffer and make the frame buffer active. Multiple calls to Bind has no effect.

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

All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.

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:

If true, the frame buffer object will be initialized with a depth buffer. Initial value is true.

virtual int [] Kitware.VTK.vtkFrameBufferObject.GetLastSize ( ) [virtual]

Dimensions in pixels of the framebuffer.

virtual void Kitware.VTK.vtkFrameBufferObject.GetLastSize ( ref int  _arg1,
ref int  _arg2 
) [virtual]

Dimensions in pixels of the framebuffer.

virtual void Kitware.VTK.vtkFrameBufferObject.GetLastSize ( IntPtr  _arg) [virtual]

Dimensions in pixels of the framebuffer.

Returns the maximum number of targets that can be rendered to at one time. This limits the active targets set by SetActiveTargets(). The return value is valid only if GetContext is non-null.

Returns the maximum number of render targets available. This limits the available attachement points for SetColorAttachment(). The return value is valid only if GetContext is non-null.

Set/Get the number of render targets to render into at once.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Returns if the context supports the required extensions.

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

All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.

All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.

Set the texture to use as depth buffer.

void Kitware.VTK.vtkFrameBufferObject.RenderQuad ( int  minX,
int  maxX,
int  minY,
int  maxY 
)

Renders a quad at the given location with pixel coordinates. This method is provided as a convenience, since we often render quads in a FBO.

Precondition:
positive_minX: minX>=0
increasing_x: minX<=maxX
valid_maxX: maxX<LastSize[0]
positive_minY: minY>=0
increasing_y: minY<=maxY
valid_maxY: maxY<LastSize[1]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

Choose the buffer to render into.

void Kitware.VTK.vtkFrameBufferObject.SetActiveBuffers ( int  numbuffers,
IntPtr  indices 
)

Choose the buffer to render into. This is available only if the GL_ARB_draw_buffers extension is supported by the card.

void Kitware.VTK.vtkFrameBufferObject.SetColorBuffer ( uint  index,
vtkTextureObject  texture,
uint  zslice 
)

All user specified texture objects must match the FBO dimensions and must have been created by the time Start() gets called. If texture is a 3D texture, zslice identifies the zslice that will be attached to the color buffer. .SECTION Caveat Currently, 1D textures are not supported.

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.

Set the texture to use as depth buffer.

virtual void Kitware.VTK.vtkFrameBufferObject.SetDepthBufferNeeded ( bool  _arg) [virtual]

If true, the frame buffer object will be initialized with a depth buffer. Initial value is true.

Set/Get the number of render targets to render into at once.

bool Kitware.VTK.vtkFrameBufferObject.Start ( int  width,
int  height,
bool  shaderSupportsTextureInt 
)

User must take care that width/height match the dimensions of the user defined texture attachments. This method makes the "active buffers" the buffers that will get drawn into by subsequent drawing calls. Note that this does not clear the render buffers i.e. no glClear() calls are made by either of these methods. It's up to the caller to clear the buffers if needed.

bool Kitware.VTK.vtkFrameBufferObject.StartNonOrtho ( int  width,
int  height,
bool  shaderSupportsTextureInt 
)

User must take care that width/height match the dimensions of the user defined texture attachments. This method makes the "active buffers" the buffers that will get drawn into by subsequent drawing calls. Note that this does not clear the render buffers i.e. no glClear() calls are made by either of these methods. It's up to the caller to clear the buffers if needed.

Restore the framebuffer saved with the call to Bind(). Multiple calls to UnBind has no effect.

static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_Bind_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetColorBuffer_02 ( HandleRef  pThis,
uint  index,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetContext_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetDepthBufferNeeded_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetLastSize_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetLastSize_06 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetLastSize_07 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal uint Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_GetNumberOfRenderTargets_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_IsSupported_12 ( HandleRef  renWin) [private]
static internal int Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_RemoveAllColorBuffers_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_RemoveColorBuffer_17 ( HandleRef  pThis,
uint  index 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_RemoveDepthBuffer_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_RenderQuad_19 ( HandleRef  pThis,
int  minX,
int  maxX,
int  minY,
int  maxY 
) [private]
static internal IntPtr Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetActiveBuffer_21 ( HandleRef  pThis,
uint  index 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetActiveBuffers_22 ( HandleRef  pThis,
int  numbuffers,
IntPtr  indices 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetColorBuffer_23 ( HandleRef  pThis,
uint  index,
HandleRef  texture,
uint  zslice 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetContext_24 ( HandleRef  pThis,
HandleRef  context 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetDepthBuffer_25 ( HandleRef  pThis,
HandleRef  depthTexture 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetDepthBufferNeeded_26 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_SetNumberOfRenderTargets_27 ( HandleRef  pThis,
uint  arg0 
) [private]
static internal byte Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_Start_28 ( HandleRef  pThis,
int  width,
int  height,
byte  shaderSupportsTextureInt 
) [private]
static internal byte Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_StartNonOrtho_29 ( HandleRef  pThis,
int  width,
int  height,
byte  shaderSupportsTextureInt 
) [private]
static internal void Kitware.VTK.vtkFrameBufferObject.vtkFrameBufferObject_UnBind_30 ( HandleRef  pThis) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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