OpenGl_FrameBuffer Class Reference

Class implements FrameBuffer Object (FBO) resource intended for off-screen rendering. More...

#include <OpenGl_FrameBuffer.hxx>

Inheritance diagram for OpenGl_FrameBuffer:

Public Member Functions
	OpenGl_FrameBuffer (const TCollection_AsciiString &theResourceId=TCollection_AsciiString())
	Empty constructor.
virtual	~OpenGl_FrameBuffer ()
	Destructor.
virtual void	Release (OpenGl_Context *theGlCtx) override
	Destroy object - will release GPU memory if any.
Standard_Integer	NbSamples () const
	Number of multisampling samples.
Standard_Integer	NbColorBuffers () const
	Number of color buffers.
bool	HasColor () const
	Return true if FBO has been created with color attachment.
bool	HasDepth () const
	Return true if FBO has been created with depth attachment.
Graphic3d_Vec2i	GetSize () const
	Return textures width x height.
Standard_Integer	GetSizeX () const
	Textures width.
Standard_Integer	GetSizeY () const
	Textures height.
Graphic3d_Vec2i	GetVPSize () const
	Return viewport width x height.
Standard_Integer	GetVPSizeX () const
	Viewport width.
Standard_Integer	GetVPSizeY () const
	Viewport height.
Graphic3d_Vec2i	GetInitVPSize () const
	Return viewport width x height.
Standard_Integer	GetInitVPSizeX () const
	Viewport width.
Standard_Integer	GetInitVPSizeY () const
	Viewport height.
Standard_Boolean	IsValid () const
	Returns true if current object was initialized.
Standard_Boolean	Init (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const OpenGl_ColorFormats &theColorFormats, const Handle< OpenGl_Texture > &theDepthStencilTexture, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into single/multiple color buffer and depth textures.
Standard_Boolean	Init (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into textures.
Standard_Boolean	Init (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into single/multiple color buffer and depth textures.
Standard_Boolean	InitLazy (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theViewportSize, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	(Re-)initialize FBO with specified dimensions.
Standard_Boolean	InitLazy (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theViewportSize, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	(Re-)initialize FBO with specified dimensions.
Standard_Boolean	InitLazy (const Handle< OpenGl_Context > &theGlCtx, const OpenGl_FrameBuffer &theFbo, const Standard_Boolean theToKeepMsaa=true)
	(Re-)initialize FBO with properties taken from another FBO.
Standard_Boolean	InitRenderBuffer (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).
Standard_Boolean	InitWithRB (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const unsigned int theColorRBufferFromWindow)
	(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).
Standard_Boolean	InitWrapper (const Handle< OpenGl_Context > &theGlCtx)
	Initialize class from currently bound FBO. Retrieved OpenGL objects will not be destroyed on Release.
Standard_Boolean	InitWrapper (const Handle< OpenGl_Context > &theGlContext, const NCollection_Sequence< Handle< OpenGl_Texture > > &theColorTextures, const Handle< OpenGl_Texture > &theDepthTexture=Handle< OpenGl_Texture >())
	Wrap existing color textures.
void	SetupViewport (const Handle< OpenGl_Context > &theGlCtx)
	Setup viewport to render into FBO.
void	ChangeViewport (const Standard_Integer theVPSizeX, const Standard_Integer theVPSizeY)
	Override viewport settings.
virtual void	BindBuffer (const Handle< OpenGl_Context > &theGlCtx)
	Bind frame buffer for drawing and reading (to render into the texture).
virtual void	BindDrawBuffer (const Handle< OpenGl_Context > &theGlCtx)
	Bind frame buffer for drawing GL_DRAW_FRAMEBUFFER (to render into the texture).
virtual void	BindReadBuffer (const Handle< OpenGl_Context > &theGlCtx)
	Bind frame buffer for reading GL_READ_FRAMEBUFFER.
virtual void	UnbindBuffer (const Handle< OpenGl_Context > &theGlCtx)
	Unbind frame buffer.
const Handle< OpenGl_Texture > &	ColorTexture (const Standard_Integer theColorBufferIndex=0) const
	Returns the color texture for the given color buffer index.
const Handle< OpenGl_Texture > &	DepthStencilTexture () const
	Returns the depth-stencil texture.
bool	IsColorRenderBuffer () const
	Returns TRUE if color Render Buffer is defined.
unsigned int	ColorRenderBuffer () const
	Returns the color Render Buffer.
bool	IsDepthStencilRenderBuffer () const
	Returns TRUE if depth Render Buffer is defined.
unsigned int	DepthStencilRenderBuffer () const
	Returns the depth Render Buffer.
virtual Standard_Size	EstimatedDataSize () const override
	Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
Standard_Boolean	initRenderBuffer (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_Vec2i &theSize, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples, const unsigned int theColorRBufferFromWindow)
	(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).
bool	Init (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const OpenGl_ColorFormats &theColorFormats, const Handle< OpenGl_Texture > &theDepthStencilTexture, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into single/multiple color buffer and depth textures.
bool	Init (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into textures.
bool	Init (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	Initialize FBO for rendering into single/multiple color buffer and depth textures.
bool	InitLazy (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theViewportSizeX, const Standard_Integer theViewportSizeY, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	(Re-)initialize FBO with specified dimensions.
bool	InitLazy (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theViewportSizeX, const Standard_Integer theViewportSizeY, const OpenGl_ColorFormats &theColorFormats, const Standard_Integer theDepthFormat, const Standard_Integer theNbSamples=0)
	(Re-)initialize FBO with specified dimensions.
bool	InitWithRB (const Handle< OpenGl_Context > &theGlCtx, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const Standard_Integer theColorFormat, const Standard_Integer theDepthFormat, const unsigned int theColorRBufferFromWindow=0)
	(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).
Public Member Functions inherited from OpenGl_NamedResource
	OpenGl_NamedResource (const TCollection_AsciiString &theId)
	Empty constructor.
const TCollection_AsciiString &	ResourceId () const
	Return resource name.
Public Member Functions inherited from OpenGl_Resource
	OpenGl_Resource ()
	Empty constructor.
virtual	~OpenGl_Resource ()
	Destructor. Inheritors should call Clean (NULL) within it.
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Standard_Boolean	BufferDump (const Handle< OpenGl_Context > &theGlCtx, const Handle< OpenGl_FrameBuffer > &theFbo, Image_PixMap &theImage, Graphic3d_BufferType theBufferType)
	Dump content into image.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Static Public Attributes
static const unsigned int	NO_FRAMEBUFFER = 0
	Helpful constants.
static const unsigned int	NO_RENDERBUFFER = 0

Protected Types
typedef NCollection_Vector< Handle< OpenGl_Texture > >	OpenGl_TextureArray

Protected Member Functions
Standard_Boolean	isValidFrameBuffer () const

Protected Attributes
Standard_Integer	myInitVPSizeX
	viewport width specified during initialization (kept even on failure)
Standard_Integer	myInitVPSizeY
	viewport height specified during initialization (kept even on failure)
Standard_Integer	myVPSizeX
	viewport width (should be <= texture width)
Standard_Integer	myVPSizeY
	viewport height (should be <= texture height)
Standard_Integer	myNbSamples
	number of MSAA samples
OpenGl_ColorFormats	myColorFormats
	sized format for color texture, GL_RGBA8 by default
Standard_Integer	myDepthFormat
	sized format for depth-stencil texture, GL_DEPTH24_STENCIL8 by default
unsigned int	myGlFBufferId
	FBO object ID.
unsigned int	myGlColorRBufferId
	color Render Buffer object (alternative to myColorTexture)
unsigned int	myGlDepthRBufferId
	depth-stencil Render Buffer object (alternative to myDepthStencilTexture)
bool	myIsOwnBuffer
	flag indicating that FBO should be deallocated by this class
bool	myIsOwnColor
	flag indicating that color textures should be deallocated by this class
bool	myIsOwnDepth
	flag indicating that depth texture should be deallocated by this class
OpenGl_TextureArray	myColorTextures
	color texture objects
Handle< OpenGl_Texture >	myDepthStencilTexture
	depth-stencil texture object
Protected Attributes inherited from OpenGl_NamedResource
TCollection_AsciiString	myResourceId
	resource name

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Class implements FrameBuffer Object (FBO) resource intended for off-screen rendering.

Member Typedef Documentation

OpenGl_TextureArray

typedef NCollection_Vector<Handle< OpenGl_Texture > > OpenGl_FrameBuffer::OpenGl_TextureArray

protected

Constructor & Destructor Documentation

OpenGl_FrameBuffer()

OpenGl_FrameBuffer::OpenGl_FrameBuffer

(

const TCollection_AsciiString &

theResourceId = TCollection_AsciiString()

)

Empty constructor.

~OpenGl_FrameBuffer()

virtual OpenGl_FrameBuffer::~OpenGl_FrameBuffer ( )

virtual

Destructor.

Member Function Documentation

BindBuffer()

virtual void OpenGl_FrameBuffer::BindBuffer ( const Handle< OpenGl_Context > &  theGlCtx )

virtual

Bind frame buffer for drawing and reading (to render into the texture).

Reimplemented in D3DHost_FrameBuffer.

BindDrawBuffer()

virtual void OpenGl_FrameBuffer::BindDrawBuffer ( const Handle< OpenGl_Context > &  theGlCtx )

virtual

Bind frame buffer for drawing GL_DRAW_FRAMEBUFFER (to render into the texture).

BindReadBuffer()

virtual void OpenGl_FrameBuffer::BindReadBuffer ( const Handle< OpenGl_Context > &  theGlCtx )

virtual

Bind frame buffer for reading GL_READ_FRAMEBUFFER.

BufferDump()

static Standard_Boolean OpenGl_FrameBuffer::BufferDump ( const Handle< OpenGl_Context > &  theGlCtx, const Handle< OpenGl_FrameBuffer > &  theFbo, Image_PixMap &  theImage, Graphic3d_BufferType  theBufferType  )

static

Dump content into image.

Parameters

theGlCtx	bound OpenGL context
theFbo	FBO to dump (or window buffer, if NULL)
theImage	target image
theBufferType	buffer type (attachment) to dump

Returns

TRUE on success

ChangeViewport()

void OpenGl_FrameBuffer::ChangeViewport	(	const Standard_Integer	theVPSizeX,
		const Standard_Integer	theVPSizeY
	)

Override viewport settings.

ColorRenderBuffer()

unsigned int OpenGl_FrameBuffer::ColorRenderBuffer ( ) const

inline

Returns the color Render Buffer.

ColorTexture()

const Handle< OpenGl_Texture > & OpenGl_FrameBuffer::ColorTexture ( const Standard_Integer  theColorBufferIndex = 0 ) const

inline

Returns the color texture for the given color buffer index.

DepthStencilRenderBuffer()

unsigned int OpenGl_FrameBuffer::DepthStencilRenderBuffer ( ) const

inline

Returns the depth Render Buffer.

DepthStencilTexture()

const Handle< OpenGl_Texture > & OpenGl_FrameBuffer::DepthStencilTexture ( ) const

inline

Returns the depth-stencil texture.

EstimatedDataSize()

virtual Standard_Size OpenGl_FrameBuffer::EstimatedDataSize ( ) const

overridevirtual

Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.

Implements OpenGl_Resource.

GetInitVPSize()

Graphic3d_Vec2i OpenGl_FrameBuffer::GetInitVPSize ( ) const

inline

Return viewport width x height.

GetInitVPSizeX()

Standard_Integer OpenGl_FrameBuffer::GetInitVPSizeX ( ) const

inline

Viewport width.

GetInitVPSizeY()

Standard_Integer OpenGl_FrameBuffer::GetInitVPSizeY ( ) const

inline

Viewport height.

GetSize()

Graphic3d_Vec2i OpenGl_FrameBuffer::GetSize ( ) const

inline

Return textures width x height.

GetSizeX()

Standard_Integer OpenGl_FrameBuffer::GetSizeX

(

)

const

Textures width.

GetSizeY()

Standard_Integer OpenGl_FrameBuffer::GetSizeY

(

)

const

Textures height.

GetVPSize()

Graphic3d_Vec2i OpenGl_FrameBuffer::GetVPSize ( ) const

inline

Return viewport width x height.

GetVPSizeX()

Standard_Integer OpenGl_FrameBuffer::GetVPSizeX ( ) const

inline

Viewport width.

GetVPSizeY()

Standard_Integer OpenGl_FrameBuffer::GetVPSizeY ( ) const

inline

Viewport height.

HasColor()

bool OpenGl_FrameBuffer::HasColor ( ) const

inline

Return true if FBO has been created with color attachment.

HasDepth()

bool OpenGl_FrameBuffer::HasDepth ( ) const

inline

Return true if FBO has been created with depth attachment.

Init() [1/6]

Standard_Boolean OpenGl_FrameBuffer::Init	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theSize,
		const OpenGl_ColorFormats &	theColorFormats,
		const Handle< OpenGl_Texture > &	theDepthStencilTexture,
		const Standard_Integer	theNbSamples = 0
	)

Initialize FBO for rendering into single/multiple color buffer and depth textures.

Parameters

theGlCtx	currently bound OpenGL context
theSize	texture width x height
theColorFormats	list of color texture sized format (0 means no color attachment), e.g. GL_RGBA8
theDepthStencilTexture	depth-stencil texture
theNbSamples	MSAA number of samples (0 means normal texture)

Returns

true on success

Init() [2/6]

Standard_Boolean OpenGl_FrameBuffer::Init	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theSize,
		const OpenGl_ColorFormats &	theColorFormats,
		const Standard_Integer	theDepthFormat,
		const Standard_Integer	theNbSamples = 0
	)

Initialize FBO for rendering into single/multiple color buffer and depth textures.

Parameters

theGlCtx	currently bound OpenGL context
theSize	texture width x height
theColorFormats	list of color texture sized format (0 means no color attachment), e.g. GL_RGBA8
theDepthFormat	depth-stencil texture sized format (0 means no depth attachment), e.g. GL_DEPTH24_STENCIL8
theNbSamples	MSAA number of samples (0 means normal texture)

Returns

true on success

Init() [3/6]

Standard_Boolean OpenGl_FrameBuffer::Init	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theSize,
		const Standard_Integer	theColorFormat,
		const Standard_Integer	theDepthFormat,
		const Standard_Integer	theNbSamples = 0
	)

Initialize FBO for rendering into textures.

Parameters

theGlCtx	currently bound OpenGL context
theSize	texture width x height
theColorFormat	color texture sized format (0 means no color attachment), e.g. GL_RGBA8
theDepthFormat	depth-stencil texture sized format (0 means no depth attachment), e.g. GL_DEPTH24_STENCIL8
theNbSamples	MSAA number of samples (0 means normal texture)

Returns

true on success

Init() [4/6]

bool OpenGl_FrameBuffer::Init ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theSizeX, const Standard_Integer  theSizeY, const OpenGl_ColorFormats &  theColorFormats, const Handle< OpenGl_Texture > &  theDepthStencilTexture, const Standard_Integer  theNbSamples = 0  )

inline

Initialize FBO for rendering into single/multiple color buffer and depth textures.

Deprecated:

("Obsolete method, use Init() taking Graphic3d_Vec2i")

Init() [5/6]

bool OpenGl_FrameBuffer::Init ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theSizeX, const Standard_Integer  theSizeY, const OpenGl_ColorFormats &  theColorFormats, const Standard_Integer  theDepthFormat, const Standard_Integer  theNbSamples = 0  )

inline

Initialize FBO for rendering into single/multiple color buffer and depth textures.

Deprecated:

("Obsolete method, use Init() taking Graphic3d_Vec2i")

Init() [6/6]

bool OpenGl_FrameBuffer::Init ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theSizeX, const Standard_Integer  theSizeY, const Standard_Integer  theColorFormat, const Standard_Integer  theDepthFormat, const Standard_Integer  theNbSamples = 0  )

inline

Initialize FBO for rendering into textures.

Deprecated:

("Obsolete method, use Init() taking Graphic3d_Vec2i")

InitLazy() [1/5]

Standard_Boolean OpenGl_FrameBuffer::InitLazy	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theViewportSize,
		const OpenGl_ColorFormats &	theColorFormats,
		const Standard_Integer	theDepthFormat,
		const Standard_Integer	theNbSamples = 0
	)

(Re-)initialize FBO with specified dimensions.

InitLazy() [2/5]

Standard_Boolean OpenGl_FrameBuffer::InitLazy	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theViewportSize,
		const Standard_Integer	theColorFormat,
		const Standard_Integer	theDepthFormat,
		const Standard_Integer	theNbSamples = 0
	)

(Re-)initialize FBO with specified dimensions.

InitLazy() [3/5]

Standard_Boolean OpenGl_FrameBuffer::InitLazy ( const Handle< OpenGl_Context > &  theGlCtx, const OpenGl_FrameBuffer &  theFbo, const Standard_Boolean  theToKeepMsaa = true  )

inline

(Re-)initialize FBO with properties taken from another FBO.

InitLazy() [4/5]

bool OpenGl_FrameBuffer::InitLazy ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theViewportSizeX, const Standard_Integer  theViewportSizeY, const OpenGl_ColorFormats &  theColorFormats, const Standard_Integer  theDepthFormat, const Standard_Integer  theNbSamples = 0  )

inline

(Re-)initialize FBO with specified dimensions.

Deprecated:

("Obsolete method, use InitLazy() taking Graphic3d_Vec2i")

InitLazy() [5/5]

bool OpenGl_FrameBuffer::InitLazy ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theViewportSizeX, const Standard_Integer  theViewportSizeY, const Standard_Integer  theColorFormat, const Standard_Integer  theDepthFormat, const Standard_Integer  theNbSamples = 0  )

inline

(Re-)initialize FBO with specified dimensions.

Deprecated:

("Obsolete method, use InitLazy() taking Graphic3d_Vec2i")

initRenderBuffer()

Standard_Boolean OpenGl_FrameBuffer::initRenderBuffer	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theSize,
		const OpenGl_ColorFormats &	theColorFormats,
		const Standard_Integer	theDepthFormat,
		const Standard_Integer	theNbSamples,
		const unsigned int	theColorRBufferFromWindow
	)

(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).

Parameters

theGlCtx	currently bound OpenGL context
theSize	render buffer width x height
theColorFormats	list of color render buffer sized format, e.g. GL_RGBA8
theDepthFormat	depth-stencil render buffer sized format, e.g. GL_DEPTH24_STENCIL8
theNbSamples	MSAA number of samples (0 means normal render buffer)
theColorRBufferFromWindow	when specified - should be ID of already initialized RB object, which will be released within this class

InitRenderBuffer()

Standard_Boolean OpenGl_FrameBuffer::InitRenderBuffer ( const Handle< OpenGl_Context > &  theGlCtx, const Graphic3d_Vec2i &  theSize, const OpenGl_ColorFormats &  theColorFormats, const Standard_Integer  theDepthFormat, const Standard_Integer  theNbSamples = 0  )

inline

(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).

Parameters

theGlCtx	currently bound OpenGL context
theSize	render buffer width x height
theColorFormats	list of color render buffer sized format, e.g. GL_RGBA8; list should define only one element
theDepthFormat	depth-stencil render buffer sized format, e.g. GL_DEPTH24_STENCIL8
theNbSamples	MSAA number of samples (0 means normal render buffer)

InitWithRB() [1/2]

Standard_Boolean OpenGl_FrameBuffer::InitWithRB	(	const Handle< OpenGl_Context > &	theGlCtx,
		const Graphic3d_Vec2i &	theSize,
		const Standard_Integer	theColorFormat,
		const Standard_Integer	theDepthFormat,
		const unsigned int	theColorRBufferFromWindow
	)

(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).

Parameters

theGlCtx	currently bound OpenGL context
theSize	render buffer width x height
theColorFormat	color render buffer sized format, e.g. GL_RGBA8
theDepthFormat	depth-stencil render buffer sized format, e.g. GL_DEPTH24_STENCIL8
theColorRBufferFromWindow	should be ID of already initialized RB object, which will be released within this class

InitWithRB() [2/2]

bool OpenGl_FrameBuffer::InitWithRB ( const Handle< OpenGl_Context > &  theGlCtx, const Standard_Integer  theSizeX, const Standard_Integer  theSizeY, const Standard_Integer  theColorFormat, const Standard_Integer  theDepthFormat, const unsigned int  theColorRBufferFromWindow = 0  )

inline

(Re-)initialize FBO with specified dimensions. The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).

Deprecated:

("Obsolete method, use InitWithRB() taking Graphic3d_Vec2i")

InitWrapper() [1/2]

Standard_Boolean OpenGl_FrameBuffer::InitWrapper	(	const Handle< OpenGl_Context > &	theGlContext,
		const NCollection_Sequence< Handle< OpenGl_Texture > > &	theColorTextures,
		const Handle< OpenGl_Texture > &	theDepthTexture = Handle< OpenGl_Texture >()
	)

Wrap existing color textures.

InitWrapper() [2/2]

Standard_Boolean OpenGl_FrameBuffer::InitWrapper

(

const Handle< OpenGl_Context > &

theGlCtx

)

Initialize class from currently bound FBO. Retrieved OpenGL objects will not be destroyed on Release.

IsColorRenderBuffer()

bool OpenGl_FrameBuffer::IsColorRenderBuffer ( ) const

inline

Returns TRUE if color Render Buffer is defined.

IsDepthStencilRenderBuffer()

bool OpenGl_FrameBuffer::IsDepthStencilRenderBuffer ( ) const

inline

Returns TRUE if depth Render Buffer is defined.

IsValid()

Standard_Boolean OpenGl_FrameBuffer::IsValid ( ) const

inline

Returns true if current object was initialized.

isValidFrameBuffer()

Standard_Boolean OpenGl_FrameBuffer::isValidFrameBuffer ( ) const

inlineprotected

NbColorBuffers()

Standard_Integer OpenGl_FrameBuffer::NbColorBuffers ( ) const

inline

Number of color buffers.

NbSamples()

Standard_Integer OpenGl_FrameBuffer::NbSamples ( ) const

inline

Number of multisampling samples.

Release()

virtual void OpenGl_FrameBuffer::Release ( OpenGl_Context *  theGlCtx )

overridevirtual

Destroy object - will release GPU memory if any.

Implements OpenGl_Resource.

Reimplemented in D3DHost_FrameBuffer.

SetupViewport()

void OpenGl_FrameBuffer::SetupViewport

(

const Handle< OpenGl_Context > &

theGlCtx

)

Setup viewport to render into FBO.

UnbindBuffer()

virtual void OpenGl_FrameBuffer::UnbindBuffer ( const Handle< OpenGl_Context > &  theGlCtx )

virtual

Unbind frame buffer.

Field Documentation

myColorFormats

OpenGl_ColorFormats OpenGl_FrameBuffer::myColorFormats

protected

sized format for color texture, GL_RGBA8 by default

myColorTextures

OpenGl_TextureArray OpenGl_FrameBuffer::myColorTextures

protected

color texture objects

myDepthFormat

Standard_Integer OpenGl_FrameBuffer::myDepthFormat

protected

sized format for depth-stencil texture, GL_DEPTH24_STENCIL8 by default

myDepthStencilTexture

Handle< OpenGl_Texture > OpenGl_FrameBuffer::myDepthStencilTexture

protected

depth-stencil texture object

myGlColorRBufferId

unsigned int OpenGl_FrameBuffer::myGlColorRBufferId

protected

color Render Buffer object (alternative to myColorTexture)

myGlDepthRBufferId

unsigned int OpenGl_FrameBuffer::myGlDepthRBufferId

protected

depth-stencil Render Buffer object (alternative to myDepthStencilTexture)

myGlFBufferId

unsigned int OpenGl_FrameBuffer::myGlFBufferId

protected

FBO object ID.

myInitVPSizeX

Standard_Integer OpenGl_FrameBuffer::myInitVPSizeX

protected

viewport width specified during initialization (kept even on failure)

myInitVPSizeY

Standard_Integer OpenGl_FrameBuffer::myInitVPSizeY

protected

viewport height specified during initialization (kept even on failure)

myIsOwnBuffer

bool OpenGl_FrameBuffer::myIsOwnBuffer

protected

flag indicating that FBO should be deallocated by this class

myIsOwnColor

bool OpenGl_FrameBuffer::myIsOwnColor

protected

flag indicating that color textures should be deallocated by this class

myIsOwnDepth

bool OpenGl_FrameBuffer::myIsOwnDepth

protected

flag indicating that depth texture should be deallocated by this class

myNbSamples

Standard_Integer OpenGl_FrameBuffer::myNbSamples

protected

number of MSAA samples

myVPSizeX

Standard_Integer OpenGl_FrameBuffer::myVPSizeX

protected

viewport width (should be <= texture width)

myVPSizeY

Standard_Integer OpenGl_FrameBuffer::myVPSizeY

protected

viewport height (should be <= texture height)

NO_FRAMEBUFFER

const unsigned int OpenGl_FrameBuffer::NO_FRAMEBUFFER = 0

static

Helpful constants.

NO_RENDERBUFFER

const unsigned int OpenGl_FrameBuffer::NO_RENDERBUFFER = 0

static

---

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

• OpenGl_FrameBuffer.hxx