Ogre::GpuConstantDefinition Struct Reference

Information about predefined program constants. More...

#include <OgreGpuProgramParams.h>

Public Member Functions
	GpuConstantDefinition ()
bool	isBool () const
bool	isDouble () const
bool	isFloat () const
bool	isInt () const
bool	isSampler () const
bool	isSpecialization () const
bool	isUnsignedInt () const

Static Public Member Functions
static BaseConstantType	getBaseType (GpuConstantType ctype)
static uint32	getElementSize (GpuConstantType ctype, bool padToMultiplesOf4)
	Get the number of elements of a given type, including whether to pad the elements into multiples of 4 (e.g.
static bool	isBool (GpuConstantType c)
static bool	isDouble (GpuConstantType c)
static bool	isFloat (GpuConstantType c)
static bool	isInt (GpuConstantType c)
static bool	isSampler (GpuConstantType c)
static bool	isSpecialization (GpuConstantType c)
static bool	isUnsignedInt (GpuConstantType c)

Public Attributes
uint32	arraySize
	Length of array.
GpuConstantType	constType
	Data type.
uint32	elementSize
	Number of typed slots per element (some programs pack each array element to float4, some do not)
size_t	logicalIndex
	Logical index - used to communicate this constant to the rendersystem.
size_t	physicalIndex
	Physical byte offset in buffer.
uint16	variability
	How this parameter varies (bitwise combination of GpuProgramVariability)

Detailed Description

Information about predefined program constants.

Note

Only available for high-level programs but is referenced generically by GpuProgramParameters.

Constructor & Destructor Documentation

GpuConstantDefinition()

Ogre::GpuConstantDefinition::GpuConstantDefinition ( )

inline

Member Function Documentation

isFloat() [1/2]

bool Ogre::GpuConstantDefinition::isFloat ( ) const

inline

References isFloat().

Referenced by isFloat().

isFloat() [2/2]

static bool Ogre::GpuConstantDefinition::isFloat ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_FLOAT.

isDouble() [1/2]

bool Ogre::GpuConstantDefinition::isDouble ( ) const

inline

References isDouble().

Referenced by isDouble().

isDouble() [2/2]

static bool Ogre::GpuConstantDefinition::isDouble ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_DOUBLE.

isInt() [1/2]

bool Ogre::GpuConstantDefinition::isInt ( ) const

inline

References isInt().

Referenced by isInt().

isInt() [2/2]

static bool Ogre::GpuConstantDefinition::isInt ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_INT.

isUnsignedInt() [1/2]

bool Ogre::GpuConstantDefinition::isUnsignedInt ( ) const

inline

References isUnsignedInt().

Referenced by isUnsignedInt().

isUnsignedInt() [2/2]

static bool Ogre::GpuConstantDefinition::isUnsignedInt ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_UINT.

isBool() [1/2]

bool Ogre::GpuConstantDefinition::isBool ( ) const

inline

References isBool().

Referenced by isBool().

isBool() [2/2]

static bool Ogre::GpuConstantDefinition::isBool ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_BOOL.

isSampler() [1/2]

bool Ogre::GpuConstantDefinition::isSampler ( ) const

inline

References isSampler().

Referenced by isSampler().

isSampler() [2/2]

static bool Ogre::GpuConstantDefinition::isSampler ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_SAMPLER.

isSpecialization() [1/2]

bool Ogre::GpuConstantDefinition::isSpecialization ( ) const

inline

References isSpecialization().

Referenced by isSpecialization().

isSpecialization() [2/2]

static bool Ogre::GpuConstantDefinition::isSpecialization ( GpuConstantType  c )

inlinestatic

References Ogre::BCT_SPECIALIZATION.

getBaseType()

static BaseConstantType Ogre::GpuConstantDefinition::getBaseType ( GpuConstantType  ctype )

inlinestatic

getElementSize()

static uint32 Ogre::GpuConstantDefinition::getElementSize ( GpuConstantType  ctype, bool  padToMultiplesOf4  )

inlinestatic

Get the number of elements of a given type, including whether to pad the elements into multiples of 4 (e.g.

SM1 and D3D does, GLSL doesn't)

References Ogre::GCT_BOOL1, Ogre::GCT_BOOL2, Ogre::GCT_BOOL3, Ogre::GCT_BOOL4, Ogre::GCT_DOUBLE1, Ogre::GCT_DOUBLE2, Ogre::GCT_DOUBLE3, Ogre::GCT_DOUBLE4, Ogre::GCT_FLOAT1, Ogre::GCT_FLOAT2, Ogre::GCT_FLOAT3, Ogre::GCT_FLOAT4, Ogre::GCT_INT1, Ogre::GCT_INT2, Ogre::GCT_INT3, Ogre::GCT_INT4, Ogre::GCT_MATRIX_2X2, Ogre::GCT_MATRIX_2X3, Ogre::GCT_MATRIX_2X4, Ogre::GCT_MATRIX_3X2, Ogre::GCT_MATRIX_3X3, Ogre::GCT_MATRIX_3X4, Ogre::GCT_MATRIX_4X2, Ogre::GCT_MATRIX_4X3, Ogre::GCT_MATRIX_4X4, Ogre::GCT_MATRIX_DOUBLE_2X2, Ogre::GCT_MATRIX_DOUBLE_2X3, Ogre::GCT_MATRIX_DOUBLE_2X4, Ogre::GCT_MATRIX_DOUBLE_3X2, Ogre::GCT_MATRIX_DOUBLE_3X3, Ogre::GCT_MATRIX_DOUBLE_3X4, Ogre::GCT_MATRIX_DOUBLE_4X2, Ogre::GCT_MATRIX_DOUBLE_4X3, Ogre::GCT_MATRIX_DOUBLE_4X4, Ogre::GCT_SAMPLER1D, Ogre::GCT_SAMPLER1DSHADOW, Ogre::GCT_SAMPLER2D, Ogre::GCT_SAMPLER2DARRAY, Ogre::GCT_SAMPLER2DSHADOW, Ogre::GCT_SAMPLER3D, Ogre::GCT_SAMPLERCUBE, Ogre::GCT_UINT1, Ogre::GCT_UINT2, Ogre::GCT_UINT3, and Ogre::GCT_UINT4.

Member Data Documentation

physicalIndex

size_t Ogre::GpuConstantDefinition::physicalIndex

Physical byte offset in buffer.

logicalIndex

size_t Ogre::GpuConstantDefinition::logicalIndex

Logical index - used to communicate this constant to the rendersystem.

elementSize

uint32 Ogre::GpuConstantDefinition::elementSize

Number of typed slots per element (some programs pack each array element to float4, some do not)

arraySize

uint32 Ogre::GpuConstantDefinition::arraySize

Length of array.

constType

GpuConstantType Ogre::GpuConstantDefinition::constType

Data type.

variability

uint16 Ogre::GpuConstantDefinition::variability

mutable

How this parameter varies (bitwise combination of GpuProgramVariability)

---

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

• OgreGpuProgramParams.h