Nirtcpp 2.1.0
Nirtcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
nirt::video::IRenderTarget Class Referenceabstract

Interface of a Render Target. More...

#include <nirtcpp/core/engine/IRenderTarget.hpp>

Inheritance diagram for nirt::video::IRenderTarget:
Inheritance graph
Collaboration diagram for nirt::video::IRenderTarget:
Collaboration graph

Public Member Functions

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

Protected Member Functions

virtual void setTextures (ITexture *const *textures, u32 numTextures, ITexture *depthStencil, const E_CUBE_SURFACE *cubeSurfaces=0, u32 numCubeSurfaces=0)=0
 Set multiple textures.
 
- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object.
 

Protected Attributes

core::array< ITexture * > Textures
 Textures assigned to render target.
 
ITextureDepthStencil
 Depth or packed depth-stencil texture assigned to render target.
 
core::array< E_CUBE_SURFACECubeSurfaces
 Active surface of cube textures.
 
E_DRIVER_TYPE DriverType
 Driver type of render target.
 

Detailed Description

Interface of a Render Target.

Member Function Documentation

◆ setTexture() [1/2]

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

Set multiple textures.

Set multiple textures for the render target.

Parameters
textureArray of texture objects. These textures are used for a color outputs.
depthStencilDepth or packed depth-stencil texture. This texture is used as depth or depth-stencil buffer. You can pass getDepthStencil() if you don't want to change it.
cubeSurfacesWhen rendering to cube textures, set the surface to be used for each texture. Can be empty otherwise.

◆ setTexture() [2/2]

void nirt::video::IRenderTarget::setTexture ( ITexture texture,
ITexture depthStencil 
)
inline

Sets one texture + depthStencil You can pass getDepthStencil() for depthStencil if you don't want to change that one


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

Nirtcpp    @cppfx.xyz

Esvcpp    esv::print