irr::video::IRenderTarget Class Reference

Interface of a Render Target. More...

#include <IRenderTarget.h>

Inheritance diagram for irr::video::IRenderTarget:

Public Member Functions
	IRenderTarget ()
	constructor More...
const core::array< ITexture * > &	getTexture () const
	Returns an array of previously set textures. More...
ITexture *	getDepthStencil () const
	Returns a of previously set depth / depth-stencil texture. More...
virtual void	setTexture (const core::array< ITexture * > &texture, ITexture *depthStencil, const core::array< E_CUBE_SURFACE > &cubeSurfaces=core::array< E_CUBE_SURFACE >())=0
	Set multiple textures. More...
void	setTexture (ITexture *texture, ITexture *depthStencil)
	Set one texture. More...
void	setTexture (ITexture *texture, ITexture *depthStencil, E_CUBE_SURFACE cubeSurface)
	Set one cube surface texture. More...
E_DRIVER_TYPE	getDriverType () const
	Get driver type of render target. More...
Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor. More...
virtual	~IReferenceCounted ()
	Destructor. More...
void	grab () const
	Grabs the object. Increments the reference counter by one. More...
bool	drop () const
	Drops the object. Decrements the reference counter by one. More...
s32	getReferenceCount () const
	Get the reference count. More...
const c8 *	getDebugName () const
	Returns the debug name of the object. More...

Protected Attributes
core::array< ITexture * >	Texture
	Textures assigned to render target. More...
ITexture *	DepthStencil
	Depth or packed depth-stencil texture assigned to render target. More...
core::array< E_CUBE_SURFACE >	CubeSurfaces
	Active surface of cube textures. More...
E_DRIVER_TYPE	DriverType
	Driver type of render target. More...

Additional Inherited Members
Protected Member Functions inherited from irr::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object. More...

Detailed Description

Interface of a Render Target.

Definition at line 30 of file IRenderTarget.h.

Constructor & Destructor Documentation

IRenderTarget()

irr::video::IRenderTarget::IRenderTarget ( )

inline

constructor

Definition at line 35 of file IRenderTarget.h.

                                : DepthStencil(0), DriverType(EDT_NULL)
                {
                }

Member Function Documentation

getDepthStencil()

ITexture* irr::video::IRenderTarget::getDepthStencil ( ) const

inline

Returns a of previously set depth / depth-stencil texture.

Definition at line 46 of file IRenderTarget.h.

                {
                        return DepthStencil;
                }

getDriverType()

E_DRIVER_TYPE irr::video::IRenderTarget::getDriverType ( ) const

inline

Get driver type of render target.

Definition at line 82 of file IRenderTarget.h.

                {
                        return DriverType;
                }

getTexture()

const core::array<ITexture*>& irr::video::IRenderTarget::getTexture ( ) const

inline

Returns an array of previously set textures.

Definition at line 40 of file IRenderTarget.h.

                {
                        return Texture;
                }

setTexture() [1/3]

virtual void irr::video::IRenderTarget::setTexture ( const core::array< ITexture * > &  texture, ITexture *  depthStencil, const core::array< E_CUBE_SURFACE > &  cubeSurfaces = core::array< E_CUBE_SURFACE >()  )

pure virtual

Set multiple textures.

Set multiple textures for the render target.

Parameters

texture	Array of texture objects. These textures are used for a color outputs.
depthStencil	Depth or packed depth-stencil texture. This texture is used as depth or depth-stencil buffer.
cubeSurfaces	When rendering to cube textures, set the surface to be used for each texture. Can be empty otherwise.

setTexture() [2/3]

void irr::video::IRenderTarget::setTexture ( ITexture *  texture, ITexture *  depthStencil  )

inline

Set one texture.

Definition at line 61 of file IRenderTarget.h.

                {
                        core::array<ITexture*> textureArray(1);
                        textureArray.push_back(texture);

                        setTexture(textureArray, depthStencil);
                }

setTexture() [3/3]

void irr::video::IRenderTarget::setTexture ( ITexture *  texture, ITexture *  depthStencil, E_CUBE_SURFACE  cubeSurface  )

inline

Set one cube surface texture.

Definition at line 70 of file IRenderTarget.h.

                {
                        core::array<ITexture*> textureArray(1);
                        textureArray.push_back(texture);

                        core::array<E_CUBE_SURFACE> cubeSurfaces(1);
                        cubeSurfaces.push_back(cubeSurface);

                        setTexture(textureArray, depthStencil, cubeSurfaces);
                }

Member Data Documentation

CubeSurfaces

core::array<E_CUBE_SURFACE> irr::video::IRenderTarget::CubeSurfaces

protected

Active surface of cube textures.

Definition at line 96 of file IRenderTarget.h.

DepthStencil

ITexture* irr::video::IRenderTarget::DepthStencil

protected

Depth or packed depth-stencil texture assigned to render target.

Definition at line 93 of file IRenderTarget.h.

DriverType

E_DRIVER_TYPE irr::video::IRenderTarget::DriverType

protected

Driver type of render target.

Definition at line 99 of file IRenderTarget.h.

Texture

core::array<ITexture*> irr::video::IRenderTarget::Texture

protected

Textures assigned to render target.

Definition at line 90 of file IRenderTarget.h.

---

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

• include/irrlicht/IRenderTarget.h