AngelOgre::GpuProgramParametersPtr Class Reference

Description

A shared pointer to a set of shader parameters (uniforms).

Binding of Ogre::GpuProgramParametersSharedPtr.

Remarks

Obtain one with Pass::getVertexProgramParameters(), Pass::getFragmentProgramParameters() etc.

Errors (e.g. unknown constant name) are forwarded as SE_GENERIC_EXCEPTION_CAUGHT script events.

Definition at line 18 of file AngelOgre_GpuProgramParametersPtr.h.

Public Member Functions
	GpuProgramParametersPtr ()
	GpuProgramParametersPtr (const GpuProgramParametersPtr &in other)
GpuProgramParametersPtr &	opAssign (const GpuProgramParametersPtr &in other)
bool	isNull ()
array< string >	__getNamedConstants ()
Set constant by index
The index is the constant register (a 4-float slot); arrays are written to consecutive memory starting there.
void	setConstant (uint index, float val)
void	setConstant (uint index, const vector3 &val)
void	setConstant (uint index, const vector2 &val)
void	setConstant (uint index, const color &val)
void	setConstant (uint index, const array< float >@ vals)
void	setConstant (uint index, const array< vector3 >@ vals)
void	setConstant (uint index, const array< vector2 >@ vals)
void	setConstant (uint index, const array< color >@ vals)
Set constant by name
The name is the uniform name as declared in the shader.
void	setNamedConstant (const string &in name, float val)
void	setNamedConstant (const string &in name, const vector3 &val)
void	setNamedConstant (const string &in name, const vector2 &val)
void	setNamedConstant (const string &in name, const color &val)
void	setNamedConstant (const string &in name, const array< float >@ vals)
void	setNamedConstant (const string &in name, const array< vector3 >@ vals)
void	setNamedConstant (const string &in name, const array< vector2 >@ vals)
void	setNamedConstant (const string &in name, const array< color >@ vals)

Constructor & Destructor Documentation

GpuProgramParametersPtr() [1/2]

AngelOgre::GpuProgramParametersPtr::GpuProgramParametersPtr

(

)

Creates an empty (null) pointer.

GpuProgramParametersPtr() [2/2]

AngelOgre::GpuProgramParametersPtr::GpuProgramParametersPtr

(

const GpuProgramParametersPtr &in

other

)

Creates a copy pointing to the same parameters.

Member Function Documentation

__getNamedConstants()

array< string > AngelOgre::GpuProgramParametersPtr::__getNamedConstants

(

)

Experimental: returns names of all named constants (uniforms) of the program.

isNull()

bool AngelOgre::GpuProgramParametersPtr::isNull

(

)

Returns true if the pointer doesn't point to anything.

opAssign()

GpuProgramParametersPtr & AngelOgre::GpuProgramParametersPtr::opAssign

(

const GpuProgramParametersPtr &in

other

)

setConstant() [1/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const array< color >@	vals
	)

setConstant() [2/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const array< float >@	vals
	)

setConstant() [3/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const array< vector2 >@	vals
	)

setConstant() [4/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const array< vector3 >@	vals
	)

setConstant() [5/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const color &	val
	)

setConstant() [6/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const vector2 &	val
	)

setConstant() [7/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		const vector3 &	val
	)

setConstant() [8/8]

void AngelOgre::GpuProgramParametersPtr::setConstant	(	uint	index,
		float	val
	)

setNamedConstant() [1/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const array< color >@	vals
	)

setNamedConstant() [2/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const array< float >@	vals
	)

setNamedConstant() [3/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const array< vector2 >@	vals
	)

setNamedConstant() [4/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const array< vector3 >@	vals
	)

setNamedConstant() [5/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const color &	val
	)

setNamedConstant() [6/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const vector2 &	val
	)

setNamedConstant() [7/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		const vector3 &	val
	)

setNamedConstant() [8/8]

void AngelOgre::GpuProgramParametersPtr::setNamedConstant	(	const string &in	name,
		float	val
	)

---

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

• doc/angelscript/Script2Game/AngelOgre/AngelOgre_GpuProgramParametersPtr.h