RmRenderTarget Class Reference

Render Target. More...

#include <RmEffect.h>

Inheritance diagram for RmRenderTarget:

List of all members.

Public Member Functions
	RmRenderTarget ()
	Default Constructor.
	RmRenderTarget (int nIndex)
	RmRenderTarget (const RM_TCHAR *strName, int nIndex, DWORD dwClearColor, bool bEnableColorClear, bool bEnableDepthClear, float fDepthClearValue, RmRenderableTexture *pTexture=NULL)
virtual	~RmRenderTarget ()
	Destructor.
virtual void	Update (RmNodeUpdateType nodeUpdateType, RmNode *pRmUpdateRootNode)
	Update.
virtual bool	LoadXMLData (int hDoc, const RM_TCHAR *strXPath, const RM_TCHAR *strRmXMLVersion)
	Load node data from XML.
virtual bool	SaveXMLData (int hDoc, const RM_TCHAR *strXPath)
	Save node data to XML.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
void	SetRenderToScreen (bool bRenderToScreen=true)
	Enable or disables rendering of this render target. ///.
bool	IsRenderToScreen ()
	Retrieves whether this pass is enabled or disabled for rendering ///.
void	EnableColorClear (bool bClear)
	Set whether color clear should be enabled ///.
bool	IsColorClearEnabled ()
	Retrieve whether color clear is enabled ///.
bool	IsDepthClearEnabled ()
	Retrieve whether depth clear is enabled ///.
void	EnableDepthClear (bool bDepthClear)
	Set whether depth clearing is enabled ///.
float	GetDepthClearValue ()
	Retrieve the depth clear value ///.
void	SetDepthClearValue (float fDepth)
	Set new depth clear value ///.
RM_RGBA	GetClearColor ()
	Retrieve clear color ///.
void	SetClearColor (RM_RGBA dwColor)
	Set clear color ///.
virtual bool	IsNodeValid ()
	Is node valid.
void	SetRenderableTexture (RmRenderableTexture *pTexture)
	Set Renderable Texture.
RmRenderableTexture *	GetRenderableTexture ()
	Retrieve Renderable texture.
int	GetIndex ()
	Get texture stage index.
void	SetIndex (int nIndex)
	Set texture stage index.
void	SetHandle (unsigned int unHandle)
	Set texture handle.
unsigned int	GetHandle ()
	Get texture handle.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
virtual RmNodeTypeChildRuleList *	GetNodeTypeChildRuleList ()
	Parent / Child rule list function.
virtual void	SetNodeTypeChildRuleList (RmNodeTypeChildRuleList *pRmNodeChildRuleList)
	Sets the node child rule list for the given node.
Protected Attributes
RmRenderableTexture *	m_pRTexture
	Texture RmRenderableTexture.
int	m_nIndex
	Texture stage index.
bool	m_bRenderToScreen
	Render to screen flag.
bool	m_bColorClear
	Clear color flag.
bool	m_bDepthClear
	Clear depth flag.
RM_RGBA	m_dwClearColor
	Clear Color.
float	m_fDepthClear
	Clear depth.
unsigned int	m_unHandle
	Handle.

---

Detailed Description

Render Target.

RmRenderTarget structure points to a renderable texture

---

Constructor & Destructor Documentation

RmRenderTarget::RmRenderTarget (   )

Default Constructor. Default constructor

RmRenderTarget::RmRenderTarget (  int  nIndex  )

-------------------------------------------------------------------------------------------/// Create new render target node with specific target index. /// -------------------------------------------------------------------------------------------///

RmRenderTarget::RmRenderTarget (  const RM_TCHAR *  strName, int  nIndex, DWORD  dwClearColor, bool  bEnableColorClear, bool  bEnableDepthClear, float  fDepthClearValue, RmRenderableTexture *  pTexture = NULL )

Create new render target node with specific name and a link to a renderable texture node. /// The renderable texture node can be not specified, in which case it is set to NULL. /// This constructor also needs to specify parameters for this render target, such as whether /// color clear is enabled, whether depth clear is enabled, clear color and depth clear value ///

virtual RmRenderTarget::~RmRenderTarget (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual RmNode* RmRenderTarget::Clone (  bool  bIncludeLoadedData  )  [virtual]

Clone this node. Creates a clone of this node Returns: Cloned node. Returns NULL if cloning failed. Reimplemented from RmNode.

virtual void RmRenderTarget::CopyNodeData (  RmNode *  pDestinationNode, bool  bIncludeLoadedData )  [protected, virtual]

Copy node data. Copies this node's contents (not including children) into the destination node. See RmNode::CopyNodeData for details Parameters: pDestinationNode  the destination node Returns: None Reimplemented from RmNode.

virtual const RM_TCHAR* RmRenderTarget::GetDescription (   )  [virtual]

Returns description of the node: used for displaying a tooltip in the workspace tree view for the given node. Returns: Returns description string Reimplemented from RmNode.

unsigned int RmRenderTarget::GetHandle (   )  [inline]

Get texture handle. Retrieve the handle Returns: Texture handle

int RmRenderTarget::GetIndex (   )  [inline]

Get texture stage index. Retrieve texture stage nIndex for this texture object Returns: Texture stage index

virtual RmNodeTypeChildRuleList* RmRenderTarget::GetNodeTypeChildRuleList (   )  [inline, protected, virtual]

Parent / Child rule list function. Retrieves the rule list for adding child nodes for a given node type Returns: Returns node type child list rules Reimplemented from RmNode.

RmRenderableTexture* RmRenderTarget::GetRenderableTexture (   )  [inline]

Retrieve Renderable texture. Retrieve renderable texture reference Returns: Renderable texture See also: RmRenderableTexture

virtual bool RmRenderTarget::IsNodeValid (   )  [virtual]

Is node valid. Node valid property Returns: True if node is valid Reimplemented from RmNode.

virtual bool RmRenderTarget::LoadXMLData (  int  hDoc, const RM_TCHAR *  strXPath, const RM_TCHAR *  strRmXMLVersion )  [virtual]

Load node data from XML. Loads versioned XML node data. Note that this method will only load the contents of each node, not the data for all of the children nodes. Each child will have its own XML loading function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML strRmXMLVersion  XML version Returns: True if load succeeded. False otherwise. Reimplemented from RmNode.

virtual bool RmRenderTarget::SaveXMLData (  int  hDoc, const RM_TCHAR *  strXPath )  [virtual]

Save node data to XML. Saves node's contents to XML. Note that this method will only save the contents of each node, not the data for all of the children nodes. Each child will have its own XML saving function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML Returns: True if save succeeded. False otherwise. Reimplemented from RmNode.

void RmRenderTarget::SetHandle (  unsigned int  unHandle  )  [inline]

Set texture handle. Set handle Parameters: unHandle  Texture handle Returns: None

void RmRenderTarget::SetIndex (  int  nIndex  )  [inline]

Set texture stage index. Set texture stage nIndex for this texture object Parameters: nIndex  Texture stage index Returns: None

virtual void RmRenderTarget::SetNodeTypeChildRuleList (  RmNodeTypeChildRuleList *  pRmNodeChildRuleList  )  [inline, protected, virtual]

Sets the node child rule list for the given node. Sets the child addition rule list for the given node. Parameters: pRmNodeChildRuleList  new node rules list None  Reimplemented from RmNode.

void RmRenderTarget::SetRenderableTexture (  RmRenderableTexture *  pTexture  )

Set Renderable Texture. Set renderable texture reference Parameters: pTexture  Texture to set as renderable texture See also: RmRenderableTexture Returns: None

virtual void RmRenderTarget::Update (  RmNodeUpdateType  nodeUpdateType, RmNode *  pRmUpdateRootNode )  [virtual]

Update. Updates the internal values of the node Parameters: nodeUpdateType  Update type See also: RmNodeUpdateType Parameters: pRmUpdateRootNode  Root node for update Returns: None Reimplemented from RmNode.

---

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

• RmEffect.h

---