Go to the documentation of this file.
28 #ifndef __GpuProgramParams_H_
29 #define __GpuProgramParams_H_
140 return isFloat(constType);
167 return isDouble(constType);
198 return isSampler(constType);
221 return isSubroutine(constType);
234 if (padToMultiplesOf4)
345 , physicalIndex((
std::numeric_limits<size_t>::max)())
379 void generateConstantDefinitionArrayEntries(
const String& paramName,
383 static bool getGenerateAllConstantDefinitionArrayEntries();
391 static void setGenerateAllConstantDefinitionArrayEntries(
bool generateAll);
396 void save(
const String& filename)
const;
402 size_t calculateSize(
void)
const;
422 Endian endianMode = ENDIAN_NATIVE);
424 Endian endianMode = ENDIAN_NATIVE);
441 : physicalIndex(99999), currentSize(0), variability(
GPV_GLOBAL) {}
443 : physicalIndex(bufIdx), currentSize(curSz), variability(v) {}
526 void removeConstantDefinition(
const String& name);
530 void removeAllConstantDefinitions();
537 size_t calculateSize(
void)
const;
562 void setNamedConstant(
const String& name,
Real val);
564 void setNamedConstant(
const String& name,
int val);
566 void setNamedConstant(
const String& name,
const Vector4& vec);
568 void setNamedConstant(
const String& name,
const Vector3& vec);
570 void setNamedConstant(
const String& name,
const Vector2& vec);
574 void setNamedConstant(
const String& name,
const Matrix4* m,
size_t numEntries);
576 void setNamedConstant(
const String& name,
const float *val,
size_t count);
578 void setNamedConstant(
const String& name,
const double *val,
size_t count);
582 void setNamedConstant(
const String& name,
const int *val,
size_t count);
593 int*
getIntPointer(
size_t pos) { _markDirty();
return &mIntConstants[pos]; }
656 void _copySharedParamsToTargetParams();
1207 :acType(_acType), name(_name), elementCount(_elementCount),
1208 elementType(_elementType), dataType(_dataType)
1235 uint16 theVariability,
size_t theElemCount = 4)
1236 : paramType(theType), physicalIndex(theIndex), elementCount(theElemCount),
1237 data(theData), variability(theVariability) {}
1240 uint16 theVariability,
size_t theElemCount = 4)
1241 : paramType(theType), physicalIndex(theIndex), elementCount(theElemCount),
1242 fData(theData), variability(theVariability) {}
1288 GpuLogicalIndexUse* _getFloatConstantLogicalIndexUse(
size_t logicalIndex,
size_t requestedSize,
uint16 variability);
1291 GpuLogicalIndexUse* _getDoubleConstantLogicalIndexUse(
size_t logicalIndex,
size_t requestedSize,
uint16 variability);
1339 void setConstant(
size_t index,
const Vector4& vec);
1347 void setConstant(
size_t index,
Real val);
1355 void setConstant(
size_t index,
const Vector3& vec);
1363 void setConstant(
size_t index,
const Vector2& vec);
1370 void setConstant(
size_t index,
const Matrix4& m);
1378 void setConstant(
size_t index,
const Matrix4* m,
size_t numEntries);
1385 void setConstant(
size_t index,
const float *val,
size_t count);
1392 void setConstant(
size_t index,
const double *val,
size_t count);
1398 void setConstant(
size_t index,
const ColourValue& colour);
1414 void setConstant(
size_t index,
const int *val,
size_t count);
1422 void _writeRawConstants(
size_t physicalIndex,
const float* val,
size_t count);
1429 void _writeRawConstants(
size_t physicalIndex,
const double* val,
size_t count);
1436 void _writeRawConstants(
size_t physicalIndex,
const int* val,
size_t count);
1443 void _readRawConstants(
size_t physicalIndex,
size_t count,
float* dest);
1450 void _readRawConstants(
size_t physicalIndex,
size_t count,
int* dest);
1462 void _writeRawConstant(
size_t physicalIndex,
const Vector4& vec,
1471 void _writeRawConstant(
size_t physicalIndex,
Real val);
1479 void _writeRawConstant(
size_t physicalIndex,
Real val,
size_t count);
1487 void _writeRawConstant(
size_t physicalIndex,
int val);
1495 void _writeRawConstant(
size_t physicalIndex,
const Vector3& vec);
1503 void _writeRawConstant(
size_t physicalIndex,
const Vector2& vec);
1512 void _writeRawConstant(
size_t physicalIndex,
const Matrix4& m,
size_t elementCount);
1520 void _writeRawConstant(
size_t physicalIndex,
const Matrix4* m,
size_t numEntries);
1530 void _writeRawConstant(
size_t physicalIndex,
const ColourValue& colour,
1565 size_t getFloatLogicalIndexForPhysicalIndex(
size_t physicalIndex);
1583 size_t getDoubleLogicalIndexForPhysicalIndex(
size_t physicalIndex);
1589 size_t getIntLogicalIndexForPhysicalIndex(
size_t physicalIndex);
1631 void setAutoConstant(
size_t index, AutoConstantType acType,
size_t extraInfo = 0);
1632 void setAutoConstantReal(
size_t index, AutoConstantType acType,
Real rData);
1648 void setAutoConstant(
size_t index, AutoConstantType acType,
uint16 extraInfo1,
uint16 extraInfo2);
1653 void _setRawAutoConstant(
size_t physicalIndex, AutoConstantType acType,
size_t extraInfo,
1654 uint16 variability,
size_t elementSize = 4);
1658 void _setRawAutoConstantReal(
size_t physicalIndex, AutoConstantType acType,
Real rData,
1659 uint16 variability,
size_t elementSize = 4);
1663 void clearAutoConstant(
size_t index);
1669 void setConstantFromTime(
size_t index,
Real factor);
1672 void clearAutoConstants(
void);
1682 AutoConstantEntry* getAutoConstantEntry(
const size_t index);
1689 const AutoConstantEntry* findFloatAutoConstantEntry(
size_t logicalIndex);
1694 const AutoConstantEntry* findDoubleAutoConstantEntry(
size_t logicalIndex);
1699 const AutoConstantEntry* findIntAutoConstantEntry(
size_t logicalIndex);
1703 const AutoConstantEntry* findAutoConstantEntry(
const String& paramName);
1707 const AutoConstantEntry* _findRawAutoConstantEntryFloat(
size_t physicalIndex);
1711 const AutoConstantEntry* _findRawAutoConstantEntryDouble(
size_t physicalIndex);
1715 const AutoConstantEntry* _findRawAutoConstantEntryInt(
size_t physicalIndex);
1746 void setNamedConstant(
const String& name,
Real val);
1766 void setNamedConstant(
const String& name,
int val);
1771 void setNamedConstant(
const String& name,
const Vector4& vec);
1779 void setNamedConstant(
const String& name,
const Vector3& vec);
1784 void setNamedConstant(
const String& name,
const Vector2& vec);
1789 void setNamedConstant(
const String& name,
const Matrix4& m);
1797 void setNamedConstant(
const String& name,
const Matrix4* m,
size_t numEntries);
1814 void setNamedConstant(
const String& name,
const float *val,
size_t count,
1815 size_t multiple = 4);
1832 void setNamedConstant(
const String& name,
const double *val,
size_t count,
1833 size_t multiple = 4);
1856 void setNamedConstant(
const String& name,
const int *val,
size_t count,
1857 size_t multiple = 4);
1873 void setNamedAutoConstant(
const String& name, AutoConstantType acType,
size_t extraInfo = 0);
1874 void setNamedAutoConstantReal(
const String& name, AutoConstantType acType,
Real rData);
1891 void setNamedAutoConstant(
const String& name, AutoConstantType acType,
uint16 extraInfo1,
uint16 extraInfo2);
1900 void setNamedConstantFromTime(
const String& name,
Real factor);
1903 void clearNamedAutoConstant(
const String& name);
1915 const String& name,
bool throwExceptionIfMissing =
false)
const;
1922 size_t _getFloatConstantPhysicalIndex(
size_t logicalIndex,
size_t requestedSize,
uint16 variability);
1929 size_t _getDoubleConstantPhysicalIndex(
size_t logicalIndex,
size_t requestedSize,
uint16 variability);
1936 size_t _getIntConstantPhysicalIndex(
size_t logicalIndex,
size_t requestedSize,
uint16 variability);
1970 static const AutoConstantDefinition* getAutoConstantDefinition(
const String& name);
1975 static const AutoConstantDefinition* getAutoConstantDefinition(
const size_t idx);
1978 static size_t getNumAutoConstantDefinitions(
void);
1983 void incPassIterationNumber(
void);
1986 {
return mActivePassIterationIndex != (std::numeric_limits<size_t>::max)(); }
1989 {
return mActivePassIterationIndex; }
2006 void addSharedParameters(
const String& sharedParamsName);
2009 bool isUsingSharedParameters(
const String& sharedParamsName)
const;
2012 void removeSharedParameters(
const String& sharedParamsName);
2015 void removeAllSharedParameters();
2018 const GpuSharedParamUsageList& getSharedParameters()
const;
2032 void _copySharedParams();
2034 size_t calculateSize(
void)
const;
2038 void setNamedSubroutine(
const String& subroutineSlot,
const String& subroutine);
2042 void setSubroutine(
size_t index,
const String& subroutine);
AutoConstantType paramType
The type of parameter.
This class records the usage of a set of shared parameters in a concrete set of GpuProgramParameters.
@ ACT_INVERSE_VIEWPORT_HEIGHT
This variable represents 1.0/ViewportHeight.
const double * getDoublePointer(size_t pos) const
Get a pointer to the 'nth' item in the double buffer.
@ ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED_ARRAY
Array of light specular colours scaled by light power (count set by extra param)
HashMap< unsigned int, String > SubroutineMap
@ ACT_SHADOW_EXTRUSION_DISTANCE
The distance a shadow volume should be extruded when using finite extrusion programs.
@ ACT_ANIMATION_PARAMETRIC
Provides a parametric animation value [0..1], only available where the renderable specifically implem...
@ ACT_LIGHT_POSITION_OBJECT_SPACE_ARRAY
Array of light positions in object space (count set by extra param)
This utility class is used to hold the information used to generate the matrices and other informatio...
@ ACT_CAMERA_POSITION_OBJECT_SPACE
The current camera's position in object space.
@ ACT_LIGHT_COUNT
The number of active light sources (better than gl_MaxLights)
size_t elementSize
Number of raw buffer slots per element (some programs pack each array element to float4,...
static bool isFloat(GpuConstantType c)
@ ACT_TIME_0_1
Single float value, which represents scaled time value [0..1], which repeats itself based on given as...
float * getFloatPointer(size_t pos)
Get a pointer to the 'nth' item in the float buffer.
@ ACT_TEXTURE_WORLDVIEWPROJ_MATRIX_ARRAY
Array of world/view/projection matrices of the first n texture projection frustums.
const FloatConstantList & getFloatConstantList() const
Get a reference to the list of float constants.
@ ACT_DERIVED_LIGHT_DIFFUSE_COLOUR_ARRAY
Array of derived light diffuse colours (count set by extra param)
@ ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX
The current world & view matrices concatenated, then inverted & transposed.
@ ACT_TIME_0_X_PACKED
Vector of "Time0_X", "SinTime0_X", "CosTime0_X", "TanTime0_X".
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
@ ACT_DERIVED_SCENE_COLOUR
The derived scene colour, with 'r', 'g' and 'b' components filled with sum of derived ambient light c...
@ ACT_LIGHT_POSITION_VIEW_SPACE_ARRAY
Array of light positions in view space (count set by extra param)
const GpuLogicalBufferStructPtr & getFloatLogicalBufferStruct() const
Get the current list of mappings from low-level logical param indexes to physical buffer locations in...
@ ACT_VIEW_DIRECTION
view parameters
Struct collecting together the information for named constants.
GpuConstantDefinitionMap map
Map of parameter names to GpuConstantDefinition.
@ ACT_FRAME_TIME
provides the scaled frame time, returned as a floating point value.
ConstVectorIterator< AutoConstantList > AutoConstantIterator
@ ACT_INVERSE_TRANSPOSE_VIEWPROJ_MATRIX
Provides inverse transpose of concatenated view and projection matrices.
@ ACT_INVERSE_WORLDVIEWPROJ_MATRIX
Provides inverse of concatenated world, view and projection matrices.
@ ACT_TIME
provides current elapsed time
const String & getName()
Get the name of this shared parameter set.
const GpuConstantDefinition * dstDefinition
@ ACT_TEXTURE_SIZE
Provides texture size of the texture unit (index determined by setAutoConstant call).
@ ACT_CAMERA_POSITION
The current camera's position in world space.
@ ACT_LIGHT_DIRECTION_OBJECT_SPACE_ARRAY
Array of light directions in object space (count set by extra param)
void setTransposeMatrices(bool val)
Sets whether or not we need to transpose the matrices passed in from the rest of OGRE.
@ ACT_TEXTURE_VIEWPROJ_MATRIX_ARRAY
Array of view/projection matrices of the first n texture projection frustums.
size_t intBufferSize
Total size of the int buffer required.
const float * getFloatPointer(size_t pos) const
Get a pointer to the 'nth' item in the float buffer.
@ ACT_SURFACE_SPECULAR_COLOUR
Surface specular colour, as set in Pass::setSpecular.
const SubroutineMap & getSubroutineMap() const
Get map with.
FloatConstantList mFloatConstants
size_t bufferSize
Shortcut to know the buffer size needs.
@ ACT_LIGHT_DISTANCE_OBJECT_SPACE_ARRAY
Array of distances of the lights from the center of the object a useful approximation as an alternati...
@ ACT_DERIVED_AMBIENT_LIGHT_COLOUR
The derived ambient light colour, with 'r', 'g', 'b' components filled with product of surface ambien...
@ ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX
Provides transpose of concatenated world, view and projection matrices.
GpuConstantType constType
Data type.
@ ACT_WORLD_MATRIX_ARRAY_3x4
The current array of world matrices, as a 3x4 matrix, used for blending.
@ ACT_VIEW_SIDE_VECTOR
This variable provides the view side vector (world space).
@ ACT_SURFACE_EMISSIVE_COLOUR
Surface emissive colour, as set in Pass::setSelfIllumination.
size_t getAutoConstantCount(void) const
Gets the number of int constants that have been set.
size_t mFrameLastUpdated
Not used when copying data, but might be useful to RS using shared buffers.
Structure recording the use of an automatic parameter.
GpuLogicalIndexUse(size_t bufIdx, size_t curSz, uint16 v)
const AutoConstantList & getAutoConstantList() const
Get a reference to the list of auto constant bindings.
@ ACT_COSTIME_0_1
Cosine of "Time0_1". Equivalent to RenderMonkey's "CosTime0_1".
AutoConstantEntry(AutoConstantType theType, size_t theIndex, Real theData, uint16 theVariability, size_t theElemCount=4)
@ ACT_LIGHT_POSITION_ARRAY
Array of light positions in world space (count set by extra param)
int * getIntPointer(size_t pos)
Get a pointer to the 'nth' item in the int buffer.
SharedPtr< GpuProgramParameters > GpuProgramParametersSharedPtr
Shared pointer used to hold references to GpuProgramParameters instances.
size_t currentSize
Current physical size allocation.
HashMap< unsigned int, String >::const_iterator SubroutineIterator
const IntConstantList & getIntConstantList() const
Get a reference to the list of int constants.
@ ACT_LIGHT_CUSTOM
Binds custom per-light constants to the shaders.
Variant type that can hold Any other type.
@ ACT_FOV
This variable provides the field of view as a floating point value.
@ ACT_INVERSE_TRANSPOSE_WORLD_MATRIX
The current world matrix, inverted & transposed.
SharedPtr< GpuNamedConstants > GpuNamedConstantsPtr
unsigned long mVersion
Version number of the definitions in this buffer.
size_t arraySize
Length of array.
@ ACT_TIME_0_X
Single float value, which repeats itself based on given as parameter "cycle time".
@ ACT_TIME_0_2PI
Single float value, which represents scaled time value [0..2*Pi], which repeats itself based on given...
CopyDataList mCopyDataList
static bool isDouble(GpuConstantType c)
@ ACT_LIGHT_POSITION_OBJECT_SPACE
A light position in object space (index determined by setAutoConstant call)
@ GPV_PER_OBJECT
Varies per object (based on an auto param usually), but not per light setup.
const Any & _getRenderSystemData() const
Internal method that the RenderSystem might use to store optional data.
DoubleConstantList mDoubleConstants
Simple class for loading / saving GpuNamedConstants.
ElementType elementType
The type of the constant in the program.
const double * getDoublePointer(size_t pos) const
Get a pointer to the 'nth' item in the double buffer.
AutoConstantDefinition(AutoConstantType _acType, const String &_name, size_t _elementCount, ElementType _elementType, ACDataType _dataType)
@ ACT_PASS_ITERATION_NUMBER
provides the current iteration number of the pass.
GpuLogicalIndexUseMap map
Map from logical index to physical buffer location.
map< size_t, GpuLogicalIndexUse >::type GpuLogicalIndexUseMap
GpuProgramParameters * mParams
const GpuLogicalBufferStructPtr & getIntLogicalBufferStruct() const
Get the current list of mappings from low-level logical param indexes to physical buffer locations in...
uint16 variability
The variability of this parameter (see GpuParamVariability)
const FloatConstantList & getFloatConstantList() const
Get a reference to the list of float constants.
@ ACT_SINTIME_0_X
Sine of "Time0_X". Equivalent to RenderMonkey's "SinTime0_X".
float * getFloatPointer(size_t pos)
Get a pointer to the 'nth' item in the float buffer.
@ ACT_DERIVED_LIGHT_SPECULAR_COLOUR_ARRAY
Array of derived light specular colours (count set by extra param)
@ ACT_LOD_CAMERA_POSITION_OBJECT_SPACE
Provides the position of the LOD camera in object space, allowing you to perform separate LOD calcula...
@ ACT_SPOTLIGHT_VIEWPROJ_MATRIX_ARRAY
Array of view/projection matrix of a given spotlight.
size_t getPassIterationNumberIndex() const
Get the physical buffer index of the pass iteration number constant.
@ ACT_LIGHT_ATTENUATION
Light attenuation parameters, Vector4(range, constant, linear, quadric)
vector< AutoConstantEntry >::type AutoConstantList
@ ACT_TRANSPOSE_PROJECTION_MATRIX
Provides transpose of projection matrix.
@ ACT_LIGHT_POSITION
A light position in world space (index determined by setAutoConstant call)
void _setRenderSystemData(const Any &data) const
Internal method that the RenderSystem might use to store optional data.
@ ACT_NEAR_CLIP_DISTANCE
This variable provides the near clip distance as a floating point value.
@ ACT_TANTIME_0_1
Tangent of "Time0_1". Equivalent to RenderMonkey's "TanTime0_1".
@ ACT_SURFACE_DIFFUSE_COLOUR
Surface diffuse colour, as set in Pass::setDiffuse.
@ ACT_LIGHT_NUMBER
The absolute light number of a local light index.
@ ACT_WORLD_MATRIX_ARRAY
The current array of world matrices, used for blending.
GpuProgramParameters * getTargetParams() const
@ GPV_ALL
Full mask (16-bit)
@ ACT_VERTEX_WINDING
-1 if the winding has been inverted (e.g.
@ ACT_FAR_CLIP_DISTANCE
This variable provides the far clip distance as a floating point value.
GpuLogicalBufferStructPtr mIntLogicalToPhysical
Logical index to physical index map - for low-level programs or high-level programs which pass params...
@ ACT_SINTIME_0_2PI
Sine of "Time0_2PI". Equivalent to RenderMonkey's "SinTime0_2PI".
@ ACT_SHADOW_COLOUR
Provides the fixed shadow colour as configured via SceneManager::setShadowColour; useful for integrat...
@ GPV_LIGHTS
Varies with light setup.
@ ACT_SURFACE_AMBIENT_COLOUR
Surface ambient colour, as set in Pass::setAmbient.
size_t doubleBufferSize
Total size of the double buffer required.
@ ACT_TRANSPOSE_WORLDVIEW_MATRIX
Provides transpose of concatenated world and view matrices.
@ ACT_SPOTLIGHT_PARAMS
Spotlight parameters, Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and outerFactor ...
@ ACT_INVERSE_WORLDVIEW_MATRIX
The current world & view matrices concatenated, then inverted.
size_t elementCount
The number of elements per individual entry in this constant Used in case people used packed elements...
@ ACT_TIME_0_2PI_PACKED
Vector of "Time0_2PI", "SinTime0_2PI", "CosTime0_2PI", "TanTime0_2PI".
Class encapsulating a standard 4x4 homogeneous matrix.
const IntConstantList & getIntConstantList() const
Get a reference to the list of int constants.
@ ACT_LIGHT_CASTS_SHADOWS
Returns (int) 1 if the given light casts shadows, 0 otherwise (index set in extra param)
SubroutineMap mSubroutineMap
@ ACT_SHADOW_SCENE_DEPTH_RANGE
Provides information about the depth range of the scene as viewed from a given shadow camera.
size_t logicalIndex
Logical index - used to communicate this constant to the rendersystem.
@ ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED_ARRAY
Array of light diffuse colours scaled by light power (count set by extra param)
SharedPtr< GpuSharedParameters > GpuSharedParametersPtr
Shared pointer used to hold references to GpuProgramParameters instances.
@ ACT_INVERSE_TEXTURE_SIZE
Provides inverse texture size of the texture unit (index determined by setAutoConstant call).
const String & getName() const
Get the name of the shared parameter set.
bool mIgnoreMissingParams
flag to indicate if names not found will be ignored
bool isSubroutine() const
GpuSharedParametersPtr mSharedParams
@ ACT_INVERSE_PROJECTION_MATRIX
Provides inverse of projection matrix.
const int * getIntPointer(size_t pos) const
Get a pointer to the 'nth' item in the int buffer.
double * getDoublePointer(size_t pos)
Get a pointer to the 'nth' item in the double buffer.
size_t physicalIndex
The target (physical) constant index.
vector< GpuSharedParametersUsage >::type GpuSharedParamUsageList
@ ACDT_INT
the auto constant requires data of type int
@ ACT_LIGHT_SPECULAR_COLOUR_ARRAY
Array of light specular colours (count set by extra param)
@ ACT_INVERSE_VIEWPORT_WIDTH
This variable represents 1.0/ViewportWidth.
@ ACT_PROJECTION_MATRIX
The current projection matrix.
@ ACT_RENDER_TARGET_FLIPPING
render target related values
@ ACT_FPS
provides the calculated frames per second, returned as a floating point value.
@ ACT_LIGHT_POWER_SCALE
Light power level, a single scalar as set in Light::setPowerScale (index determined by setAutoConstan...
@ ACT_AMBIENT_LIGHT_COLOUR
The ambient light colour set in the scene.
static bool isSampler(GpuConstantType c)
@ ACT_LIGHT_POWER_SCALE_ARRAY
Array of light power levels, a single scalar as set in Light::setPowerScale (count set by extra param...
@ ACT_TIME_0_1_PACKED
Vector of "Time0_1", "SinTime0_1", "CosTime0_1", "TanTime0_1".
@ ACT_SURFACE_ALPHA_REJECTION_VALUE
Surface alpha rejection value, not as set in Pass::setAlphaRejectionValue, but a floating number betw...
bool hasAutoConstants(void) const
Returns true if this instance has any automatic constants.
uint16 variability
How this parameter varies (bitwise combination of GpuProgramVariability)
@ ACT_COSTIME_0_X
Cosine of "Time0_X". Equivalent to RenderMonkey's "CosTime0_X".
@ ACT_COSTIME_0_2PI
Cosine of "Time0_2PI". Equivalent to RenderMonkey's "CosTime0_2PI".
@ ACT_INVERSE_WORLD_MATRIX
The current world matrix, inverted.
@ ACT_WORLDVIEWPROJ_MATRIX
view matrices.
@ ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX_ARRAY
An array of the view/projection matrix of a given spotlight projection frustum, combined with the cur...
const GpuLogicalBufferStructPtr & getDoubleLogicalBufferStruct() const
Retrieves the logical index relating to a physical index in the int buffer, for programs which suppor...
bool hasNamedParameters() const
Does this parameter set include named parameters?
AutoConstantList mAutoConstants
List of automatically updated parameters.
const DoubleConstantList & getDoubleConstantList() const
Get a reference to the list of double constants.
Collects together the program parameters used for a GpuProgram.
@ ACT_SHADOW_SCENE_DEPTH_RANGE_ARRAY
Provides an array of information about the depth range of the scene as viewed from a given shadow cam...
static bool msGenerateAllConstantDefinitionArrayEntries
Indicates whether all array entries will be generated and added to the definitions map.
@ ACT_FOG_COLOUR
Fog colour.
@ ACT_INVERSE_VIEW_MATRIX
The current view matrix, inverted.
GpuNamedConstantsPtr mNamedConstants
Mapping from parameter names to def - high-level programs are expected to populate this.
size_t floatBufferSize
Total size of the float buffer required.
@ ACT_VIEW_UP_VECTOR
This variable provides the view up vector (world space).
@ ACT_WORLD_DUALQUATERNION_ARRAY_2x4
The current array of world matrices transformed to an array of dual quaternions, represented as a 2x4...
@ ACT_INVERSE_TRANSPOSE_WORLDVIEWPROJ_MATRIX
Provides inverse transpose of concatenated world, view and projection matrices.
double * getDoublePointer(size_t pos)
Get a pointer to the 'nth' item in the double buffer.
unsigned long mCopyDataVersion
Version of shared params we based the copydata on.
@ ACT_TEXTURE_VIEWPROJ_MATRIX
The view/projection matrix of the assigned texture projection frustum.
@ ACT_SPOTLIGHT_VIEWPROJ_MATRIX
The view/projection matrix of a given spotlight.
@ ACT_LIGHT_POSITION_VIEW_SPACE
A light position in view space (index determined by setAutoConstant call)
GpuSharedParamUsageList mSharedParamSets
@ ACT_LIGHT_DIRECTION_OBJECT_SPACE
A light direction in object space (index determined by setAutoConstant call)
@ ACT_VIEWPORT_HEIGHT
Current viewport height (in pixels) as floating point value.
AutoConstantEntry(AutoConstantType theType, size_t theIndex, size_t theData, uint16 theVariability, size_t theElemCount=4)
void _setRenderSystemData(const Any &data) const
Internal method that the RenderSystem might use to store optional data.
GpuConstantType
Enumeration of the types of constant we may encounter in programs.
@ ACT_VIEW_MATRIX
The current view matrix.
@ ACT_LIGHT_CASTS_SHADOWS_ARRAY
Returns (int) 1 if the given light casts shadows, 0 otherwise (index set in extra param)
@ ACT_VIEWPROJ_MATRIX
The current view & projection matrices concatenated.
map< String, GpuConstantDefinition >::type GpuConstantDefinitionMap
@ ACT_LIGHT_DIRECTION_VIEW_SPACE_ARRAY
Array of light directions in view space (count set by extra param)
size_t mActivePassIterationIndex
physical index for active pass iteration parameter real constant entry;
static size_t getElementSize(GpuConstantType ctype, bool padToMultiplesOf4)
Get the element size of a given type, including whether to pad the elements into multiples of 4 (e....
@ ACT_LIGHT_DIRECTION_ARRAY
Array of light directions in world space (count set by extra param)
@ ACT_LIGHT_ATTENUATION_ARRAY
Array of light attenuation parameters, Vector4(range, constant, linear, quadric) (count set by extra ...
@ ACT_WORLD_MATRIX
The current world matrix.
IntConstantList mIntConstants
bool getTransposeMatrices(void) const
Gets whether or not matrices are to be transposed when set.
@ ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED
Light specular colour pre-scaled by Light::setPowerScale (index determined by setAutoConstant call)
uint16 variability
How the contents of this slot vary.
SharedPtr< GpuLogicalBufferStruct > GpuLogicalBufferStructPtr
GpuLogicalBufferStructPtr mDoubleLogicalToPhysical
Logical index to physical index map - for low-level programs or high-level programs which pass params...
@ ACT_INVERSE_VIEWPROJ_MATRIX
Provides inverse of concatenated view and projection matrices.
Class representing colour.
vector< double >::type DoubleConstantList
Definition of container that holds the current double constants.
@ ACT_TEXTURE_MATRIX
Provides the current transform matrix of the texture unit (index determined by setAutoConstant call),...
Information about predefined program constants.
IntConstantList mIntConstants
Packed list of integer constants (physical indexing)
@ ACT_SINTIME_0_1
Sine of "Time0_1". Equivalent to RenderMonkey's "SinTime0_1".
4-dimensional homogeneous vector.
const float * getFloatPointer(size_t pos) const
Get a pointer to the 'nth' item in the float buffer.
@ ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX
The view/projection matrix of a given spotlight projection frustum, combined with the current world m...
AutoConstantType
Defines the types of automatically updated values that may be bound to GpuProgram parameters,...
Standard 2-dimensional vector.
@ ACT_SURFACE_SHININESS
Surface shininess, as set in Pass::setShininess.
@ GPV_GLOBAL
No variation except by manual setting - the default.
const Any & _getRenderSystemData() const
Internal method that the RenderSystem might use to store optional data.
@ ACT_TRANSPOSE_VIEW_MATRIX
Provides transpose of view matrix.
ElementType
Defines the base element type of the auto constant.
size_t getFrameLastUpdated() const
Get the frame in which this shared parameter set was last updated.
GpuParamVariability
The variability of a GPU parameter, as derived from auto-params targeting it.
size_t physicalIndex
Physical buffer index.
@ ACT_LIGHT_DIRECTION
A light direction in world space (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
Light specular colour (index determined by setAutoConstant call)
unsigned long getVersion() const
Get the version number of this shared parameter set, can be used to identify when changes have occurr...
GpuLogicalBufferStructPtr mFloatLogicalToPhysical
Logical index to physical index map - for low-level programs or high-level programs which pass params...
@ ACT_LIGHT_DIFFUSE_COLOUR_ARRAY
Array of light diffuse colours (count set by extra param)
Structure defining an auto constant that's available for use in a parameters object.
bool hasPassIterationNumber() const
Does this parameters object have a pass iteration number constant?
@ ACT_WORLD_SCALE_SHEAR_MATRIX_ARRAY_3x4
The scale and shear components of the current array of world matrices.
@ ACDT_NONE
no data is required
@ ACT_DERIVED_LIGHT_SPECULAR_COLOUR
The derived light specular colour (index determined by setAutoConstant call), with 'r',...
A group of manually updated parameters that are shared between many parameter sets.
float Real
Software floating point type.
@ ACT_PASS_NUMBER
provides the pass index number within the technique of the active materil.
@ ACT_SCENE_DEPTH_RANGE
Provides information about the depth range of the scene as viewed from the current camera.
Generic class for serialising data to / from binary stream-based files.
@ ACT_INVERSE_TRANSPOSE_PROJECTION_MATRIX
Provides inverse transpose of projection matrix.
Concrete IteratorWrapper for const access to the underlying key-value container.
@ ACT_LIGHT_DIFFUSE_COLOUR
Light diffuse colour (index determined by setAutoConstant call)
@ ACT_VIEWPORT_WIDTH
viewport-related values
@ ACT_VIEWPORT_SIZE
Packed of "ViewportWidth", "ViewportHeight", "ViewportWidthInverse", "ViewportHeightInverse".
@ ACT_TEXEL_OFFSETS
Provides the texel offsets required by this rendersystem to map texels to pixels.
@ ACT_LIGHT_DIRECTION_VIEW_SPACE
A light direction in view space (index determined by setAutoConstant call)
@ ACT_TANTIME_0_2PI
Tangent of "Time0_2PI". Equivalent to RenderMonkey's "TanTime0_2PI".
bool hasLogicalIndexedParameters() const
Does this parameter set include logically indexed parameters?
@ ACT_LOD_CAMERA_POSITION
Provides the position of the LOD camera in world space, allowing you to perform separate LOD calculat...
Structure recording the use of a physical buffer by a logical parameter index.
@ ACT_WORLDVIEW_MATRIX
The current world & view matrices concatenated.
vector< float >::type FloatConstantList
Definition of container that holds the current float constants.
const DoubleConstantList & getDoubleConstantList() const
Get a reference to the list of double constants.
GpuSharedParametersPtr getSharedParams() const
@ ACT_TRANSPOSE_WORLD_MATRIX
Provides transpose of world matrix.
@ ACT_DERIVED_LIGHT_DIFFUSE_COLOUR
The derived light diffuse colour (index determined by setAutoConstant call), with 'r',...
uint16 mCombinedVariability
The combined variability masks of all parameters.
bool mTransposeMatrices
Do we need to transpose matrices?
@ ACT_PACKED_TEXTURE_SIZE
Provides packed texture size of the texture unit (index determined by setAutoConstant call).
Endian
The endianness of written files.
@ ACT_TEXTURE_WORLDVIEWPROJ_MATRIX
The view/projection matrix of the assigned texture projection frustum, combined with the current worl...
@ GPV_PASS_ITERATION_NUMBER
Varies with pass iteration number.
@ ACT_TANTIME_0_X
Tangent of "Time0_X". Equivalent to RenderMonkey's "TanTime0_X".
static bool isSubroutine(GpuConstantType c)
ACDataType
Defines the type of the extra data item used by the auto constant.
GpuNamedConstants mNamedConstants
const int * getIntPointer(size_t pos) const
Get a pointer to the 'nth' item in the int buffer.
vector< CopyDataEntry >::type CopyDataList
ConstMapIterator< GpuConstantDefinitionMap > GpuConstantDefinitionIterator
FloatConstantList mFloatConstants
Packed list of floating-point constants (physical indexing)
void _setRenderSystemData(const Any &data) const
Internal method that the RenderSystem might use to store optional data.
Container struct to allow params to safely & update shared list of logical buffer assignments.
@ ACT_CUSTOM
A custom parameter which will come from the renderable, using 'data' as the identifier.
@ ACT_TRANSPOSE_VIEWPROJ_MATRIX
Provides transpose of concatenated view and projection matrices.
Standard 3-dimensional vector.
vector< int >::type IntConstantList
Definition of container that holds the current float constants.
const GpuConstantDefinition * srcDefinition
@ ACT_FOG_PARAMS
Fog params: density, linear start, linear end, 1/(end-start)
@ ACT_LIGHT_DISTANCE_OBJECT_SPACE
The distance of the light from the center of the object a useful approximation as an alternative to p...
const Any & _getRenderSystemData() const
Internal method that the RenderSystem might use to store optional data.
Concrete IteratorWrapper for const access to the underlying container.
@ ACT_INVERSE_TRANSPOSE_VIEW_MATRIX
Provides inverse transpose of view matrix.
int * getIntPointer(size_t pos)
Get a pointer to the 'nth' item in the int buffer.
void setIgnoreMissingParams(bool state)
Tells the program whether to ignore missing parameters or not.
size_t physicalIndex
Physical start index in buffer (either float, double or int buffer)
@ ACT_SPOTLIGHT_PARAMS_ARRAY
Spotlight parameters array of Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and oute...
DoubleConstantList mDoubleConstants
Packed list of double-point constants (physical indexing)
ACDataType dataType
The type of any extra data.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15