Uniform parameter class. More...

#include <OgreShaderParameter.h>

Inheritance diagram for Ogre::RTShader::UniformParameter:

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
	UniformParameter (GpuConstantType type, const String &name, const Semantic &semantic, int index, const Content &content, uint16 variability, size_t size)
	Class constructor. More...

	UniformParameter (GpuProgramParameters::AutoConstantType autoType, Real fAutoConstantData, size_t size)
	Class constructor. More...

	UniformParameter (GpuProgramParameters::AutoConstantType autoType, Real fAutoConstantData, size_t size, GpuConstantType type)
	Class constructor. More...

	UniformParameter (GpuProgramParameters::AutoConstantType autoType, size_t nAutoConstantData, size_t size)
	Class constructor. More...

	UniformParameter (GpuProgramParameters::AutoConstantType autoType, size_t nAutoConstantData, size_t size, GpuConstantType type)
	Class constructor. More...

void	bind (GpuProgramParametersSharedPtr paramsPtr)
	Bind this parameter to the corresponding GPU parameter. More...

size_t	getAutoConstantIntData () const
	Get auto constant int data of this parameter, in case it is auto constant parameter. More...

Real	getAutoConstantRealData () const
	Get auto constant real data of this parameter, in case it is auto constant parameter. More...

GpuProgramParameters::AutoConstantType	getAutoConstantType () const
	Return the auto constant type of this parameter. More...

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

uint16	getVariability () const
	Return the variability of this parameter. More...

bool	isArray () const
	Returns Whether this parameter is an array. More...

bool	isAutoConstantIntParameter () const
	Return true if this parameter an auto constant with int data type, false otherwise. More...

bool	isAutoConstantParameter () const
	Return true if this parameter is an auto constant parameter, false otherwise. More...

bool	isAutoConstantRealParameter () const
	Return true if this parameter an auto constant with real data type, false otherwise. More...

virtual bool	isConstParameter () const
	Returns true if this instance is a ConstParameter otherwise false. More...

bool	isFloat () const
	Return true if this parameter is a floating point type, false otherwise. More...

bool	isSampler () const
	Return true if this parameter is a texture sampler type, false otherwise. More...

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	setGpuParameter (int val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (Real val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const ColourValue &val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const Vector2 &val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const Vector3 &val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const Vector4 &val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const Matrix4 &val)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const float *val, size_t count, size_t multiple=4)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const double *val, size_t count, size_t multiple=4)
	Update the GPU parameter with the given value. More...

void	setGpuParameter (const int *val, size_t count, size_t multiple=4)
	Update the GPU parameter with the given value. More...

void	setSize (size_t size)
	Sets the number of elements in the parameter (for arrays). More...

virtual String	toString () const
	Returns the string representation of this parameter. More...

Protected Attributes
union {
size_t mAutoConstantIntData

Real mAutoConstantRealData

};

GpuProgramParameters::AutoConstantType	mAutoConstantType

Content	mContent

int	mIndex

bool	mIsAutoConstantInt

bool	mIsAutoConstantReal

String	mName

GpuProgramParameters *	mParamsPtr

size_t	mPhysicalIndex

Semantic	mSemantic

size_t	mSize

GpuConstantType	mType

uint16	mVariability

Detailed Description

Uniform parameter class.

Allow fast access to GPU parameter updates.

Definition at line 376 of file OgreShaderParameter.h.

Constructor & Destructor Documentation

Ogre::RTShader::UniformParameter::UniformParameter	(	GpuConstantType	type,
		const String &	name,
		const Semantic &	semantic,
		int	index,
		const Content &	content,
		uint16	variability,
		size_t	size
	)

Class constructor.

Parameters

type	The type of this parameter.
name	The name of this parameter.
semantic	The semantic of this parameter.
index	The index of this parameter.
content	The content of this parameter.
variability	How this parameter varies (bitwise combination of GpuProgramVariability).
size	number of elements in the parameter.

Ogre::RTShader::UniformParameter::UniformParameter	(	GpuProgramParameters::AutoConstantType	autoType,
		Real	fAutoConstantData,
		size_t	size
	)

Class constructor.

Parameters

autoType	The auto type of this parameter.
fAutoConstantData	The real data for this auto constant parameter.
size	number of elements in the parameter.

Ogre::RTShader::UniformParameter::UniformParameter	(	GpuProgramParameters::AutoConstantType	autoType,
		Real	fAutoConstantData,
		size_t	size,
		GpuConstantType	type
	)

Class constructor.

Parameters

autoType	The auto type of this parameter.
fAutoConstantData	The real data for this auto constant parameter.
size	number of elements in the parameter.
type	The desired data type of this auto constant parameter.

Ogre::RTShader::UniformParameter::UniformParameter	(	GpuProgramParameters::AutoConstantType	autoType,
		size_t	nAutoConstantData,
		size_t	size
	)

Class constructor.

Parameters

autoType	The auto type of this parameter.
nAutoConstantData	The int data for this auto constant parameter.
size	number of elements in the parameter.

Ogre::RTShader::UniformParameter::UniformParameter	(	GpuProgramParameters::AutoConstantType	autoType,
		size_t	nAutoConstantData,
		size_t	size,
		GpuConstantType	type
	)

Class constructor.

Parameters

autoType	The auto type of this parameter.
nAutoConstantData	The int data for this auto constant parameter.
size	number of elements in the parameter.
type	The desired data type of this auto constant parameter.

Member Function Documentation

void Ogre::RTShader::UniformParameter::bind ( GpuProgramParametersSharedPtr paramsPtr )

Bind this parameter to the corresponding GPU parameter.

size_t Ogre::RTShader::UniformParameter::getAutoConstantIntData ( ) const

Get auto constant int data of this parameter, in case it is auto constant parameter.

Definition at line 426 of file OgreShaderParameter.h.

Real Ogre::RTShader::UniformParameter::getAutoConstantRealData ( ) const

Get auto constant real data of this parameter, in case it is auto constant parameter.

Definition at line 429 of file OgreShaderParameter.h.

GpuProgramParameters::AutoConstantType Ogre::RTShader::UniformParameter::getAutoConstantType ( ) const

Return the auto constant type of this parameter.

Definition at line 447 of file OgreShaderParameter.h.

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.

uint16 Ogre::RTShader::UniformParameter::getVariability ( ) const

Return the variability of this parameter.

Definition at line 450 of file OgreShaderParameter.h.

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

inherited

Returns Whether this parameter is an array.

Definition at line 344 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::isAutoConstantIntParameter ( ) const

Return true if this parameter an auto constant with int data type, false otherwise.

Definition at line 441 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::isAutoConstantParameter ( ) const

Return true if this parameter is an auto constant parameter, false otherwise.

Definition at line 438 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::isAutoConstantRealParameter ( ) const

Return true if this parameter an auto constant with real data type, false otherwise.

Definition at line 444 of file OgreShaderParameter.h.

virtual bool Ogre::RTShader::Parameter::isConstParameter ( ) const

virtualinherited

Returns true if this instance is a ConstParameter otherwise false.

Reimplemented in Ogre::RTShader::ConstParameter< valueType >.

Definition at line 338 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::isFloat ( ) const

Return true if this parameter is a floating point type, false otherwise.

bool Ogre::RTShader::UniformParameter::isSampler ( ) const

Return true if this parameter is a texture sampler type, false otherwise.

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::UniformParameter::setGpuParameter ( int val )