The base interface for all render targets. More...

#include <LSGRenderTargetInterface.h>

Inheritance diagram for lsg::CRenderTargetInterface:

Public Member Functions
LSE_INLINE LSUINT32 LSE_CALL	GetWidth () const
LSE_INLINE LSUINT32 LSE_CALL	GetHeight () const
virtual LSBOOL LSE_CALL	SetsColorAutomatically () const
LSE_INLINE LSUINT32 LSE_CALL	GetId () const
Protected Member Functions
virtual LSBOOL LSE_CALL	SetAsColorRenderTarget (LSUINT32 _ui32Slot) const
virtual LSBOOL LSE_CALL	SetAsDepthStencilRenderTarget () const
virtual LSVOID LSE_CALL	EndAsRenderTarget () const
Protected Attributes
LSUINT32	m_ui32Id
LSUINT32	m_ui32Width
LSUINT32	m_ui32Height
Static Protected Attributes
static LSUINT32	m_ui32IdCounter
static CCriticalSection	m_csBaseCrit
Friends
class	CDirectX9RenderTargetManager
class	CDirectX10RenderTargetManager
class	CDirectX11RenderTargetManager
class	COpenGlRenderTargetManager
class	COpenGlEsRenderTargetManager

Detailed Description

The base interface for all render targets.

Class CRenderTargetInterface Description: The base interface for all render targets.

Member Function Documentation

virtual LSVOID LSE_CALL lsg::CRenderTargetInterface::EndAsRenderTarget ( ) const [protected, virtual]

End its term as a render target.

Reimplemented in lsg::CDirectX11DepthStencilRenderTarget, lsg::CDirectX11FloatTexture, and lsg::CDirectX11RenderTarget.

LSE_INLINE LSUINT32 LSE_CALL lsg::CRenderTargetInterface::GetHeight ( ) const

Get the height of the surface.

Returns:: Returns the height of the surface.

LSE_INLINE LSUINT32 LSE_CALL lsg::CRenderTargetInterface::GetId ( ) const

Gets the unique ID of this render target, which can never be 0.

Returns:: Returns the unique ID of this render target.

LSE_INLINE LSUINT32 LSE_CALL lsg::CRenderTargetInterface::GetWidth ( ) const

Get the width of the surface.

Returns:: Returns the width of the surface.

virtual LSBOOL LSE_CALL lsg::CRenderTargetInterface::SetAsColorRenderTarget ( LSUINT32 _ui32Slot ) const [protected, virtual]

Activate as a color render target.

Parameters:

_ui32Slot The color slot into which to activate the render target.

Returns:: Returns true if it is ready to be used as a render target.

Reimplemented in lsg::CDirectX11RenderTarget.

virtual LSBOOL LSE_CALL lsg::CRenderTargetInterface::SetAsDepthStencilRenderTarget ( ) const [protected, virtual]

Activate as a depth/stencil render target.

Returns:: Returns true if it is ready to be used as a render target.

Reimplemented in lsg::CDirectX11DepthStencilRenderTarget, and lsg::CDirectX11FloatTexture.

virtual LSBOOL LSE_CALL lsg::CRenderTargetInterface::SetsColorAutomatically ( ) const [virtual]

If this render target is a depth target and no color targets have been specified (in the render target manager), the render target manager will query the depth target to ask if it has automatically set color target 0. If so, this function should return true.