OGRE  13.4
Object-Oriented Graphics Rendering Engine
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. More...
 
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. More...
 
GpuConstantType constType
 Data type. More...
 
uint32 elementSize
 Number of typed slots per element (some programs pack each array element to float4, some do not) More...
 
size_t logicalIndex
 Logical index - used to communicate this constant to the rendersystem. More...
 
size_t physicalIndex
 Physical byte offset in buffer. More...
 
uint16 variability
 How this parameter varies (bitwise combination of GpuProgramVariability) More...
 

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

◆ 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

◆ 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

◆ getBaseType()

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

◆ getElementSize()

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: