Ogre::RTShader::ConstParameter< valueType > Class Template Reference

Helper template which is the base for our ConstParameters. More...

#include <OgreShaderParameter.h>

Inheritance diagram for Ogre::RTShader::ConstParameter< valueType >:

Public Types
enum	Content {   SPC_UNKNOWN, SPC_POSITION_OBJECT_SPACE, SPC_POSITION_WORLD_SPACE, SPC_POSITION_VIEW_SPACE,   SPC_POSITION_PROJECTIVE_SPACE, SPC_POSITION_LIGHT_SPACE0, SPC_POSITION_LIGHT_SPACE1, SPC_POSITION_LIGHT_SPACE2,   SPC_POSITION_LIGHT_SPACE3, SPC_POSITION_LIGHT_SPACE4, SPC_POSITION_LIGHT_SPACE5, SPC_POSITION_LIGHT_SPACE6,   SPC_POSITION_LIGHT_SPACE7, SPC_NORMAL_OBJECT_SPACE, SPC_NORMAL_WORLD_SPACE, SPC_NORMAL_VIEW_SPACE,   SPC_NORMAL_TANGENT_SPACE, SPC_POSTOCAMERA_OBJECT_SPACE, SPC_POSTOCAMERA_WORLD_SPACE, SPC_POSTOCAMERA_VIEW_SPACE,   SPC_POSTOCAMERA_TANGENT_SPACE, SPC_POSTOLIGHT_OBJECT_SPACE0, SPC_POSTOLIGHT_OBJECT_SPACE1, SPC_POSTOLIGHT_OBJECT_SPACE2,   SPC_POSTOLIGHT_OBJECT_SPACE3, SPC_POSTOLIGHT_OBJECT_SPACE4, SPC_POSTOLIGHT_OBJECT_SPACE5, SPC_POSTOLIGHT_OBJECT_SPACE6,   SPC_POSTOLIGHT_OBJECT_SPACE7, SPC_POSTOLIGHT_WORLD_SPACE0, SPC_POSTOLIGHT_WORLD_SPACE1, SPC_POSTOLIGHT_WORLD_SPACE2,   SPC_POSTOLIGHT_WORLD_SPACE3, SPC_POSTOLIGHT_WORLD_SPACE4, SPC_POSTOLIGHT_WORLD_SPACE5, SPC_POSTOLIGHT_WORLD_SPACE6,   SPC_POSTOLIGHT_WORLD_SPACE7, SPC_POSTOLIGHT_VIEW_SPACE0, SPC_POSTOLIGHT_VIEW_SPACE1, SPC_POSTOLIGHT_VIEW_SPACE2,   SPC_POSTOLIGHT_VIEW_SPACE3, SPC_POSTOLIGHT_VIEW_SPACE4, SPC_POSTOLIGHT_VIEW_SPACE5, SPC_POSTOLIGHT_VIEW_SPACE6,   SPC_POSTOLIGHT_VIEW_SPACE7, SPC_POSTOLIGHT_TANGENT_SPACE0, SPC_POSTOLIGHT_TANGENT_SPACE1, SPC_POSTOLIGHT_TANGENT_SPACE2,   SPC_POSTOLIGHT_TANGENT_SPACE3, SPC_POSTOLIGHT_TANGENT_SPACE4, SPC_POSTOLIGHT_TANGENT_SPACE5, SPC_POSTOLIGHT_TANGENT_SPACE6,   SPC_POSTOLIGHT_TANGENT_SPACE7, SPC_LIGHTDIRECTION_OBJECT_SPACE0, SPC_LIGHTDIRECTION_OBJECT_SPACE1, SPC_LIGHTDIRECTION_OBJECT_SPACE2,   SPC_LIGHTDIRECTION_OBJECT_SPACE3, SPC_LIGHTDIRECTION_OBJECT_SPACE4, SPC_LIGHTDIRECTION_OBJECT_SPACE5, SPC_LIGHTDIRECTION_OBJECT_SPACE6,   SPC_LIGHTDIRECTION_OBJECT_SPACE7, SPC_LIGHTDIRECTION_WORLD_SPACE0, SPC_LIGHTDIRECTION_WORLD_SPACE1, SPC_LIGHTDIRECTION_WORLD_SPACE2,   SPC_LIGHTDIRECTION_WORLD_SPACE3, SPC_LIGHTDIRECTION_WORLD_SPACE4, SPC_LIGHTDIRECTION_WORLD_SPACE5, SPC_LIGHTDIRECTION_WORLD_SPACE6,   SPC_LIGHTDIRECTION_WORLD_SPACE7, SPC_LIGHTDIRECTION_VIEW_SPACE0, SPC_LIGHTDIRECTION_VIEW_SPACE1, SPC_LIGHTDIRECTION_VIEW_SPACE2,   SPC_LIGHTDIRECTION_VIEW_SPACE3, SPC_LIGHTDIRECTION_VIEW_SPACE4, SPC_LIGHTDIRECTION_VIEW_SPACE5, SPC_LIGHTDIRECTION_VIEW_SPACE6,   SPC_LIGHTDIRECTION_VIEW_SPACE7, SPC_LIGHTDIRECTION_TANGENT_SPACE0, SPC_LIGHTDIRECTION_TANGENT_SPACE1, SPC_LIGHTDIRECTION_TANGENT_SPACE2,   SPC_LIGHTDIRECTION_TANGENT_SPACE3, SPC_LIGHTDIRECTION_TANGENT_SPACE4, SPC_LIGHTDIRECTION_TANGENT_SPACE5, SPC_LIGHTDIRECTION_TANGENT_SPACE6,   SPC_LIGHTDIRECTION_TANGENT_SPACE7, SPC_LIGHTPOSITION_OBJECT_SPACE0, SPC_LIGHTPOSITION_OBJECT_SPACE1, SPC_LIGHTPOSITION_OBJECT_SPACE2,   SPC_LIGHTPOSITION_OBJECT_SPACE3, SPC_LIGHTPOSITION_OBJECT_SPACE4, SPC_LIGHTPOSITION_OBJECT_SPACE5, SPC_LIGHTPOSITION_OBJECT_SPACE6,   SPC_LIGHTPOSITION_OBJECT_SPACE7, SPC_LIGHTPOSITION_WORLD_SPACE0, SPC_LIGHTPOSITION_WORLD_SPACE1, SPC_LIGHTPOSITION_WORLD_SPACE2,   SPC_LIGHTPOSITION_WORLD_SPACE3, SPC_LIGHTPOSITION_WORLD_SPACE4, SPC_LIGHTPOSITION_WORLD_SPACE5, SPC_LIGHTPOSITION_WORLD_SPACE6,   SPC_LIGHTPOSITION_WORLD_SPACE7, SPC_LIGHTPOSITIONVIEW_SPACE0, SPC_LIGHTPOSITIONVIEW_SPACE1, SPC_LIGHTPOSITIONVIEW_SPACE2,   SPC_LIGHTPOSITIONVIEW_SPACE3, SPC_LIGHTPOSITIONVIEW_SPACE4, SPC_LIGHTPOSITIONVIEW_SPACE5, SPC_LIGHTPOSITIONVIEW_SPACE6,   SPC_LIGHTPOSITIONVIEW_SPACE7, SPC_LIGHTPOSITION_TANGENT_SPACE, SPC_BLEND_WEIGHTS, SPC_BLEND_INDICES,   SPC_TANGENT_OBJECT_SPACE, SPC_TANGENT_WORLD_SPACE, SPC_TANGENT_VIEW_SPACE, SPC_TANGENT_TANGENT_SPACE,   SPC_BINORMAL_OBJECT_SPACE, SPC_BINORMAL_WORLD_SPACE, SPC_BINORMAL_VIEW_SPACE, SPC_BINORMAL_TANGENT_SPACE,   SPC_COLOR_DIFFUSE, SPC_COLOR_SPECULAR, SPC_DEPTH_OBJECT_SPACE, SPC_DEPTH_WORLD_SPACE,   SPC_DEPTH_VIEW_SPACE, SPC_DEPTH_PROJECTIVE_SPACE, SPC_TEXTURE_COORDINATE0, SPC_TEXTURE_COORDINATE1,   SPC_TEXTURE_COORDINATE2, SPC_TEXTURE_COORDINATE3, SPC_TEXTURE_COORDINATE4, SPC_TEXTURE_COORDINATE5,   SPC_TEXTURE_COORDINATE6, SPC_TEXTURE_COORDINATE7, SPC_CUSTOM_CONTENT_BEGIN = 1000, SPC_CUSTOM_CONTENT_END = 2000 }
enum	Semantic {   SPS_UNKNOWN = 0, SPS_POSITION = 1, SPS_BLEND_WEIGHTS = 2, SPS_BLEND_INDICES = 3,   SPS_NORMAL = 4, SPS_COLOR = 5, SPS_TEXTURE_COORDINATES = 7, SPS_BINORMAL = 8,   SPS_TANGENT = 9 }

Public Member Functions
	ConstParameter (valueType val, GpuConstantType type, const Semantic &semantic, const Content &content)
virtual	~ConstParameter ()
Content	getContent () const
	Return the content of this parameter. More...
int	getIndex () const
	Get the index of this parameter. More...
const String &	getName () const
	Get the name of this parameter. More...
const Semantic &	getSemantic () const
	Get the semantic of this parameter. More...
size_t	getSize () const
	Returns the number of elements in the parameter (for arrays). More...
GpuConstantType	getType () const
	Get the type of this parameter. More...
const valueType &	getValue () const
	Returns the native value of this parameter. More...
bool	isArray () const
	Returns Whether this parameter is an array. More...
virtual bool	isConstParameter () const
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 *)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void *	operator new[] (size_t sz)
void	setSize (size_t size)
	Sets the number of elements in the parameter (for arrays). More...
virtual String	toString () const =0

Protected Attributes
Content	mContent
int	mIndex
String	mName
Semantic	mSemantic
size_t	mSize
GpuConstantType	mType
valueType	mValue

Detailed Description

template<class valueType>
class Ogre::RTShader::ConstParameter< valueType >

Helper template which is the base for our ConstParameters.

Definition at line 576 of file OgreShaderParameter.h.

Constructor & Destructor Documentation

template<class valueType >

Ogre::RTShader::ConstParameter< valueType >::ConstParameter	(	valueType	val,
		GpuConstantType	type,
		const Semantic &	semantic,
		const Content &	content
	)

Definition at line 580 of file OgreShaderParameter.h.

References Ogre::RTShader::ConstParameter< valueType >::mValue.

template<class valueType >

virtual Ogre::RTShader::ConstParameter< valueType >::~ConstParameter ( )

virtual

Definition at line 589 of file OgreShaderParameter.h.

Member Function Documentation

Content Ogre::RTShader::Parameter::getContent ( ) const

inherited

Return the content of this parameter.

Definition at line 335 of file OgreShaderParameter.h.

int Ogre::RTShader::Parameter::getIndex ( ) const

inherited

Get the index of this parameter.

Definition at line 332 of file OgreShaderParameter.h.

const String& Ogre::RTShader::Parameter::getName ( void  ) const

inherited

Get the name of this parameter.

Definition at line 323 of file OgreShaderParameter.h.

const Semantic& Ogre::RTShader::Parameter::getSemantic ( ) const

inherited

Get the semantic of this parameter.

Definition at line 329 of file OgreShaderParameter.h.

size_t Ogre::RTShader::Parameter::getSize ( ) const

inherited

Returns the number of elements in the parameter (for arrays).

Definition at line 347 of file OgreShaderParameter.h.

GpuConstantType Ogre::RTShader::Parameter::getType ( void  ) const

inherited

Get the type of this parameter.

Definition at line 326 of file OgreShaderParameter.h.

template<class valueType >

const valueType& Ogre::RTShader::ConstParameter< valueType >::getValue

(

void

)

const

Returns the native value of this parameter.

(for example a Vector3)

Definition at line 592 of file OgreShaderParameter.h.

References Ogre::RTShader::ConstParameter< valueType >::mValue.

bool Ogre::RTShader::Parameter::isArray ( ) const

inherited

Returns Whether this parameter is an array.

Definition at line 344 of file OgreShaderParameter.h.

template<class valueType >

virtual bool Ogre::RTShader::ConstParameter< valueType >::isConstParameter ( ) const

virtual

See also

Parameter::isConstParameter.

Reimplemented from Ogre::RTShader::Parameter.

Definition at line 597 of file OgreShaderParameter.h.

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::RTShader::Parameter::setSize ( size_t  size )

inherited

Sets the number of elements in the parameter (for arrays).

Definition at line 350 of file OgreShaderParameter.h.

template<class valueType >

virtual String Ogre::RTShader::ConstParameter< valueType >::toString ( ) const

pure virtual

See also

Parameter::toString.

Reimplemented from Ogre::RTShader::Parameter.

Member Data Documentation

Content Ogre::RTShader::Parameter::mContent

protectedinherited

Definition at line 363 of file OgreShaderParameter.h.

int Ogre::RTShader::Parameter::mIndex

protectedinherited

Definition at line 361 of file OgreShaderParameter.h.

String Ogre::RTShader::Parameter::mName

protectedinherited

Definition at line 355 of file OgreShaderParameter.h.

Semantic Ogre::RTShader::Parameter::mSemantic

protectedinherited

Definition at line 359 of file OgreShaderParameter.h.

size_t Ogre::RTShader::Parameter::mSize

protectedinherited

Definition at line 365 of file OgreShaderParameter.h.

GpuConstantType Ogre::RTShader::Parameter::mType

protectedinherited

Definition at line 357 of file OgreShaderParameter.h.

template<class valueType >

valueType Ogre::RTShader::ConstParameter< valueType >::mValue

protected

Definition at line 605 of file OgreShaderParameter.h.

Referenced by Ogre::RTShader::ConstParameter< valueType >::ConstParameter(), and Ogre::RTShader::ConstParameter< valueType >::getValue().

---

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

• OgreShaderParameter.h