OGRE: Ogre::GpuProgramParameters Class Reference

enum Ogre::GpuProgramParameters::AutoConstantType

Defines the types of automatically updated values that may be bound to GpuProgram parameters, or used to modify parameters on a per-object basis.

Enumerator:

ACT_WORLD_MATRIX	The current world matrix.
ACT_INVERSE_WORLD_MATRIX	The current world matrix, inverted.
ACT_TRANSPOSE_WORLD_MATRIX	Provides transpose of world matrix. Equivalent to RenderMonkey's "WorldTranspose".
ACT_INVERSE_TRANSPOSE_WORLD_MATRIX	The current world matrix, inverted & transposed.
ACT_WORLD_MATRIX_ARRAY_3x4	The current array of world matrices, as a 3x4 matrix, used for blending.
ACT_WORLD_MATRIX_ARRAY	The current array of world matrices, used for blending.
ACT_VIEW_MATRIX	The current view matrix.
ACT_INVERSE_VIEW_MATRIX	The current view matrix, inverted.
ACT_TRANSPOSE_VIEW_MATRIX	Provides transpose of view matrix. Equivalent to RenderMonkey's "ViewTranspose".
ACT_INVERSE_TRANSPOSE_VIEW_MATRIX	Provides inverse transpose of view matrix. Equivalent to RenderMonkey's "ViewInverseTranspose".
ACT_PROJECTION_MATRIX	The current projection matrix.
ACT_INVERSE_PROJECTION_MATRIX	Provides inverse of projection matrix. Equivalent to RenderMonkey's "ProjectionInverse".
ACT_TRANSPOSE_PROJECTION_MATRIX	Provides transpose of projection matrix. Equivalent to RenderMonkey's "ProjectionTranspose".
ACT_INVERSE_TRANSPOSE_PROJECTION_MATRIX	Provides inverse transpose of projection matrix. Equivalent to RenderMonkey's "ProjectionInverseTranspose".
ACT_VIEWPROJ_MATRIX	The current view & projection matrices concatenated.
ACT_INVERSE_VIEWPROJ_MATRIX	Provides inverse of concatenated view and projection matrices. Equivalent to RenderMonkey's "ViewProjectionInverse".
ACT_TRANSPOSE_VIEWPROJ_MATRIX	Provides transpose of concatenated view and projection matrices. Equivalent to RenderMonkey's "ViewProjectionTranspose".
ACT_INVERSE_TRANSPOSE_VIEWPROJ_MATRIX	Provides inverse transpose of concatenated view and projection matrices. Equivalent to RenderMonkey's "ViewProjectionInverseTranspose".
ACT_WORLDVIEW_MATRIX	The current world & view matrices concatenated.
ACT_INVERSE_WORLDVIEW_MATRIX	The current world & view matrices concatenated, then inverted.
ACT_TRANSPOSE_WORLDVIEW_MATRIX	Provides transpose of concatenated world and view matrices. Equivalent to RenderMonkey's "WorldViewTranspose".
ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX	The current world & view matrices concatenated, then inverted & transposed.
ACT_WORLDVIEWPROJ_MATRIX	view matrices. The current world, view & projection matrices concatenated
ACT_INVERSE_WORLDVIEWPROJ_MATRIX	Provides inverse of concatenated world, view and projection matrices. Equivalent to RenderMonkey's "WorldViewProjectionInverse".
ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX	Provides transpose of concatenated world, view and projection matrices. Equivalent to RenderMonkey's "WorldViewProjectionTranspose".
ACT_INVERSE_TRANSPOSE_WORLDVIEWPROJ_MATRIX	Provides inverse transpose of concatenated world, view and projection matrices. Equivalent to RenderMonkey's "WorldViewProjectionInverseTranspose".
ACT_RENDER_TARGET_FLIPPING	render target related values -1 if requires texture flipping, +1 otherwise. It's useful when you bypassed projection matrix transform, still able use this value to adjust transformed y position.
ACT_FOG_COLOUR	Fog colour.
ACT_FOG_PARAMS	Fog params: density, linear start, linear end, 1/(end-start).
ACT_SURFACE_AMBIENT_COLOUR	Surface ambient colour, as set in Pass::setAmbient.
ACT_SURFACE_DIFFUSE_COLOUR	Surface diffuse colour, as set in Pass::setDiffuse.
ACT_SURFACE_SPECULAR_COLOUR	Surface specular colour, as set in Pass::setSpecular.
ACT_SURFACE_EMISSIVE_COLOUR	Surface emissive colour, as set in Pass::setSelfIllumination.
ACT_SURFACE_SHININESS	Surface shininess, as set in Pass::setShininess.
ACT_LIGHT_COUNT	The number of active light sources (better than gl_MaxLights).
ACT_AMBIENT_LIGHT_COLOUR	The ambient light colour set in the scene.
ACT_LIGHT_DIFFUSE_COLOUR	Light diffuse colour (index determined by setAutoConstant call).
ACT_LIGHT_SPECULAR_COLOUR	Light specular colour (index determined by setAutoConstant call).
ACT_LIGHT_ATTENUATION	Light attenuation parameters, Vector4(range, constant, linear, quadric).
ACT_SPOTLIGHT_PARAMS	Spotlight parameters, Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and outerFactor are cos(angle/2) The isSpot parameter is 0.0f for non-spotlights, 1.0f for spotlights. Also for non-spotlights the inner and outer factors are 1 and nearly 1 respectively
ACT_LIGHT_POSITION	A light position in world space (index determined by setAutoConstant call).
ACT_LIGHT_POSITION_OBJECT_SPACE	A light position in object space (index determined by setAutoConstant call).
ACT_LIGHT_POSITION_VIEW_SPACE	A light position in view space (index determined by setAutoConstant call).
ACT_LIGHT_DIRECTION	A light direction in world space (index determined by setAutoConstant call).
ACT_LIGHT_DIRECTION_OBJECT_SPACE	A light direction in object space (index determined by setAutoConstant call).
ACT_LIGHT_DIRECTION_VIEW_SPACE	A light direction in view space (index determined by setAutoConstant call).
ACT_LIGHT_DISTANCE_OBJECT_SPACE	The distance of the light from the center of the object a useful approximation as an alternative to per-vertex distance calculations.
ACT_LIGHT_POWER_SCALE	Light power level, a single scalar as set in Light::setPowerScale (index determined by setAutoConstant call).
ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED	Light diffuse colour pre-scaled by Light::setPowerScale (index determined by setAutoConstant call).
ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED	Light specular colour pre-scaled by Light::setPowerScale (index determined by setAutoConstant call).
ACT_LIGHT_DIFFUSE_COLOUR_ARRAY	Array of light diffuse colours (count set by extra param).
ACT_LIGHT_SPECULAR_COLOUR_ARRAY	Array of light specular colours (count set by extra param).
ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED_ARRAY	Array of light diffuse colours scaled by light power (count set by extra param).
ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED_ARRAY	Array of light specular colours scaled by light power (count set by extra param).
ACT_LIGHT_ATTENUATION_ARRAY	Array of light attenuation parameters, Vector4(range, constant, linear, quadric) (count set by extra param).
ACT_LIGHT_POSITION_ARRAY	Array of light positions in world space (count set by extra param).
ACT_LIGHT_POSITION_OBJECT_SPACE_ARRAY	Array of light positions in object space (count set by extra param).
ACT_LIGHT_POSITION_VIEW_SPACE_ARRAY	Array of light positions in view space (count set by extra param).
ACT_LIGHT_DIRECTION_ARRAY	Array of light directions in world space (count set by extra param).
ACT_LIGHT_DIRECTION_OBJECT_SPACE_ARRAY	Array of light directions in object space (count set by extra param).
ACT_LIGHT_DIRECTION_VIEW_SPACE_ARRAY	Array of light directions in view space (count set by extra param).
ACT_LIGHT_DISTANCE_OBJECT_SPACE_ARRAY	Array of distances of the lights from the center of the object a useful approximation as an alternative to per-vertex distance calculations. (count set by extra param)
ACT_LIGHT_POWER_SCALE_ARRAY	Array of light power levels, a single scalar as set in Light::setPowerScale (count set by extra param).
ACT_SPOTLIGHT_PARAMS_ARRAY	Spotlight parameters array of Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and outerFactor are cos(angle/2) The isSpot parameter is 0.0f for non-spotlights, 1.0f for spotlights. Also for non-spotlights the inner and outer factors are 1 and nearly 1 respectively. (count set by extra param)
ACT_DERIVED_AMBIENT_LIGHT_COLOUR	The derived ambient light colour, with 'r', 'g', 'b' components filled with product of surface ambient colour and ambient light colour, respectively, and 'a' component filled with surface ambient alpha component.
ACT_DERIVED_SCENE_COLOUR	The derived scene colour, with 'r', 'g' and 'b' components filled with sum of derived ambient light colour and surface emissive colour, respectively, and 'a' component filled with surface diffuse alpha component.
ACT_DERIVED_LIGHT_DIFFUSE_COLOUR	The derived light diffuse colour (index determined by setAutoConstant call), with 'r', 'g' and 'b' components filled with product of surface diffuse colour, light power scale and light diffuse colour, respectively, and 'a' component filled with surface diffuse alpha component.
ACT_DERIVED_LIGHT_SPECULAR_COLOUR	The derived light specular colour (index determined by setAutoConstant call), with 'r', 'g' and 'b' components filled with product of surface specular colour and light specular colour, respectively, and 'a' component filled with surface specular alpha component.
ACT_DERIVED_LIGHT_DIFFUSE_COLOUR_ARRAY	Array of derived light diffuse colours (count set by extra param).
ACT_DERIVED_LIGHT_SPECULAR_COLOUR_ARRAY	Array of derived light specular colours (count set by extra param).
ACT_LIGHT_NUMBER	The absolute light number of a local light index. Each pass may have a number of lights passed to it, and each of these lights will have an index in the overall light list, which will differ from the local light index due to factors like setStartLight and setIteratePerLight. This binding provides the global light index for a local index.
ACT_LIGHT_CASTS_SHADOWS	Returns (int) 1 if the given light casts shadows, 0 otherwise (index set in extra param).
ACT_SHADOW_EXTRUSION_DISTANCE	The distance a shadow volume should be extruded when using finite extrusion programs.
ACT_CAMERA_POSITION	The current camera's position in world space.
ACT_CAMERA_POSITION_OBJECT_SPACE	The current camera's position in object space.
ACT_TEXTURE_VIEWPROJ_MATRIX	The view/projection matrix of the assigned texture projection frustum.
ACT_TEXTURE_VIEWPROJ_MATRIX_ARRAY	Array of view/projection matrices of the first n texture projection frustums.
ACT_TEXTURE_WORLDVIEWPROJ_MATRIX	The view/projection matrix of the assigned texture projection frustum, combined with the current world matrix.
ACT_TEXTURE_WORLDVIEWPROJ_MATRIX_ARRAY	Array of world/view/projection matrices of the first n texture projection frustums.
ACT_SPOTLIGHT_VIEWPROJ_MATRIX	The view/projection matrix of a given spotlight.
ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX	The view/projection matrix of a given spotlight projection frustum, combined with the current world matrix.
ACT_CUSTOM	A custom parameter which will come from the renderable, using 'data' as the identifier.
ACT_TIME	provides current elapsed time
ACT_TIME_0_X	Single float value, which repeats itself based on given as parameter "cycle time". Equivalent to RenderMonkey's "Time0_X".
ACT_COSTIME_0_X	Cosine of "Time0_X". Equivalent to RenderMonkey's "CosTime0_X".
ACT_SINTIME_0_X	Sine of "Time0_X". Equivalent to RenderMonkey's "SinTime0_X".
ACT_TANTIME_0_X	Tangent of "Time0_X". Equivalent to RenderMonkey's "TanTime0_X".
ACT_TIME_0_X_PACKED	Vector of "Time0_X", "SinTime0_X", "CosTime0_X", "TanTime0_X". Equivalent to RenderMonkey's "Time0_X_Packed".
ACT_TIME_0_1	Single float value, which represents scaled time value [0. .1], which repeats itself based on given as parameter "cycle time". Equivalent to RenderMonkey's "Time0_1".

Ogre::GpuProgramParameters Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Classes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation


Public Types
enum	AutoConstantType { ACT_WORLD_MATRIX, ACT_INVERSE_WORLD_MATRIX, ACT_TRANSPOSE_WORLD_MATRIX, ACT_INVERSE_TRANSPOSE_WORLD_MATRIX, ACT_WORLD_MATRIX_ARRAY_3x4, ACT_WORLD_MATRIX_ARRAY, ACT_VIEW_MATRIX, ACT_INVERSE_VIEW_MATRIX, ACT_TRANSPOSE_VIEW_MATRIX, ACT_INVERSE_TRANSPOSE_VIEW_MATRIX, ACT_PROJECTION_MATRIX, ACT_INVERSE_PROJECTION_MATRIX, ACT_TRANSPOSE_PROJECTION_MATRIX, ACT_INVERSE_TRANSPOSE_PROJECTION_MATRIX, ACT_VIEWPROJ_MATRIX, ACT_INVERSE_VIEWPROJ_MATRIX, ACT_TRANSPOSE_VIEWPROJ_MATRIX, ACT_INVERSE_TRANSPOSE_VIEWPROJ_MATRIX, ACT_WORLDVIEW_MATRIX, ACT_INVERSE_WORLDVIEW_MATRIX, ACT_TRANSPOSE_WORLDVIEW_MATRIX, ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX, ACT_WORLDVIEWPROJ_MATRIX, ACT_INVERSE_WORLDVIEWPROJ_MATRIX, ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX, ACT_INVERSE_TRANSPOSE_WORLDVIEWPROJ_MATRIX, ACT_RENDER_TARGET_FLIPPING, ACT_FOG_COLOUR, ACT_FOG_PARAMS, ACT_SURFACE_AMBIENT_COLOUR, ACT_SURFACE_DIFFUSE_COLOUR, ACT_SURFACE_SPECULAR_COLOUR, ACT_SURFACE_EMISSIVE_COLOUR, ACT_SURFACE_SHININESS, ACT_LIGHT_COUNT, ACT_AMBIENT_LIGHT_COLOUR, ACT_LIGHT_DIFFUSE_COLOUR, ACT_LIGHT_SPECULAR_COLOUR, ACT_LIGHT_ATTENUATION, ACT_SPOTLIGHT_PARAMS, ACT_LIGHT_POSITION, ACT_LIGHT_POSITION_OBJECT_SPACE, ACT_LIGHT_POSITION_VIEW_SPACE, ACT_LIGHT_DIRECTION, ACT_LIGHT_DIRECTION_OBJECT_SPACE, ACT_LIGHT_DIRECTION_VIEW_SPACE, ACT_LIGHT_DISTANCE_OBJECT_SPACE, ACT_LIGHT_POWER_SCALE, ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED, ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED, ACT_LIGHT_DIFFUSE_COLOUR_ARRAY, ACT_LIGHT_SPECULAR_COLOUR_ARRAY, ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED_ARRAY, ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED_ARRAY, ACT_LIGHT_ATTENUATION_ARRAY, ACT_LIGHT_POSITION_ARRAY, ACT_LIGHT_POSITION_OBJECT_SPACE_ARRAY, ACT_LIGHT_POSITION_VIEW_SPACE_ARRAY, ACT_LIGHT_DIRECTION_ARRAY, ACT_LIGHT_DIRECTION_OBJECT_SPACE_ARRAY, ACT_LIGHT_DIRECTION_VIEW_SPACE_ARRAY, ACT_LIGHT_DISTANCE_OBJECT_SPACE_ARRAY, ACT_LIGHT_POWER_SCALE_ARRAY, ACT_SPOTLIGHT_PARAMS_ARRAY, ACT_DERIVED_AMBIENT_LIGHT_COLOUR, ACT_DERIVED_SCENE_COLOUR, ACT_DERIVED_LIGHT_DIFFUSE_COLOUR, ACT_DERIVED_LIGHT_SPECULAR_COLOUR, ACT_DERIVED_LIGHT_DIFFUSE_COLOUR_ARRAY, ACT_DERIVED_LIGHT_SPECULAR_COLOUR_ARRAY, ACT_LIGHT_NUMBER, ACT_LIGHT_CASTS_SHADOWS, ACT_SHADOW_EXTRUSION_DISTANCE, ACT_CAMERA_POSITION, ACT_CAMERA_POSITION_OBJECT_SPACE, ACT_TEXTURE_VIEWPROJ_MATRIX, ACT_TEXTURE_VIEWPROJ_MATRIX_ARRAY, ACT_TEXTURE_WORLDVIEWPROJ_MATRIX, ACT_TEXTURE_WORLDVIEWPROJ_MATRIX_ARRAY, ACT_SPOTLIGHT_VIEWPROJ_MATRIX, ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX, ACT_CUSTOM, ACT_TIME, ACT_TIME_0_X, ACT_COSTIME_0_X, ACT_SINTIME_0_X, ACT_TANTIME_0_X, ACT_TIME_0_X_PACKED, ACT_TIME_0_1, ACT_COSTIME_0_1, ACT_SINTIME_0_1, ACT_TANTIME_0_1, ACT_TIME_0_1_PACKED, ACT_TIME_0_2PI, ACT_COSTIME_0_2PI, ACT_SINTIME_0_2PI, ACT_TANTIME_0_2PI, ACT_TIME_0_2PI_PACKED, ACT_FRAME_TIME, ACT_FPS, ACT_VIEWPORT_WIDTH, ACT_VIEWPORT_HEIGHT, ACT_INVERSE_VIEWPORT_WIDTH, ACT_INVERSE_VIEWPORT_HEIGHT, ACT_VIEWPORT_SIZE, ACT_VIEW_DIRECTION, ACT_VIEW_SIDE_VECTOR, ACT_VIEW_UP_VECTOR, ACT_FOV, ACT_NEAR_CLIP_DISTANCE, ACT_FAR_CLIP_DISTANCE, ACT_PASS_NUMBER, ACT_PASS_ITERATION_NUMBER, ACT_ANIMATION_PARAMETRIC, ACT_TEXEL_OFFSETS, ACT_SCENE_DEPTH_RANGE, ACT_SHADOW_SCENE_DEPTH_RANGE, ACT_SHADOW_COLOUR, ACT_TEXTURE_SIZE, ACT_INVERSE_TEXTURE_SIZE, ACT_PACKED_TEXTURE_SIZE, ACT_TEXTURE_MATRIX }
	Defines the types of automatically updated values that may be bound to GpuProgram parameters, or used to modify parameters on a per-object basis. More...
enum	ACDataType { ACDT_NONE, ACDT_INT, ACDT_REAL }
	Defines the type of the extra data item used by the auto constant. More...
enum	ElementType { ET_INT, ET_REAL }
	Defines the base element type of the auto constant. More...
typedef std::vector < AutoConstantEntry >	AutoConstantList
typedef std::vector < float >	FloatConstantList
	Definition of container that holds the current float constants.
typedef std::vector < int >	IntConstantList
	Definition of container that holds the current float constants.
typedef ConstVectorIterator < AutoConstantList >	AutoConstantIterator
Public Member Functions
	GpuProgramParameters ()
	~GpuProgramParameters ()
	GpuProgramParameters (const GpuProgramParameters &oth)
	Copy constructor.
GpuProgramParameters &	operator= (const GpuProgramParameters &oth)
	Operator = overload.
void	_setNamedConstants (const GpuNamedConstants *constantmap)
	Internal method for providing a link to a name->definition map for parameters.
void	_setLogicalIndexes (GpuLogicalBufferStruct floatIndexMap, GpuLogicalBufferStruct intIndexMap)
	Internal method for providing a link to a logical index->physical index map for parameters.
bool	hasNamedParameters () const
	Does this parameter set include named parameters?
bool	hasLogicalIndexedParameters () const
	Does this parameter set include logically indexed parameters?
void	setConstant (size_t index, const Vector4 &vec)
	Sets a 4-element floating-point parameter to the program.
void	setConstant (size_t index, Real val)
	Sets a single floating-point parameter to the program.
void	setConstant (size_t index, const Vector3 &vec)
	Sets a 4-element floating-point parameter to the program via Vector3.
void	setConstant (size_t index, const Matrix4 &m)
	Sets a Matrix4 parameter to the program.
void	setConstant (size_t index, const Matrix4 *m, size_t numEntries)
	Sets a list of Matrix4 parameters to the program.
void	setConstant (size_t index, const float *val, size_t count)
	Sets a multiple value constant floating-point parameter to the program.
void	setConstant (size_t index, const double *val, size_t count)
	Sets a multiple value constant floating-point parameter to the program.
void	setConstant (size_t index, const ColourValue &colour)
	Sets a ColourValue parameter to the program.
void	setConstant (size_t index, const int *val, size_t count)
	Sets a multiple value constant integer parameter to the program.
void	_writeRawConstants (size_t physicalIndex, const float *val, size_t count)
	Write a series of floating point values into the underlying float constant buffer at the given physical index.
void	_writeRawConstants (size_t physicalIndex, const double *val, size_t count)
	Write a series of floating point values into the underlying float constant buffer at the given physical index.
void	_writeRawConstants (size_t physicalIndex, const int *val, size_t count)
	Write a series of integer values into the underlying integer constant buffer at the given physical index.
void	_readRawConstants (size_t physicalIndex, size_t count, float *dest)
	Read a series of floating point values from the underlying float constant buffer at the given physical index.
void	_readRawConstants (size_t physicalIndex, size_t count, int *dest)
	Read a series of integer values from the underlying integer constant buffer at the given physical index.
void	_writeRawConstant (size_t physicalIndex, const Vector4 &vec, size_t count=4)
	Write a 4-element floating-point parameter to the program directly to the underlying constants buffer.
void	_writeRawConstant (size_t physicalIndex, Real val)
	Write a single floating-point parameter to the program.
void	_writeRawConstant (size_t physicalIndex, int val)
	Write a single integer parameter to the program.
void	_writeRawConstant (size_t physicalIndex, const Vector3 &vec)
	Write a 3-element floating-point parameter to the program via Vector3.
void	_writeRawConstant (size_t physicalIndex, const Matrix4 &m)
	Write a Matrix4 parameter to the program.
void	_writeRawConstant (size_t physicalIndex, const Matrix4 *m, size_t numEntries)
	Write a list of Matrix4 parameters to the program.
void	_writeRawConstant (size_t physicalIndex, const ColourValue &colour, size_t count=4)
	Write a ColourValue parameter to the program.
GpuConstantDefinitionIterator	getConstantDefinitionIterator (void) const
	Gets an iterator over the named GpuConstantDefinition instances as defined by the program for which these parameters exist.
const GpuConstantDefinition &	getConstantDefinition (const String &name) const
	Get a specific GpuConstantDefinition for a named parameter.
const GpuNamedConstants &	getConstantDefinitions () const
	Get the full list of GpuConstantDefinition instances.
const GpuLogicalBufferStruct *	getFloatLogicalBufferStruct () const
	Get the current list of mappings from low-level logical param indexes to physical buffer locations in the float buffer.
size_t	getFloatLogicalIndexForPhysicalIndex (size_t physicalIndex)
	Retrieves the logical index relating to a physical index in the float buffer, for programs which support that (low-level programs and high-level programs which use logical parameter indexes).
size_t	getIntLogicalIndexForPhysicalIndex (size_t physicalIndex)
	Retrieves the logical index relating to a physical index in the int buffer, for programs which support that (low-level programs and high-level programs which use logical parameter indexes).
const GpuLogicalBufferStruct *	getIntLogicalBufferStruct () const
	Get the current list of mappings from low-level logical param indexes to physical buffer locations in the integer buffer.
const FloatConstantList &	getFloatConstantList () const
	Get a reference to the list of float constants.
float *	getFloatPointer (size_t pos)
	Get a pointer to the 'nth' item in the float buffer.
const float *	getFloatPointer (size_t pos) const
	Get a pointer to the 'nth' item in the float buffer.
const IntConstantList &	getIntConstantList () const
	Get a reference to the list of int constants.
int *	getIntPointer (size_t pos)
	Get a pointer to the 'nth' item in the int buffer.
const int *	getIntPointer (size_t pos) const
	Get a pointer to the 'nth' item in the int buffer.
const AutoConstantList &	getAutoConstantList () const
	Get a reference to the list of auto constant bindings.
void	setAutoConstant (size_t index, AutoConstantType acType, size_t extraInfo=0)
	Sets up a constant which will automatically be updated by the system.
void	setAutoConstantReal (size_t index, AutoConstantType acType, Real rData)
void	_setRawAutoConstant (size_t physicalIndex, AutoConstantType acType, size_t extraInfo, size_t elementSize=4)
	As setAutoConstant, but sets up the auto constant directly against a physical buffer index.
void	_setRawAutoConstantReal (size_t physicalIndex, AutoConstantType acType, Real rData, size_t elementSize=4)
	As setAutoConstantReal, but sets up the auto constant directly against a physical buffer index.
void	clearAutoConstant (size_t index)
	Unbind an auto constant so that the constant is manually controlled again.
void	setConstantFromTime (size_t index, Real factor)
	Sets a named parameter up to track a derivation of the current time.
void	clearAutoConstants (void)
	Clears all the existing automatic constants.
AutoConstantIterator	getAutoConstantIterator (void) const
	Gets an iterator over the automatic constant bindings currently in place.
size_t	getAutoConstantCount (void) const
	Gets the number of int constants that have been set.
AutoConstantEntry *	getAutoConstantEntry (const size_t index)
	Gets a specific Auto Constant entry if index is in valid range otherwise returns a NULL.
bool	hasAutoConstants (void) const
	Returns true if this instance has any automatic constants.
const AutoConstantEntry *	findFloatAutoConstantEntry (size_t logicalIndex)
	Finds an auto constant that's affecting a given logical parameter index for floating-point values.
const AutoConstantEntry *	findIntAutoConstantEntry (size_t logicalIndex)
	Finds an auto constant that's affecting a given logical parameter index for integer values.
const AutoConstantEntry *	findAutoConstantEntry (const String &paramName)
	Finds an auto constant that's affecting a given named parameter index.
const AutoConstantEntry *	_findRawAutoConstantEntryFloat (size_t physicalIndex)
	Finds an auto constant that's affecting a given physical position in the floating-point buffer.
const AutoConstantEntry *	_findRawAutoConstantEntryInt (size_t physicalIndex)
	Finds an auto constant that's affecting a given physical position in the integer buffer.
void	_updateAutoParamsNoLights (const AutoParamDataSource *source)
	Updates the automatic parameters (except lights) based on the details provided.
void	_updateAutoParamsLightsOnly (const AutoParamDataSource *source)
	Updates the automatic parameters for lights based on the details provided.
void	setIgnoreMissingParams (bool state)
	Tells the program whether to ignore missing parameters or not.
void	setNamedConstant (const String &name, Real val)
	Sets a single value constant floating-point parameter to the program.
void	setNamedConstant (const String &name, int val)
	Sets a single value constant integer parameter to the program.
void	setNamedConstant (const String &name, const Vector4 &vec)
	Sets a Vector4 parameter to the program.
void	setNamedConstant (const String &name, const Vector3 &vec)
	Sets a Vector3 parameter to the program.
void	setNamedConstant (const String &name, const Matrix4 &m)
	Sets a Matrix4 parameter to the program.
void	setNamedConstant (const String &name, const Matrix4 *m, size_t numEntries)
	Sets a list of Matrix4 parameters to the program.
void	setNamedConstant (const String &name, const float *val, size_t count, size_t multiple=4)
	Sets a multiple value constant floating-point parameter to the program.
void	setNamedConstant (const String &name, const double *val, size_t count, size_t multiple=4)
	Sets a multiple value constant floating-point parameter to the program.
void	setNamedConstant (const String &name, const ColourValue &colour)
	Sets a ColourValue parameter to the program.
void	setNamedConstant (const String &name, const int *val, size_t count, size_t multiple=4)
	Sets a multiple value constant floating-point parameter to the program.
void	setNamedAutoConstant (const String &name, AutoConstantType acType, size_t extraInfo=0)
	Sets up a constant which will automatically be updated by the system.
void	setNamedAutoConstantReal (const String &name, AutoConstantType acType, Real rData)
void	setNamedConstantFromTime (const String &name, Real factor)
	Sets a named parameter up to track a derivation of the current time.
void	clearNamedAutoConstant (const String &name)
	Unbind an auto constant so that the constant is manually controlled again.
const GpuConstantDefinition *	_findNamedConstantDefinition (const String &name, bool throwExceptionIfMissing=false) const
	Find a constant definition for a named parameter.
size_t	_getFloatConstantPhysicalIndex (size_t logicalIndex, size_t requestedSize)
	Gets the physical buffer index associated with a logical float constant index.
size_t	_getIntConstantPhysicalIndex (size_t logicalIndex, size_t requestedSize)
	Gets the physical buffer index associated with a logical int constant index.
void	setTransposeMatrices (bool val)
	Sets whether or not we need to transpose the matrices passed in from the rest of OGRE.
bool	getTransposeMatrices (void) const
	Gets whether or not matrices are to be transposed when set.
void	copyConstantsFrom (const GpuProgramParameters &source)
	Copies the values of all constants (including auto constants) from another GpuProgramParameters object.
void	incPassIterationNumber (void)
	increments the multipass number entry by 1 if it exists
bool	hasPassIterationNumber () const
	Does this parameters object have a pass iteration number constant?
size_t	getPassIterationNumberIndex () const
	Get the physical buffer index of the pass iteration number constant.
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, 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 const AutoConstantDefinition *	getAutoConstantDefinition (const String &name)
	gets the auto constant definition associated with name if found else returns NULL
static const AutoConstantDefinition *	getAutoConstantDefinition (const size_t idx)
	gets the auto constant definition using an index into the auto constant definition array.
static size_t	getNumAutoConstantDefinitions (void)
	Returns the number of auto constant definitions.
Protected Attributes
FloatConstantList	mFloatConstants
	Packed list of floating-point constants (physical indexing).
IntConstantList	mIntConstants
	Packed list of integer constants (physical indexing).
GpuLogicalBufferStruct *	mFloatLogicalToPhysical
	Logical index to physical index map - for low-level programs or high-level programs which pass params this way.
GpuLogicalBufferStruct *	mIntLogicalToPhysical
	Logical index to physical index map - for low-level programs or high-level programs which pass params this way.
const GpuNamedConstants *	mNamedConstants
	Mapping from parameter names to def - high-level programs are expected to populate this.
AutoConstantList	mAutoConstants
	List of automatically updated parameters.
bool	mTransposeMatrices
	Do we need to transpose matrices?
bool	mIgnoreMissingParams
	flag to indicate if names not found will be ignored
size_t	mActivePassIterationIndex
	physical index for active pass iteration parameter real constant entry;
Static Protected Attributes
static AutoConstantDefinition	AutoConstantDictionary []
Classes
struct	AutoConstantDefinition
	Structure defining an auto constant that's available for use in a parameters object. More...
class	AutoConstantEntry
	Structure recording the use of an automatic parameter. More...