Ogre::GLFrameBufferObject Class Reference

Frame Buffer Object abstraction. More...

#include <OgreGLFrameBufferObject.h>

Public Member Functions
	GLFrameBufferObject (GLFBOManager *manager, uint fsaa)
	~GLFrameBufferObject ()
void	attachDepthBuffer (DepthBuffer *depthBuffer)
	This function acts very similar to. More...
void	bind ()
	Bind FrameBufferObject. More...
void	bindSurface (size_t attachment, const GLSurfaceDesc &target)
	Bind a surface to a certain attachment point. More...
void	detachDepthBuffer ()
PixelFormat	getFormat ()
GLsizei	getFSAA ()
GLuint	getGLFBOID () const
	Get the GL id for the FBO. More...
GLuint	getGLMultisampleFBOID () const
	Get the GL id for the multisample FBO. More...
uint32	getHeight ()
GLFBOManager *	getManager ()
const GLSurfaceDesc &	getSurface (size_t attachment)
uint32	getWidth ()
	Accessors. More...
void	swapBuffers ()
	Swap buffers - only useful when using multisample buffers. More...
void	unbindSurface (size_t attachment)
	Unbind attachment. More...

Private Member Functions
void	initialise ()
	Initialise object (find suitable depth and stencil format). More...

Private Attributes
GLSurfaceDesc	mColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]
GLSurfaceDesc	mDepth
GLuint	mFB
GLFBOManager *	mManager
GLSurfaceDesc	mMultisampleColourBuffer
GLuint	mMultisampleFB
GLsizei	mNumSamples
GLSurfaceDesc	mStencil

Detailed Description

Frame Buffer Object abstraction.

Definition at line 38 of file OgreGLFrameBufferObject.h.

Constructor & Destructor Documentation

GLFrameBufferObject()

Ogre::GLFrameBufferObject::GLFrameBufferObject	(	GLFBOManager *	manager,
		uint	fsaa
	)

~GLFrameBufferObject()

Ogre::GLFrameBufferObject::~GLFrameBufferObject

(

)

Member Function Documentation

attachDepthBuffer()

void Ogre::GLFrameBufferObject::attachDepthBuffer

(

DepthBuffer *

depthBuffer

)

This function acts very similar to.

See also

GLFBORenderTexture::attachDepthBuffer The difference between D3D & OGL is that D3D setups the DepthBuffer before rendering, while OGL setups the DepthBuffer per FBO. So the DepthBuffer (RenderBuffer) needs to be attached for OGL.

bind()

void Ogre::GLFrameBufferObject::bind

(

)

Bind FrameBufferObject.

bindSurface()

void Ogre::GLFrameBufferObject::bindSurface	(	size_t	attachment,
		const GLSurfaceDesc &	target
	)

Bind a surface to a certain attachment point.

attachment: 0..OGRE_MAX_MULTIPLE_RENDER_TARGETS-1

detachDepthBuffer()

void Ogre::GLFrameBufferObject::detachDepthBuffer

(

)

getFormat()

PixelFormat Ogre::GLFrameBufferObject::getFormat

(

)

getFSAA()

GLsizei Ogre::GLFrameBufferObject::getFSAA

(

)

getGLFBOID()

GLuint Ogre::GLFrameBufferObject::getGLFBOID

(

)

const

Get the GL id for the FBO.

Definition at line 69 of file OgreGLFrameBufferObject.h.

getGLMultisampleFBOID()

GLuint Ogre::GLFrameBufferObject::getGLMultisampleFBOID

(

)

const

Get the GL id for the multisample FBO.

Definition at line 71 of file OgreGLFrameBufferObject.h.

getHeight()

uint32 Ogre::GLFrameBufferObject::getHeight

(

)

getManager()

GLFBOManager* Ogre::GLFrameBufferObject::getManager

(

)

Definition at line 79 of file OgreGLFrameBufferObject.h.

getSurface()

const GLSurfaceDesc& Ogre::GLFrameBufferObject::getSurface

(

size_t

attachment

)

Definition at line 80 of file OgreGLFrameBufferObject.h.

getWidth()

uint32 Ogre::GLFrameBufferObject::getWidth

(

)

Accessors.

initialise()

void Ogre::GLFrameBufferObject::initialise ( )

private

Initialise object (find suitable depth and stencil format).

Must be called every time the bindings change. It fails with an exception (ERR_INVALIDPARAMS) if:

• Attachment point 0 has no binding
• Not all bound surfaces have the same size
• Not all bound surfaces have the same internal format

swapBuffers()

void Ogre::GLFrameBufferObject::swapBuffers

(

)

Swap buffers - only useful when using multisample buffers.

unbindSurface()

void Ogre::GLFrameBufferObject::unbindSurface

(

size_t

attachment

)

Unbind attachment.

Member Data Documentation

mColour

GLSurfaceDesc Ogre::GLFrameBufferObject::mColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS]

private

Definition at line 90 of file OgreGLFrameBufferObject.h.

mDepth

GLSurfaceDesc Ogre::GLFrameBufferObject::mDepth

private

Definition at line 87 of file OgreGLFrameBufferObject.h.

mFB

GLuint Ogre::GLFrameBufferObject::mFB

private

Definition at line 84 of file OgreGLFrameBufferObject.h.

mManager

GLFBOManager* Ogre::GLFrameBufferObject::mManager

private

Definition at line 82 of file OgreGLFrameBufferObject.h.

mMultisampleColourBuffer

GLSurfaceDesc Ogre::GLFrameBufferObject::mMultisampleColourBuffer

private

Definition at line 86 of file OgreGLFrameBufferObject.h.

mMultisampleFB

GLuint Ogre::GLFrameBufferObject::mMultisampleFB

private

Definition at line 85 of file OgreGLFrameBufferObject.h.

mNumSamples

GLsizei Ogre::GLFrameBufferObject::mNumSamples

private

Definition at line 83 of file OgreGLFrameBufferObject.h.

mStencil

GLSurfaceDesc Ogre::GLFrameBufferObject::mStencil

private

Definition at line 88 of file OgreGLFrameBufferObject.h.

---

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

• OgreGLFrameBufferObject.h