VRS::RenderTextureGL Class Reference

Rendertextures represent render targets for framebuffer objects. More...

#include <vrs/opengl/fbo/rendertexturegl.h>

Inheritance diagram for VRS::RenderTextureGL:

List of all members.

Public Member Functions
	RenderTextureGL (Texture1DGL *texture, unsigned int width, unsigned int mipMapLevel=0, GLenum type=GL_UNSIGNED_BYTE, bool generateMipMap=true)
	RenderTextureGL (Texture2DGL *texture, unsigned int width, unsigned int height, unsigned int mipMapLevel=0, GLenum type=GL_UNSIGNED_BYTE, bool generateMipMap=true)
	RenderTextureGL (CubeMapTextureGL *texture, GLenum textureTarget, unsigned int dim, unsigned int mipMapLevel=0, GLenum type=GL_UNSIGNED_BYTE, bool generateMipMap=true)
	RenderTextureGL (Texture3DGL *texture, unsigned int width, unsigned int height, unsigned int depth, unsigned int mipMapLevel=0, unsigned int zOffset=0, GLenum type=GL_UNSIGNED_BYTE, bool generateMipMap=true)
	RenderTextureGL (TextureArray2DGL *texture, unsigned int width, unsigned int height, unsigned int depth, unsigned int mipMapLevel=0, unsigned int zOffset=0, GLenum type=GL_UNSIGNED_BYTE, bool generateMipMap=true)
virtual GLenum	renderTarget () const
virtual unsigned int	width () const
	See 'RenderTarget'.
virtual unsigned int	height () const
TextureGL *	getTexture () const
	See 'RenderTarget'.
GLenum	getTextureTarget () const
int	getMipMapLevel () const
void	setMipMapLevel (int level)
int	getZOffset () const
void	setZOffset (int offset)
GLenum	getType () const
void	setType (GLenum)
bool	generateMipMap () const
void	generateMipMap (bool)
unsigned int	depth () const
void	setWidth (unsigned int width)
	Depth or number of slices of the 3D texture.
void	setHeight (unsigned int height)
void	setDepth (unsigned int depth)
	VRS_TYPEINFO (RenderTextureGL, RenderTargetGL)
	VRS_SERIALIZABLE (RenderTextureGL)
Protected Member Functions
	RenderTextureGL ()

---

Detailed Description

Rendertextures represent render targets for framebuffer objects.

---

Constructor & Destructor Documentation

VRS::RenderTextureGL::RenderTextureGL	(	Texture1DGL *	texture,
		unsigned int	width,
		unsigned int	mipMapLevel = 0,
		GLenum	type = GL_UNSIGNED_BYTE,
		bool	generateMipMap = true
	)

< A rendertexture represent a framebuffer-attachable image for implementing render-to-texture.

VRS::RenderTextureGL::RenderTextureGL	(	Texture2DGL *	texture,
		unsigned int	width,
		unsigned int	height,
		unsigned int	mipMapLevel = 0,
		GLenum	type = GL_UNSIGNED_BYTE,
		bool	generateMipMap = true
	)

VRS::RenderTextureGL::RenderTextureGL	(	CubeMapTextureGL *	texture,
		GLenum	textureTarget,
		unsigned int	dim,
		unsigned int	mipMapLevel = 0,
		GLenum	type = GL_UNSIGNED_BYTE,
		bool	generateMipMap = true
	)

VRS::RenderTextureGL::RenderTextureGL	(	Texture3DGL *	texture,
		unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		unsigned int	mipMapLevel = 0,
		unsigned int	zOffset = 0,
		GLenum	type = GL_UNSIGNED_BYTE,
		bool	generateMipMap = true
	)

VRS::RenderTextureGL::RenderTextureGL	(	TextureArray2DGL *	texture,
		unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		unsigned int	mipMapLevel = 0,
		unsigned int	zOffset = 0,
		GLenum	type = GL_UNSIGNED_BYTE,
		bool	generateMipMap = true
	)

With framebuffer objects one can either render to 1D and 2D textures (including rectangle), cube map sides, and 3D texture slices.

VRS::RenderTextureGL::RenderTextureGL

(

)

[inline, protected]

---

Member Function Documentation

virtual GLenum VRS::RenderTextureGL::renderTarget

(

)

const [inline, virtual]

< A render target defines a frambuffer-attachable image as a rendering destination. (used by 'FrameBufferObjectGL') Denote the type of a render target used to attach the render target. Valid render targets are GL_RENDERBUFFER_EXT and GL_RENDERTEXTURE_EXT implemented by 'RenderBufferGL' and 'RenderTextureGL'.

Implements VRS::RenderTargetGL.

unsigned int VRS::RenderTextureGL::width

(

)

const [inline, virtual]

See 'RenderTarget'.

Implements VRS::RenderTargetGL.

unsigned int VRS::RenderTextureGL::height

(

)

const [inline, virtual]

Render targets must provide a non-zero width and height. All render targets of a framebuffer object must have equal width and heigth.

Implements VRS::RenderTargetGL.

TextureGL * VRS::RenderTextureGL::getTexture

(

)

const [inline]

See 'RenderTarget'.

Access the texture for subsequent use.

GLenum VRS::RenderTextureGL::getTextureTarget

(

)

const [inline]

Access the texture target (e.g., GL_TEXTURE_2D) for internal use (i.e., by 'FrameBufferObjectPainterGL').

int VRS::RenderTextureGL::getMipMapLevel

(

)

const [inline]

void VRS::RenderTextureGL::setMipMapLevel

(

int

level

)

The mipmap level denotes the designated level of the mipmap pyramide for rendering.

int VRS::RenderTextureGL::getZOffset

(

)

const [inline]

void VRS::RenderTextureGL::setZOffset

(

int

offset

)

[inline]

The z-offset denotes the designated slice of a 3D texture for rendering.

GLenum VRS::RenderTextureGL::getType

(

)

const [inline]

void VRS::RenderTextureGL::setType

(

GLenum

)

Represents the data type of the texture image data.

bool VRS::RenderTextureGL::generateMipMap

(

)

const [inline]

void VRS::RenderTextureGL::generateMipMap

(

bool

generateMipmap

)

[inline]

The mipmap flag indicates whether mipmaps should be generated automatically.

unsigned int VRS::RenderTextureGL::depth

(

)

const [inline]

void VRS::RenderTextureGL::setWidth

(

unsigned int

width

)

[inline]

Depth or number of slices of the 3D texture.

void VRS::RenderTextureGL::setHeight

(

unsigned int

height

)

[inline]

void VRS::RenderTextureGL::setDepth

(

unsigned int

depth

)

[inline]

Resize texture resolution, e.g., to adjust to the size of the window-dependent canvas.

VRS::RenderTextureGL::VRS_TYPEINFO	(	RenderTextureGL	,
		RenderTargetGL
	)

VRS::RenderTextureGL::VRS_SERIALIZABLE

(

RenderTextureGL

)

---

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

• rendertexturegl.h