Ogre::RTShader::Operand Class Reference

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:

Public Types
enum	OpMask {   OPM_ALL = 0x0001 , OPM_X = 0x0002 , OPM_Y = 0x0004 , OPM_Z = 0x0008 ,   OPM_W = 0x0010 , OPM_XY = OPM_X | OPM_Y , OPM_XZ = OPM_X | OPM_Z , OPM_XW = OPM_X | OPM_W ,   OPM_YZ = OPM_Y | OPM_Z , OPM_YW = OPM_Y | OPM_W , OPM_ZW = OPM_Z | OPM_W , OPM_XYZ = OPM_X | OPM_Y | OPM_Z ,   OPM_XYW = OPM_X | OPM_Y | OPM_W , OPM_XZW = OPM_X | OPM_Z | OPM_W , OPM_YZW = OPM_Y | OPM_Z | OPM_W , OPM_XYZW = OPM_X | OPM_Y | OPM_Z | OPM_W }
enum	OpSemantic { OPS_IN , OPS_OUT , OPS_INOUT }

Public Member Functions
	Operand (const Operand &rhs)
	Copy constructor.
	Operand (ParameterPtr parameter, Operand::OpSemantic opSemantic, int opMask=Operand::OPM_ALL, ushort indirectionLevel=0)
	Class constructor.
	~Operand ()
	Class destructor.
ushort	getIndirectionLevel () const
	Returns the level of indirection.
int	getMask () const
	Returns the mask bitfield.
const ParameterPtr &	getParameter () const
	Returns the parameter object as weak reference.
OpSemantic	getSemantic () const
	Returns the operand semantic (do we read/write or both with the parameter).
bool	hasFreeFields () const
	Returns true if not all fields used.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
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 *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
Operand &	operator= (const Operand &rhs)
	Copy the given Operand to this Operand.
String	toString () const
	Returns the parameter name and the usage mask like this 'color.xyz'.

Static Public Member Functions
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.
static String	getMaskAsString (int mask)
	Returns the given mask as string representation.

Detailed Description

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

Member Enumeration Documentation

OpMask

enum Ogre::RTShader::Operand::OpMask

Enumerator
OPM_ALL
OPM_X
OPM_Y
OPM_Z
OPM_W
OPM_XY
OPM_XZ
OPM_XW
OPM_YZ
OPM_YW
OPM_ZW
OPM_XYZ
OPM_XYW
OPM_XZW
OPM_YZW
OPM_XYZW

OpSemantic

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.

Constructor & Destructor Documentation

Operand() [1/2]

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.

Operand() [2/2]

Ogre::RTShader::Operand::Operand

(

const Operand &

rhs

)

Copy constructor.

~Operand()

Ogre::RTShader::Operand::~Operand

(

)

Class destructor.

Member Function Documentation

getFloatCount()

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

static

Return the float count of the given mask.

getGpuConstantType()

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

static

Return the gpu constant type of the given mask.

getIndirectionLevel()

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

inline

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]].

getMask()

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

inline

Returns the mask bitfield.

getMaskAsString()

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

static

Returns the given mask as string representation.

getParameter()

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

inline

Returns the parameter object as weak reference.

getSemantic()

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

inline

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

hasFreeFields()

bool Ogre::RTShader::Operand::hasFreeFields ( ) const

inline

Returns true if not all fields used.

(usage is described through semantic)

operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator new() [1/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inlineinherited

operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

operator new, with debug line info

operator new() [3/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inlineinherited

operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

array operator new, with debug line info

operator=()

Operand & Ogre::RTShader::Operand::operator=

(

const Operand &

rhs

)

Copy the given Operand to this Operand.

Parameters

rhs	The other Operand to copy to this state.

toString()

String Ogre::RTShader::Operand::toString

(

)

const

Returns the parameter name and the usage mask like this 'color.xyz'.

---

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

• OgreShaderFunctionAtom.h