CMuli3DRenderTarget Class Reference

#include <m3dcore_rendertarget.h>

Inheritance diagram for CMuli3DRenderTarget:

List of all members.

Detailed Description

This class defines a Muli3D rendertarget.

Public Member Functions

result ClearColorBuffer (const vector4 &i_vColor, const m3drect *i_pRect)

result ClearDepthBuffer (float32 i_fDepth, const m3drect *i_pRect)

const matrix44 & matGetViewportMatrix ()

CMuli3DSurface * pGetColorBuffer ()

CMuli3DSurface * pGetDepthBuffer ()

CMuli3DDevice * pGetDevice ()

result SetColorBuffer (class CMuli3DSurface *i_pColorBuffer)

result SetDepthBuffer (class CMuli3DSurface *i_pDepthBuffer)

void SetViewportMatrix (const matrix44 &i_matViewport)

Protected Member Functions

CMuli3DRenderTarget (class CMuli3DDevice *i_pParent)

~CMuli3DRenderTarget ()

Constructor & Destructor Documentation

CMuli3DRenderTarget::~CMuli3DRenderTarget ( ) [protected]

Accessible by IBase. The destructor is called when the reference count reaches zero.

CMuli3DRenderTarget::CMuli3DRenderTarget ( class CMuli3DDevice * i_pParent ) [protected]

Accessible by CMuli3DDevice which is the only class that may create a render target.
Parameters:

[in] i_pParent a pointer to the parent CMuli3DDevice-object.

Member Function Documentation

result CMuli3DRenderTarget::ClearColorBuffer ( const vector4 & i_vColor,

const m3drect * i_pRect

)

Clears the colorbuffer, which is associated with this rendertarget, to a given color.
Parameters:

[in] i_vColor color to clear the colorbuffer to.

[in] i_pRect rectangle to restrict clearing to.

Returns:
s_ok if the function succeeds.
e_invalidstate if no colorbuffer has been set.
e_invalidparameters if the clear-rectangle exceeds the colorbuffer's dimensions.

result CMuli3DRenderTarget::ClearDepthBuffer ( float32 i_fDepth,

const m3drect * i_pRect

)

Clears the depthbuffer, which is associated with this rendertarget, to a given depth-value.
Parameters:

[in] i_fDepth depth to clear the depthbuffer to.

[in] i_pRect rectangle to restrict clearing to.

Returns:
s_ok if the function succeeds.
e_invalidstate if no depthbuffer has been set.
e_invalidparameters if the clear-rectangle exceeds the depthbuffer's dimensions.

const matrix44 & CMuli3DRenderTarget::matGetViewportMatrix ( )

Returns the rendertarget's viewport matrix.

CMuli3DSurface * CMuli3DRenderTarget::pGetColorBuffer ( )

Returns a pointer to the rendertarget's colorbuffer. Calling this function will increase the internal reference count of the texture. Failure to call Release() when finished using the pointer will result in a memory leak.

CMuli3DSurface * CMuli3DRenderTarget::pGetDepthBuffer ( )

Returns a pointer to the rendertarget's depthbuffer. Calling this function will increase the internal reference count of the texture. Failure to call Release() when finished using the pointer will result in a memory leak.

CMuli3DDevice * CMuli3DRenderTarget::pGetDevice ( )

Returns a pointer to the associated device. Calling this function will increase the internal reference count of the device. Failure to call Release() when finished using the pointer will result in a memory leak.

result CMuli3DRenderTarget::SetColorBuffer ( class CMuli3DSurface * i_pColorBuffer )

Associates a CMuli3DSurface as colorbuffer with this rendertarget, releasing the currently set colorbuffer. Calling this function will increase the internal reference count of the surface.
Parameters:

[in] i_pColorBuffer new colorbuffer.

Returns:
s_ok if the function succeeds.
e_invalidformat if an invalid format was encountered.

result CMuli3DRenderTarget::SetDepthBuffer ( class CMuli3DSurface * i_pDepthBuffer )

Associates a CMuli3DSurface as depthbuffer with this rendertarget, releasing the currently set depthbuffer. Calling this function will increase the internal reference count of the surface.
Parameters:

[in] i_pDepthBuffer new depthbuffer.

Returns:
s_ok if the function succeeds.
e_invalidformat if an invalid format was encountered.

void CMuli3DRenderTarget::SetViewportMatrix ( const matrix44 & i_matViewport )

Sets the rendertarget's viewport matrix.
Parameters:

[in] i_matViewport the viewport matrix.