Ogre::RTShader::Operand Class Reference
[RTShader]

A class that represents a function operand (its the combination of a parameter the in/out semantic and the used fields). More...

#include <OgreShaderFunctionAtom.h>

Inheritance diagram for Ogre::RTShader::Operand:

[legend]

List of all members.

Public Types
enum	OpSemantic { OPS_IN, OPS_OUT, OPS_INOUT }
enum	OpMask { OPM_ALL = 1 << 0, OPM_X = 1 << 1, OPM_Y = 1 << 2, OPM_Z = 1 << 3, OPM_W = 1 << 4 }
Public Member Functions
	Operand (ParameterPtr parameter, Operand::OpSemantic opSemantic, int opMask=Operand::OPM_ALL, ushort indirectionLevel=0)
	Class constructor.
	Operand (const Operand &rhs)
	Copy constructor.
Operand &	operator= (const Operand &rhs)
	Copy the given Operand to this Operand.
	~Operand ()
	Class destructor.
const ParameterPtr &	getParameter () const
	Returns the parameter object as weak reference.
bool	hasFreeFields () const
	Returns true if not all fields used.
int	getMask () const
	Returns the mask bitfield.
OpSemantic	getSemantic () const
	Returns the operand semantic (do we read/write or both with the parameter).
ushort	getIndirectionLevel () const
	Returns the level of indirection.
String	toString () const
	Returns the parameter name and the usage mask like this 'color.xyz'.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Static Public Member Functions
static String	getMaskAsString (int mask)
	Returns the given mask as string representation.
static int	getFloatCount (int mask)
	Return the float count of the given mask.
static GpuConstantType	getGpuConstantType (int mask)
	Return the gpu constant type of the given mask.
Protected Attributes
ParameterPtr	mParameter
OpSemantic	mSemantic
	The parameter being carried by the operand.
int	mMask
	Tells if the parameter is of type input,output or both.
ushort	mIndirectionLevel
	Which part of the parameter should be passed (x,y,z,w).

Detailed Description

A class that represents a function operand (its the combination of a parameter the in/out semantic and the used fields).

Definition at line 78 of file OgreShaderFunctionAtom.h.

Member Enumeration Documentation

enum Ogre::RTShader::Operand::OpMask

Enumerator:

OPM_ALL
OPM_X
OPM_Y
OPM_Z
OPM_W

Definition at line 94 of file OgreShaderFunctionAtom.h.

enum Ogre::RTShader::Operand::OpSemantic

Enumerator:

OPS_IN	The parameter is a input parameter.
OPS_OUT	The parameter is a output parameter.
OPS_INOUT	The parameter is a input/output parameter.

Definition at line 83 of file OgreShaderFunctionAtom.h.

Constructor & Destructor Documentation

Ogre::RTShader::Operand::Operand	(	ParameterPtr	parameter,
		Operand::OpSemantic	opSemantic,
		int	opMask = `Operand::OPM_ALL`,
		ushort	indirectionLevel = `0`
	)

Class constructor.

Parameters:

	parameter	A function parameter.
	opSemantic	The in/out semantic of the parameter.
	opMask	The field mask of the parameter.

Ogre::RTShader::Operand::Operand ( const Operand & rhs )

Copy constructor.

Ogre::RTShader::Operand::~Operand ( )

Class destructor.

Member Function Documentation

static int Ogre::RTShader::Operand::getFloatCount ( int mask ) [static]

Return the float count of the given mask.

static GpuConstantType Ogre::RTShader::Operand::getGpuConstantType ( int mask ) [static]

Return the gpu constant type of the given mask.

ushort Ogre::RTShader::Operand::getIndirectionLevel ( ) const

Returns the level of indirection.

The greater the indirection level the more the parameter needs to be nested in brackets. For example given 4 parameters x1...x4 with the indirections levels 0,1,1,2 respectively. The parameters should form the following string: x1[x2][x3[x4]].

Definition at line 138 of file OgreShaderFunctionAtom.h.

int Ogre::RTShader::Operand::getMask ( ) const

Returns the mask bitfield.

Definition at line 128 of file OgreShaderFunctionAtom.h.

static String Ogre::RTShader::Operand::getMaskAsString ( int mask ) [static]

Returns the given mask as string representation.

const ParameterPtr& Ogre::RTShader::Operand::getParameter ( ) const

Returns the parameter object as weak reference.

Definition at line 122 of file OgreShaderFunctionAtom.h.

OpSemantic Ogre::RTShader::Operand::getSemantic ( ) const

Returns the operand semantic (do we read/write or both with the parameter).

Definition at line 131 of file OgreShaderFunctionAtom.h.