RmSampler Class Reference

Sampler. More...

#include <RmEffect.h>

Inheritance diagram for RmSampler:

List of all members.

Public Member Functions
	RmSampler ()
	Default Constructor.
	RmSampler (const RM_TCHAR *strSamplerName, int nRegister)
	Constructor.
virtual	~RmSampler ()
	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 ()
virtual bool	IsNodeValid ()
	Is node valid.
void	SetRegister (int nIndex)
	Set register.
int	GetRegister ()
	Get register.
RmNode *	GetTextureObject ()
	Get texture object.
const RmNode *	GetTextureObject () const
	Get texture object.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
Protected Attributes
int	m_nRegister
	Stores which register this sampler is mapped to.
RmNode *	m_pTextureObject
	Stores the reference texture object.

---

Detailed Description

Sampler.

RmSampler is used for sampler declaration in HLSL shaders. This structure is used to link a texture object within the RenderMonkey workspace to a sampler object. The inherited name field specifies the name of the sampler object.

---

Constructor & Destructor Documentation

RmSampler::RmSampler (   )

Default Constructor. Default constructor

RmSampler::RmSampler (  const RM_TCHAR *  strSamplerName, int  nRegister )

Constructor. Creates a new sampler constant with specified name and register mapping Parameters: strSamplerName  Name of this node nRegister  Register index

virtual RmSampler::~RmSampler (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual RmNode* RmSampler::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 RmSampler::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* RmSampler::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.

int RmSampler::GetRegister (   )  [inline]

Get register. Register nIndex for the sampler Returns: Register index

const RmNode* RmSampler::GetTextureObject (   )  const [inline]

Get texture object. Returns TetxureObject that this node references Returns: TextureObject See also: RmNode

RmNode* RmSampler::GetTextureObject (   )  [inline]

Get texture object. Returns TetxureObject that this node references Returns: TextureObject See also: RmNode

virtual bool RmSampler::IsNodeValid (   )  [inline, virtual]

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

virtual bool RmSampler::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 RmSampler::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 RmSampler::SetRegister (  int  nIndex  )  [inline]

Set register. Set register nIndex Parameters: nIndex  Register Index

virtual void RmSampler::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

---