OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RTShader::UniformParameter Class Reference

Uniform parameter class. More...

#include <OgreShaderParameter.h>

+ Inheritance diagram for Ogre::RTShader::UniformParameter:
+ Collaboration 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 StringgetName () const
 Get the name of this parameter. More...
 
const SemanticgetSemantic () 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
 
GpuProgramParametersmParamsPtr
 
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 372 of file OgreShaderParameter.h.

Member Enumeration Documentation

Enumerator
SPC_UNKNOWN 

Unknown content.

SPC_POSITION_OBJECT_SPACE 

Position in object space.

SPC_POSITION_WORLD_SPACE 

Position in world space.

SPC_POSITION_VIEW_SPACE 

Position in view space.

SPC_POSITION_PROJECTIVE_SPACE 

Position in projective space.

SPC_POSITION_LIGHT_SPACE0 

Position in light space index 0-7.

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 

Normal in object space.

SPC_NORMAL_WORLD_SPACE 

Normal in world space.

SPC_NORMAL_VIEW_SPACE 

Normal in view space.

SPC_NORMAL_TANGENT_SPACE 

Normal in tangent space.

SPC_POSTOCAMERA_OBJECT_SPACE 

View vector in object space.

SPC_POSTOCAMERA_WORLD_SPACE 

View vector in world space.

SPC_POSTOCAMERA_VIEW_SPACE 

View vector in view space.

SPC_POSTOCAMERA_TANGENT_SPACE 

View vector in tangent space.

SPC_POSTOLIGHT_OBJECT_SPACE0 

Light vector in object space index 0-7.

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 

Light vector in world space index 0-7.

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 

Light vector in view space index 0-7.

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 

Light vector in tangent space index 0-7.

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 

Light direction in object space index 0-7.

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 

Light direction in world space index 0-7.

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 

Light direction in view space index 0-7.

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 

Light direction in tangent space index 0-7.

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 

Light position in object space index 0-7.

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 

Light position in world space index 0-7.

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 

Light position in view space index 0-7.

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 

Light position in tangent space index 0-7.

SPC_BLEND_WEIGHTS 

Blending weights.

SPC_BLEND_INDICES 

Blending indices.

SPC_TANGENT_OBJECT_SPACE 

Tangent in object space.

SPC_TANGENT_WORLD_SPACE 

Tangent in world space.

SPC_TANGENT_VIEW_SPACE 

Tangent in view space.

SPC_TANGENT_TANGENT_SPACE 

Tangent in tangent space.

SPC_BINORMAL_OBJECT_SPACE 

Binormal in object space.

SPC_BINORMAL_WORLD_SPACE 

Binormal in world space.

SPC_BINORMAL_VIEW_SPACE 

Binormal in view space.

SPC_BINORMAL_TANGENT_SPACE 

Binormal in tangent space.

SPC_COLOR_DIFFUSE 

Diffuse color.

SPC_COLOR_SPECULAR 

Specular color.

SPC_DEPTH_OBJECT_SPACE 

Depth in object space.

SPC_DEPTH_WORLD_SPACE 

Depth in world space.

SPC_DEPTH_VIEW_SPACE 

Depth in view space.

SPC_DEPTH_PROJECTIVE_SPACE 

Depth in projective space.

SPC_TEXTURE_COORDINATE0 

Texture coordinate set index 0-7.

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 

Reserved custom content range to be used by user custom shader extensions.

SPC_CUSTOM_CONTENT_END 

Definition at line 74 of file OgreShaderParameter.h.

Enumerator
SPS_UNKNOWN 

Unknown semantic.

SPS_POSITION 

Position.

SPS_BLEND_WEIGHTS 

Blending weights.

SPS_BLEND_INDICES 

Blending indices.

SPS_NORMAL 

Normal, 3 reals per vertex.

SPS_COLOR 

General floating point color.

SPS_TEXTURE_COORDINATES 

Texture coordinates.

SPS_BINORMAL 

Binormal (Y axis if normal is Z)

SPS_TANGENT 

Tangent (X axis if normal is Z)

Definition at line 51 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
typeThe type of this parameter.
nameThe name of this parameter.
semanticThe semantic of this parameter.
indexThe index of this parameter.
contentThe content of this parameter.
variabilityHow this parameter varies (bitwise combination of GpuProgramVariability).
sizenumber of elements in the parameter.
Ogre::RTShader::UniformParameter::UniformParameter ( GpuProgramParameters::AutoConstantType  autoType,
Real  fAutoConstantData,
size_t  size 
)

Class constructor.

Parameters
autoTypeThe auto type of this parameter.
fAutoConstantDataThe real data for this auto constant parameter.
sizenumber of elements in the parameter.
Ogre::RTShader::UniformParameter::UniformParameter ( GpuProgramParameters::AutoConstantType  autoType,
Real  fAutoConstantData,
size_t  size,
GpuConstantType  type 
)

Class constructor.

Parameters
autoTypeThe auto type of this parameter.
fAutoConstantDataThe real data for this auto constant parameter.
sizenumber of elements in the parameter.
typeThe desired data type of this auto constant parameter.
Ogre::RTShader::UniformParameter::UniformParameter ( GpuProgramParameters::AutoConstantType  autoType,
size_t  nAutoConstantData,
size_t  size 
)

Class constructor.

Parameters
autoTypeThe auto type of this parameter.
nAutoConstantDataThe int data for this auto constant parameter.
sizenumber of elements in the parameter.
Ogre::RTShader::UniformParameter::UniformParameter ( GpuProgramParameters::AutoConstantType  autoType,
size_t  nAutoConstantData,
size_t  size,
GpuConstantType  type 
)

Class constructor.

Parameters
autoTypeThe auto type of this parameter.
nAutoConstantDataThe int data for this auto constant parameter.
sizenumber of elements in the parameter.
typeThe 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
inline

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

Definition at line 422 of file OgreShaderParameter.h.

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

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

Definition at line 425 of file OgreShaderParameter.h.

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

Return the auto constant type of this parameter.

Definition at line 443 of file OgreShaderParameter.h.

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

Return the content of this parameter.

Definition at line 333 of file OgreShaderParameter.h.

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

Get the index of this parameter.

Definition at line 330 of file OgreShaderParameter.h.

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

Get the name of this parameter.

Definition at line 321 of file OgreShaderParameter.h.

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

Get the semantic of this parameter.

Definition at line 327 of file OgreShaderParameter.h.

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

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

Definition at line 345 of file OgreShaderParameter.h.

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

Get the type of this parameter.

Definition at line 324 of file OgreShaderParameter.h.

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

Return the variability of this parameter.

Definition at line 446 of file OgreShaderParameter.h.

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

Returns Whether this parameter is an array.

Definition at line 342 of file OgreShaderParameter.h.

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

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

Definition at line 437 of file OgreShaderParameter.h.

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

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

Definition at line 434 of file OgreShaderParameter.h.

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

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

Definition at line 440 of file OgreShaderParameter.h.

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

Returns true if this instance is a ConstParameter otherwise false.

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

Definition at line 336 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)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( int  val)
inline

Update the GPU parameter with the given value.

Definition at line 454 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( Real  val)
inline

Update the GPU parameter with the given value.

Definition at line 463 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const ColourValue val)
inline

Update the GPU parameter with the given value.

Definition at line 472 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const Vector2 val)
inline

Update the GPU parameter with the given value.

Definition at line 481 of file OgreShaderParameter.h.

References Ogre::Vector2::ptr().

void Ogre::RTShader::UniformParameter::setGpuParameter ( const Vector3 val)
inline

Update the GPU parameter with the given value.

Definition at line 490 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const Vector4 val)
inline

Update the GPU parameter with the given value.

Definition at line 499 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const Matrix4 val)
inline

Update the GPU parameter with the given value.

Definition at line 508 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const float *  val,
size_t  count,
size_t  multiple = 4 
)
inline

Update the GPU parameter with the given value.

Definition at line 517 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const double *  val,
size_t  count,
size_t  multiple = 4 
)
inline

Update the GPU parameter with the given value.

Definition at line 526 of file OgreShaderParameter.h.

void Ogre::RTShader::UniformParameter::setGpuParameter ( const int *  val,
size_t  count,
size_t  multiple = 4 
)
inline

Update the GPU parameter with the given value.

Definition at line 535 of file OgreShaderParameter.h.

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

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

Definition at line 348 of file OgreShaderParameter.h.

virtual String Ogre::RTShader::Parameter::toString ( ) const
inlinevirtualinherited

Returns the string representation of this parameter.

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

Definition at line 339 of file OgreShaderParameter.h.

Member Data Documentation

union { ... }
size_t Ogre::RTShader::UniformParameter::mAutoConstantIntData

Definition at line 552 of file OgreShaderParameter.h.

Real Ogre::RTShader::UniformParameter::mAutoConstantRealData

Definition at line 554 of file OgreShaderParameter.h.

GpuProgramParameters::AutoConstantType Ogre::RTShader::UniformParameter::mAutoConstantType
protected

Definition at line 548 of file OgreShaderParameter.h.

Content Ogre::RTShader::Parameter::mContent
protectedinherited

Definition at line 361 of file OgreShaderParameter.h.

int Ogre::RTShader::Parameter::mIndex
protectedinherited

Definition at line 359 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::mIsAutoConstantInt
protected

Definition at line 547 of file OgreShaderParameter.h.

bool Ogre::RTShader::UniformParameter::mIsAutoConstantReal
protected

Definition at line 545 of file OgreShaderParameter.h.

String Ogre::RTShader::Parameter::mName
protectedinherited

Definition at line 353 of file OgreShaderParameter.h.

GpuProgramParameters* Ogre::RTShader::UniformParameter::mParamsPtr
protected

Definition at line 559 of file OgreShaderParameter.h.

size_t Ogre::RTShader::UniformParameter::mPhysicalIndex
protected

Definition at line 561 of file OgreShaderParameter.h.

Semantic Ogre::RTShader::Parameter::mSemantic
protectedinherited

Definition at line 357 of file OgreShaderParameter.h.

size_t Ogre::RTShader::Parameter::mSize
protectedinherited

Definition at line 363 of file OgreShaderParameter.h.

GpuConstantType Ogre::RTShader::Parameter::mType
protectedinherited

Definition at line 355 of file OgreShaderParameter.h.

uint16 Ogre::RTShader::UniformParameter::mVariability
protected

Definition at line 557 of file OgreShaderParameter.h.


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