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

#include <vtkFrameBufferObject.h>

Inheritance diagram for vtkFrameBufferObject:

Collaboration diagram for vtkFrameBufferObject:

Public Types
typedef vtkObject	Superclass
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkFrameBufferObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	RenderQuad (int minX, int maxX, int minY, int maxY)
void	Bind ()
void	UnBind ()
void	SetActiveBuffers (int numbuffers, unsigned int indices[])
vtkTextureObject *	GetColorBuffer (unsigned int index)
void	RemoveColorBuffer (unsigned int index)
void	RemoveAllColorBuffers ()
unsigned int	GetMaximumNumberOfActiveTargets ()
unsigned int	GetMaximumNumberOfRenderTargets ()
int	CheckFrameBufferStatus (unsigned int mode)
virtual int	IsA (const char *type)
vtkFrameBufferObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Bind ()
void	UnBind ()
void	SetActiveBuffers (int numbuffers, unsigned int indices[])
vtkTextureObject *	GetColorBuffer (unsigned int index)
void	RemoveColorBuffer (unsigned int index)
void	RemoveAllColorBuffers ()
unsigned int	GetMaximumNumberOfActiveTargets ()
unsigned int	GetMaximumNumberOfRenderTargets ()
int	CheckFrameBufferStatus (unsigned int mode)

void	SetContext (vtkRenderWindow *context)
vtkRenderWindow *	GetContext ()

bool	Start (int width, int height, bool shaderSupportsTextureInt)
bool	StartNonOrtho (int width, int height, bool shaderSupportsTextureInt)

void	SetActiveBuffer (unsigned int index)

void	SetColorBuffer (unsigned int index, vtkTextureObject *texture, unsigned int zslice=0)

void	SetDepthBuffer (vtkTextureObject *depthTexture)
void	RemoveDepthBuffer ()

virtual void	SetDepthBufferNeeded (bool)
virtual bool	GetDepthBufferNeeded ()

void	SetNumberOfRenderTargets (unsigned int)
virtual unsigned int	GetNumberOfRenderTargets ()

virtual int *	GetLastSize ()
virtual void	GetLastSize (int &, int &)
virtual void	GetLastSize (int[2])

void	SetContext (vtkOpenGLRenderWindow *context)
vtkOpenGLRenderWindow *	GetContext ()

bool	Start (int width, int height, bool shaderSupportsTextureInt)
bool	StartNonOrtho (int width, int height, bool shaderSupportsTextureInt)

void	RenderQuad (int minX, int maxX, int minY, int maxY, vtkShaderProgram program, vtkgl::VertexArrayObject vao)

void	SetActiveBuffer (unsigned int index)

void	SetColorBuffer (unsigned int index, vtkTextureObject *texture, unsigned int zslice=0)

void	SetDepthBuffer (vtkTextureObject *depthTexture)
void	RemoveDepthBuffer ()

virtual void	SetDepthBufferNeeded (bool)
virtual bool	GetDepthBufferNeeded ()

void	SetNumberOfRenderTargets (unsigned int)
virtual unsigned int	GetNumberOfRenderTargets ()

virtual int *	GetLastSize ()
virtual void	GetLastSize (int &, int &)
virtual void	GetLastSize (int[2])
Static Public Member Functions
static vtkFrameBufferObject *	New ()
static int	IsTypeOf (const char *type)
static vtkFrameBufferObject *	SafeDownCast (vtkObjectBase *o)
static bool	IsSupported (vtkRenderWindow *renWin)
static vtkFrameBufferObject *	New ()
static int	IsTypeOf (const char *type)
static vtkFrameBufferObject *	SafeDownCast (vtkObjectBase *o)
static bool	IsSupported (vtkOpenGLRenderWindow *renWin)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
void	CreateFBO ()
void	DestroyFBO ()
void	CreateDepthBuffer (int width, int height, unsigned int mode)
void	CreateColorBuffers (int width, int height, unsigned int mode, bool shaderSupportsTextureInt)
void	DestroyDepthBuffer ()
void	DestroyColorBuffers ()
void	ActivateBuffers ()
void	DisplayFrameBufferAttachments ()
void	DisplayFrameBufferAttachment (unsigned int uattachment)
void	DisplayDrawBuffers ()
void	DisplayReadBuffer ()
void	DisplayBuffer (int value)
	vtkFrameBufferObject ()
	~vtkFrameBufferObject ()
virtual vtkObjectBase *	NewInstanceInternal () const
void	CreateFBO ()
void	DestroyFBO ()
void	CreateDepthBuffer (int width, int height, unsigned int mode)
void	CreateColorBuffers (int width, int height, unsigned int mode, bool shaderSupportsTextureInt)
void	DestroyDepthBuffer ()
void	DestroyColorBuffers ()
void	ActivateBuffers ()
void	DisplayFrameBufferAttachments ()
void	DisplayFrameBufferAttachment (unsigned int uattachment)
void	DisplayDrawBuffers ()
void	DisplayReadBuffer ()
void	DisplayBuffer (int value)
	vtkFrameBufferObject ()
	~vtkFrameBufferObject ()
Static Protected Member Functions

static bool	LoadRequiredExtensions (vtkRenderWindow *renWin)

static bool	LoadRequiredExtensions (vtkOpenGLRenderWindow *renWin)
Protected Attributes
vtkWeakPointer< vtkRenderWindow >	Context
bool	DepthBufferNeeded
bool	ColorBuffersDirty
unsigned int	FBOIndex
int	PreviousFBOIndex
unsigned int	DepthBuffer
unsigned int	NumberOfRenderTargets
int	LastSize [2]
std::vector< unsigned int >	UserZSlices
std::vector< vtkSmartPointer < vtkTextureObject > >	UserColorBuffers
std::vector< vtkSmartPointer < vtkTextureObject > >	ColorBuffers
std::vector< unsigned int >	ActiveBuffers
vtkSmartPointer< vtkTextureObject >	UserDepthBuffer
bool	DepthBufferDirty
vtkWeakPointer < vtkOpenGLRenderWindow >	Context

Detailed Description

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

Encapsulates an OpenGL Frame Buffer Object. For use by vtkOpenGLFBORenderWindow, not to be used directly. Use vtkFrameBufferObject2 instead.

Warning:: DON'T PLAY WITH IT YET.

See also:: vtkFrameBufferObject2, vtkRenderbufferObject

Definition at line 46 of file vtkFrameBufferObject.h.

Member Typedef Documentation

typedef vtkObject vtkFrameBufferObject::Superclass

Reimplemented from vtkObject.

Definition at line 50 of file vtkFrameBufferObject.h.

typedef vtkObject vtkFrameBufferObject::Superclass

Reimplemented from vtkObject.

Definition at line 53 of file vtkFrameBufferObject.h.

Constructor & Destructor Documentation

vtkFrameBufferObject::vtkFrameBufferObject ( ) [protected]

vtkFrameBufferObject::~vtkFrameBufferObject ( ) [protected]

vtkFrameBufferObject::vtkFrameBufferObject ( ) [protected]

vtkFrameBufferObject::~vtkFrameBufferObject ( ) [protected]

Member Function Documentation

static vtkFrameBufferObject* vtkFrameBufferObject::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkFrameBufferObject::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkFrameBufferObject::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 vtkFrameBufferObject* vtkFrameBufferObject::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkFrameBufferObject::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkFrameBufferObject* vtkFrameBufferObject::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkFrameBufferObject::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 vtkFrameBufferObject::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* vtkFrameBufferObject::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 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 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.

void 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]

void vtkFrameBufferObject::Bind ( )

Make the draw frame buffer active (uses FRAMEBUFFER).

void vtkFrameBufferObject::UnBind ( )

Restore the previous draw framebuffer if saved, else bind the default buffer.

void vtkFrameBufferObject::SetActiveBuffer ( unsigned int index ) [inline]

Choose the buffers to render into.

Definition at line 89 of file vtkFrameBufferObject.h.

void vtkFrameBufferObject::SetActiveBuffers	(	int	numbuffers,
		unsigned int	indices[]
	)

User provided color buffers are attached by index to color buffers. This command lets you select which attachments are written to. See set color buffer. This call overwrites what the previous list of active buffers.

void vtkFrameBufferObject::SetColorBuffer	(	unsigned int	index,
		vtkTextureObject *	texture,
		unsigned int	zslice = `0`
	)

Insert a color buffer into the list of available color buffers. 0 to NumberOfRenderTargets of these are attached to color attachments by index. See SetActiveBuffers to select them for writing. 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.

vtkTextureObject* vtkFrameBufferObject::GetColorBuffer ( unsigned int index )

void vtkFrameBufferObject::RemoveColorBuffer ( unsigned int index )

void vtkFrameBufferObject::RemoveAllColorBuffers ( )

void vtkFrameBufferObject::SetDepthBuffer ( vtkTextureObject * depthTexture )

Set the texture to use as depth buffer.

void vtkFrameBufferObject::RemoveDepthBuffer ( )

Set the texture to use as depth buffer.

virtual void vtkFrameBufferObject::SetDepthBufferNeeded ( bool ) [virtual]

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

virtual bool vtkFrameBufferObject::GetDepthBufferNeeded ( ) [virtual]

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

void vtkFrameBufferObject::SetNumberOfRenderTargets ( unsigned int )

Set/Get the number of render targets to render into at once. Textures (user supplied or generated internally) are attached to color attachment 0 to NumberOfRenderTargets. You can use SetActiveBuffer to specify which of these are actually written to. If zero then all of the user provided color buffers are used.

virtual unsigned int vtkFrameBufferObject::GetNumberOfRenderTargets ( ) [virtual]

Set/Get the number of render targets to render into at once. Textures (user supplied or generated internally) are attached to color attachment 0 to NumberOfRenderTargets. You can use SetActiveBuffer to specify which of these are actually written to. If zero then all of the user provided color buffers are used.

unsigned int vtkFrameBufferObject::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.

unsigned int vtkFrameBufferObject::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 int* vtkFrameBufferObject::GetLastSize ( ) [virtual]

Dimensions in pixels of the framebuffer.

virtual void vtkFrameBufferObject::GetLastSize	(	int &	,
		int &
	)		`[virtual]`

Dimensions in pixels of the framebuffer.

virtual void vtkFrameBufferObject::GetLastSize ( int [2] ) [virtual]

Dimensions in pixels of the framebuffer.

static bool vtkFrameBufferObject::IsSupported ( vtkRenderWindow * renWin ) [static]

Returns if the context supports the required extensions. Extension will be loaded when the conetxt is set.

int vtkFrameBufferObject::CheckFrameBufferStatus ( unsigned int mode )

Validate the current FBO configuration (attachments, formats, etc) prints detected errors to vtkErrorMacro.

static bool vtkFrameBufferObject::LoadRequiredExtensions ( vtkRenderWindow * renWin ) [static, protected]

Load all necessary extensions.

void vtkFrameBufferObject::CreateFBO ( ) [protected]

void vtkFrameBufferObject::DestroyFBO ( ) [protected]

void vtkFrameBufferObject::CreateDepthBuffer	(	int	width,
		int	height,
		unsigned int	mode
	)		`[protected]`

void vtkFrameBufferObject::CreateColorBuffers	(	int	width,
		int	height,
		unsigned int	mode,
		bool	shaderSupportsTextureInt
	)		`[protected]`

void vtkFrameBufferObject::DestroyDepthBuffer ( ) [protected]

void vtkFrameBufferObject::DestroyColorBuffers ( ) [protected]

void vtkFrameBufferObject::ActivateBuffers ( ) [protected]

void vtkFrameBufferObject::DisplayFrameBufferAttachments ( ) [protected]

Display all the attachments of the current framebuffer object.

void vtkFrameBufferObject::DisplayFrameBufferAttachment ( unsigned int uattachment ) [protected]

Display a given attachment for the current framebuffer object.

void vtkFrameBufferObject::DisplayDrawBuffers ( ) [protected]

Display the draw buffers.

void vtkFrameBufferObject::DisplayReadBuffer ( ) [protected]

Display the read buffer.

void vtkFrameBufferObject::DisplayBuffer ( int value ) [protected]

Display any buffer (convert value into string).

static vtkFrameBufferObject* vtkFrameBufferObject::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkFrameBufferObject::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkFrameBufferObject::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 vtkFrameBufferObject* vtkFrameBufferObject::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkFrameBufferObject::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkFrameBufferObject* vtkFrameBufferObject::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkFrameBufferObject::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 vtkFrameBufferObject::SetContext ( vtkOpenGLRenderWindow * 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.

vtkOpenGLRenderWindow* vtkFrameBufferObject::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 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 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.

void vtkFrameBufferObject::RenderQuad	(	int	minX,
		int	maxX,
		int	minY,
		int	maxY,
		vtkShaderProgram *	program,
		vtkgl::VertexArrayObject *	vao
	)

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]

void vtkFrameBufferObject::Bind ( )

Make the draw frame buffer active (uses FRAMEBUFFER).

void vtkFrameBufferObject::UnBind ( )

Restore the previous draw framebuffer if saved, else bind the default buffer.

void vtkFrameBufferObject::SetActiveBuffer ( unsigned int index ) [inline]

Choose the buffers to render into.

Definition at line 95 of file vtkFrameBufferObject.h.

void vtkFrameBufferObject::SetActiveBuffers	(	int	numbuffers,
		unsigned int	indices[]
	)

User provided color buffers are attached by index to color buffers. This command lets you select which attachments are written to. See set color buffer. This call overwrites what the previous list of active buffers.

void vtkFrameBufferObject::SetColorBuffer	(	unsigned int	index,
		vtkTextureObject *	texture,
		unsigned int	zslice = `0`
	)