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

Information about predefined program constants. More...

#include <OgreGpuProgramParams.h>

+ Inheritance diagram for Ogre::GpuConstantDefinition:

Public Member Functions

 GpuConstantDefinition ()
 
bool isBool () const
 
bool isDouble () const
 
bool isFloat () const
 
bool isInt () const
 
bool isSampler () const
 
bool isSubroutine () const
 
bool isUnsignedInt () const
 

Static Public Member Functions

static BaseConstantType getBaseType (GpuConstantType ctype)
 
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.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 isSubroutine (GpuConstantType c)
 
static bool isUnsignedInt (GpuConstantType c)
 

Public Attributes

size_t arraySize
 Length of array. More...
 
GpuConstantType constType
 Data type. More...
 
size_t elementSize
 Number of raw buffer 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 start index in buffer (either float, double, int, or uint 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.

Definition at line 146 of file OgreGpuProgramParams.h.

Constructor & Destructor Documentation

Ogre::GpuConstantDefinition::GpuConstantDefinition ( )
inline

Definition at line 464 of file OgreGpuProgramParams.h.

Member Function Documentation

static BaseConstantType Ogre::GpuConstantDefinition::getBaseType ( GpuConstantType  ctype)
inlinestatic
bool Ogre::GpuConstantDefinition::isBool ( ) const
inline

Definition at line 262 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isBool ( GpuConstantType  c)
inlinestatic
bool Ogre::GpuConstantDefinition::isDouble ( ) const
inline

Definition at line 196 of file OgreGpuProgramParams.h.

bool Ogre::GpuConstantDefinition::isFloat ( ) const
inline

Definition at line 168 of file OgreGpuProgramParams.h.

bool Ogre::GpuConstantDefinition::isInt ( ) const
inline

Definition at line 224 of file OgreGpuProgramParams.h.

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

Definition at line 229 of file OgreGpuProgramParams.h.

References Ogre::GCT_INT1, Ogre::GCT_INT2, Ogre::GCT_INT3, and Ogre::GCT_INT4.

bool Ogre::GpuConstantDefinition::isSampler ( ) const
inline

Definition at line 281 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isSampler ( GpuConstantType  c)
inlinestatic
bool Ogre::GpuConstantDefinition::isSubroutine ( ) const
inline

Definition at line 304 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isSubroutine ( GpuConstantType  c)
inlinestatic

Definition at line 309 of file OgreGpuProgramParams.h.

References Ogre::GCT_SUBROUTINE.

bool Ogre::GpuConstantDefinition::isUnsignedInt ( ) const
inline

Definition at line 243 of file OgreGpuProgramParams.h.

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

Member Data Documentation

size_t Ogre::GpuConstantDefinition::arraySize

Length of array.

Definition at line 158 of file OgreGpuProgramParams.h.

GpuConstantType Ogre::GpuConstantDefinition::constType

Data type.

Definition at line 149 of file OgreGpuProgramParams.h.

size_t Ogre::GpuConstantDefinition::elementSize

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

Definition at line 156 of file OgreGpuProgramParams.h.

size_t Ogre::GpuConstantDefinition::logicalIndex

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

Definition at line 153 of file OgreGpuProgramParams.h.

size_t Ogre::GpuConstantDefinition::physicalIndex

Physical start index in buffer (either float, double, int, or uint buffer)

Definition at line 151 of file OgreGpuProgramParams.h.

uint16 Ogre::GpuConstantDefinition::variability
mutable

How this parameter varies (bitwise combination of GpuProgramVariability)

Definition at line 160 of file OgreGpuProgramParams.h.


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