Ogre::GpuConstantDefinition Struct Reference

Information about predefined program constants. More...

#include <OgreGpuProgramParams.h>

Inheritance diagram for Ogre::GpuConstantDefinition:

List of all members.

Public Member Functions
	GpuConstantDefinition ()
bool	isDouble () const
bool	isFloat () const
bool	isSampler () const
bool	isSubroutine () const
Static Public Member Functions
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.
static bool	isDouble (GpuConstantType c)
static bool	isFloat (GpuConstantType c)
static bool	isSampler (GpuConstantType c)
static bool	isSubroutine (GpuConstantType c)
Public Attributes
size_t	arraySize
	Length of array.
GpuConstantType	constType
	Data type.
size_t	elementSize
	Number of raw buffer 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 start index in buffer (either float, double or int 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.

Definition at line 122 of file OgreGpuProgramParams.h.

---

Constructor & Destructor Documentation

Ogre::GpuConstantDefinition::GpuConstantDefinition

(

)

Definition at line 343 of file OgreGpuProgramParams.h.

---

Member Function Documentation

static size_t Ogre::GpuConstantDefinition::getElementSize	(	GpuConstantType	ctype,
		bool	padToMultiplesOf4
	)		[static]

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

SM1 and D3D does, GLSL doesn't)

Definition at line 232 of file OgreGpuProgramParams.h.

References 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, and Ogre::GCT_SAMPLERCUBE.

bool Ogre::GpuConstantDefinition::isDouble

(

)

const

Definition at line 165 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isDouble

(

GpuConstantType

c

)

[static]

Definition at line 170 of file OgreGpuProgramParams.h.

References 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_SAMPLER1D, Ogre::GCT_SAMPLER1DSHADOW, Ogre::GCT_SAMPLER2D, Ogre::GCT_SAMPLER2DARRAY, Ogre::GCT_SAMPLER2DSHADOW, Ogre::GCT_SAMPLER3D, and Ogre::GCT_SAMPLERCUBE.

bool Ogre::GpuConstantDefinition::isFloat

(

)

const

Definition at line 138 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isFloat

(

GpuConstantType

c

)

[static]

Definition at line 143 of file OgreGpuProgramParams.h.

References Ogre::GCT_INT1, Ogre::GCT_INT2, Ogre::GCT_INT3, Ogre::GCT_INT4, Ogre::GCT_SAMPLER1D, Ogre::GCT_SAMPLER1DSHADOW, Ogre::GCT_SAMPLER2D, Ogre::GCT_SAMPLER2DARRAY, Ogre::GCT_SAMPLER2DSHADOW, Ogre::GCT_SAMPLER3D, and Ogre::GCT_SAMPLERCUBE.

bool Ogre::GpuConstantDefinition::isSampler

(

)

const

Definition at line 196 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isSampler

(

GpuConstantType

c

)

[static]

Definition at line 201 of file OgreGpuProgramParams.h.

References Ogre::GCT_SAMPLER1D, Ogre::GCT_SAMPLER1DSHADOW, Ogre::GCT_SAMPLER2D, Ogre::GCT_SAMPLER2DARRAY, Ogre::GCT_SAMPLER2DSHADOW, Ogre::GCT_SAMPLER3D, and Ogre::GCT_SAMPLERCUBE.

bool Ogre::GpuConstantDefinition::isSubroutine

(

)

const

Definition at line 219 of file OgreGpuProgramParams.h.

static bool Ogre::GpuConstantDefinition::isSubroutine

(

GpuConstantType

c

)

[static]

Definition at line 224 of file OgreGpuProgramParams.h.

References Ogre::GCT_SUBROUTINE.

---

Member Data Documentation

size_t Ogre::GpuConstantDefinition::arraySize

Length of array.

Definition at line 134 of file OgreGpuProgramParams.h.

GpuConstantType Ogre::GpuConstantDefinition::constType

Data type.

Definition at line 125 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 132 of file OgreGpuProgramParams.h.

size_t Ogre::GpuConstantDefinition::logicalIndex

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

Definition at line 129 of file OgreGpuProgramParams.h.

size_t Ogre::GpuConstantDefinition::physicalIndex

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

Definition at line 127 of file OgreGpuProgramParams.h.

uint16 Ogre::GpuConstantDefinition::variability [mutable]

How this parameter varies (bitwise combination of GpuProgramVariability)

Definition at line 136 of file OgreGpuProgramParams.h.

---

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

• OgreGpuProgramParams.h