Frame buffer class. More...

#include <tdme/engine/FrameBuffer.h>

Collaboration diagram for FrameBuffer:

Public Member Functions
	FrameBuffer (int32_t width, int32_t height, int32_t buffers, int32_t cubeMapTextureId=CUBEMAPTEXTUREID_NONE, int32_t cubeMapTextureIndex=CUBEMAPTEXTUREINDEX_NONE)
	Public constructor. More...

int32_t	getWidth ()

int32_t	getHeight ()

int32_t	getId ()

int32_t	getDepthBufferTextureId ()

int32_t	getColorBufferTextureId ()

void	initialize ()
	Initialize the frame buffer. More...

void	reshape (int32_t width, int32_t height)
	Resize the frame buffer. More...

void	dispose ()
	Disposes this frame buffer. More...

void	enableFrameBuffer ()
	Enables this frame buffer to be rendered. More...

void	bindDepthBufferTexture (int contextIdx)
	Bind depth texture. More...

void	bindColorBufferTexture (int contextIdx)
	Bind color texture. More...

void	renderToScreen (Engine *engine)
	Render to screen or bound frame buffer. More...

void	renderDepthBufferToScreen (Engine *engine)
	Render depth buffer to screen or bound frame buffer. More...

Static Public Member Functions
static void	disableFrameBuffer ()
	Switches back to non offscreen main frame buffer to be rendered. More...

static void	doPostProcessing (Engine engine, FrameBuffer target, FrameBuffer source, const string &programId, const string &shaderId, FrameBuffer temporary=nullptr, FrameBuffer *blendToSource=nullptr)
	Do post processing into target frame buffer (which can be screen as well when passing nullptr) More...

Static Public Attributes
static constexpr int32_t	FRAMEBUFFER_DEPTHBUFFER { 1 }

static constexpr int32_t	FRAMEBUFFER_COLORBUFFER { 2 }

static constexpr int32_t	CUBEMAPTEXTUREID_NONE { 0 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_NONE { 0 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_NEGATIVE_X { 1 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_POSITIVE_X { 2 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_POSITIVE_Y { 3 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_NEGATIVE_Y { 4 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_POSITIVE_Z { 5 }

static constexpr int32_t	CUBEMAPTEXTUREINDEX_NEGATIVE_Z { 6 }

Private Member Functions
void	renderToScreen (Engine *engine, int32_t depthBufferTextureId, int32_t colorBufferTextureId)
	Render given depth texture and color buffer texture to screen @parma engine engine. More...

Private Attributes
int32_t	width

int32_t	height

int32_t	frameBufferId

int32_t	depthBufferTextureId

int32_t	colorBufferTextureId

int32_t	buffers

int32_t	cubeMapTextureId

int32_t	cubeMapTextureIndex

Detailed Description

Frame buffer class.

Author: Andreas Drewke

Version: $Id$

Definition at line 20 of file FrameBuffer.h.

Constructor & Destructor Documentation

◆ FrameBuffer()

FrameBuffer	(	int32_t	width,
		int32_t	height,
		int32_t	buffers,
		int32_t	cubeMapTextureId = `CUBEMAPTEXTUREID_NONE`,
		int32_t	cubeMapTextureIndex = `CUBEMAPTEXTUREINDEX_NONE`
	)

Public constructor.

Parameters

width	width
height	height
buffers	buffers (see FrameBuffer::FRAMEBUFFER_*)
cubeMapTextureId	cube map texture id
cubeMapTextureIndex	cube map texture index

Definition at line 21 of file FrameBuffer.cpp.

Member Function Documentation

◆ bindColorBufferTexture()

void bindColorBufferTexture ( int contextIdx )

Bind color texture.

Parameters

contextIdx context index

Definition at line 97 of file FrameBuffer.cpp.

◆ bindDepthBufferTexture()

void bindDepthBufferTexture ( int contextIdx )

Bind depth texture.

Parameters

contextIdx context index

Definition at line 92 of file FrameBuffer.cpp.

◆ disableFrameBuffer()

void disableFrameBuffer ( )

static

Switches back to non offscreen main frame buffer to be rendered.

Definition at line 85 of file FrameBuffer.cpp.

◆ dispose()

void dispose ( )

Disposes this frame buffer.

Definition at line 67 of file FrameBuffer.cpp.

◆ doPostProcessing()

void doPostProcessing	(	Engine *	engine,
		FrameBuffer *	target,
		FrameBuffer *	source,
		const string &	programId,
		const string &	shaderId,
		FrameBuffer *	temporary = `nullptr`,
		FrameBuffer *	blendToSource = `nullptr`
	)

static

Do post processing into target frame buffer (which can be screen as well when passing nullptr)

Parameters

engine	engine
source	source frame buffer
programId	post processing shader id
shaderId	post processing shader id
temporary	bind additional temporary frame buffer
blendToSource	target = blendToSource + source

Definition at line 156 of file FrameBuffer.cpp.

◆ enableFrameBuffer()

void enableFrameBuffer ( )

Enables this frame buffer to be rendered.

Definition at line 78 of file FrameBuffer.cpp.

◆ getColorBufferTextureId()

int32_t getColorBufferTextureId ( )

inline

Returns: color buffer texture id

Definition at line 97 of file FrameBuffer.h.

◆ getDepthBufferTextureId()

int32_t getDepthBufferTextureId ( )

inline

Returns: depth buffer texture id

Definition at line 90 of file FrameBuffer.h.

◆ getHeight()

int32_t getHeight ( )

inline

Returns: height

Definition at line 76 of file FrameBuffer.h.

◆ getId()

int32_t getId ( )

inline

Returns: frame buffer id

Definition at line 83 of file FrameBuffer.h.

◆ getWidth()

int32_t getWidth ( )

inline

Returns: width

Definition at line 69 of file FrameBuffer.h.

◆ initialize()

void initialize ( )

Initialize the frame buffer.

Definition at line 33 of file FrameBuffer.cpp.

◆ renderDepthBufferToScreen()

void renderDepthBufferToScreen ( Engine * engine )

inline

Render depth buffer to screen or bound frame buffer.

Parameters

engine engine

Definition at line 152 of file FrameBuffer.h.

◆ renderToScreen() [1/2]

void renderToScreen ( Engine * engine )

inline

Render to screen or bound frame buffer.

Parameters

engine engine

Definition at line 144 of file FrameBuffer.h.

◆ renderToScreen() [2/2]

void renderToScreen	(	Engine *	engine,
		int32_t	depthBufferTextureId,
		int32_t	colorBufferTextureId
	)

private

Render given depth texture and color buffer texture to screen @parma engine engine.

Parameters

depthBufferTextureId	depth buffer texture id
colorBufferTextureId	color buffer texture id

Definition at line 102 of file FrameBuffer.cpp.

◆ reshape()

void reshape	(	int32_t	width,
		int32_t	height
	)

Resize the frame buffer.

Parameters

width	width
height	height

Definition at line 55 of file FrameBuffer.cpp.

Member Data Documentation

◆ buffers

int32_t buffers

private

Definition at line 43 of file FrameBuffer.h.

◆ colorBufferTextureId

int32_t colorBufferTextureId

private

Definition at line 42 of file FrameBuffer.h.

◆ cubeMapTextureId

int32_t cubeMapTextureId

private

Definition at line 44 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREID_NONE

constexpr int32_t CUBEMAPTEXTUREID_NONE { 0 }

staticconstexpr

Definition at line 27 of file FrameBuffer.h.

◆ cubeMapTextureIndex

int32_t cubeMapTextureIndex

private

Definition at line 45 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_X

constexpr int32_t CUBEMAPTEXTUREINDEX_NEGATIVE_X { 1 }

staticconstexpr

Definition at line 30 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_Y

constexpr int32_t CUBEMAPTEXTUREINDEX_NEGATIVE_Y { 4 }

staticconstexpr

Definition at line 33 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_Z

constexpr int32_t CUBEMAPTEXTUREINDEX_NEGATIVE_Z { 6 }

staticconstexpr

Definition at line 35 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_NONE

constexpr int32_t CUBEMAPTEXTUREINDEX_NONE { 0 }

staticconstexpr

Definition at line 29 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_POSITIVE_X

constexpr int32_t CUBEMAPTEXTUREINDEX_POSITIVE_X { 2 }

staticconstexpr

Definition at line 31 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_POSITIVE_Y

constexpr int32_t CUBEMAPTEXTUREINDEX_POSITIVE_Y { 3 }

staticconstexpr

Definition at line 32 of file FrameBuffer.h.

◆ CUBEMAPTEXTUREINDEX_POSITIVE_Z

constexpr int32_t CUBEMAPTEXTUREINDEX_POSITIVE_Z { 5 }

staticconstexpr

Definition at line 34 of file FrameBuffer.h.

◆ depthBufferTextureId

int32_t depthBufferTextureId

private

Definition at line 41 of file FrameBuffer.h.

◆ FRAMEBUFFER_COLORBUFFER

constexpr int32_t FRAMEBUFFER_COLORBUFFER { 2 }

staticconstexpr

Definition at line 25 of file FrameBuffer.h.

◆ FRAMEBUFFER_DEPTHBUFFER

constexpr int32_t FRAMEBUFFER_DEPTHBUFFER { 1 }

staticconstexpr

Definition at line 24 of file FrameBuffer.h.

◆ frameBufferId

int32_t frameBufferId

private

Definition at line 40 of file FrameBuffer.h.

◆ height

int32_t height

private

Definition at line 39 of file FrameBuffer.h.

◆ width

int32_t width

private

Definition at line 38 of file FrameBuffer.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/FrameBuffer.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/FrameBuffer.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FrameBuffer()

Member Function Documentation

◆ bindColorBufferTexture()

◆ bindDepthBufferTexture()

◆ disableFrameBuffer()

◆ dispose()

◆ doPostProcessing()

◆ enableFrameBuffer()

◆ getColorBufferTextureId()

◆ getDepthBufferTextureId()

◆ getHeight()

◆ getId()

◆ getWidth()

◆ initialize()

◆ renderDepthBufferToScreen()

◆ renderToScreen() [1/2]

◆ renderToScreen() [2/2]

◆ reshape()

Member Data Documentation

◆ buffers

◆ colorBufferTextureId

◆ cubeMapTextureId

◆ CUBEMAPTEXTUREID_NONE

◆ cubeMapTextureIndex

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_X

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_Y

◆ CUBEMAPTEXTUREINDEX_NEGATIVE_Z

◆ CUBEMAPTEXTUREINDEX_NONE

◆ CUBEMAPTEXTUREINDEX_POSITIVE_X

◆ CUBEMAPTEXTUREINDEX_POSITIVE_Y

◆ CUBEMAPTEXTUREINDEX_POSITIVE_Z

◆ depthBufferTextureId

◆ FRAMEBUFFER_COLORBUFFER

◆ FRAMEBUFFER_DEPTHBUFFER

◆ frameBufferId

◆ height

◆ width