PLRenderer::Parameter Class Reference

Parameters are used for material/effect parameters. More...

#include <Parameter.h>

List of all members.

Public Member Functions
ParameterManager &	GetManager () const
	Returns the parameter manager this parameter is in.
PLRENDERER_API bool	SetManagerParameterValue (Parameters &cManager, const PLCore::String &sName) const
	Sets the value of this parameter to a parameter within the given manager.
PLRENDERER_API bool	SetManagerParameterValue (Program &cProgram, const PLCore::String &sName) const
	Sets the value of this parameter to a parameter within the given GPU program.
Parameters::EDataType	GetType () const
	Get the parameter type.
PLCore::String	GetName () const
	Get the parameter name.
PLRENDERER_API bool	SetName (const PLCore::String &sName)
	Set the parameter name.
PLRENDERER_API PLCore::String	GetParameterString () const
	Returns a parameter value as string (e.g. "1.0 5.4 0.21")
PLRENDERER_API bool	SetParameterString (const PLCore::String &sValue)
	Sets a parameter value from a string (e.g. "1.0 5.4 0.21")
bool	GetValue1i (int &nX) const
int	GetValue1i () const
PLRENDERER_API bool	SetValue1i (int nX)
bool	GetValue2i (int &nX, int &nY) const
const int *	GetValue2iv () const
PLRENDERER_API bool	SetValue2i (int nX, int nY)
PLRENDERER_API bool	SetValue2iv (const int nValue[])
bool	GetValue3i (int &nX, int &nY, int &nZ) const
const int *	GetValue3iv () const
PLRENDERER_API bool	SetValue3i (int nX, int nY, int nZ)
PLRENDERER_API bool	SetValue3iv (const int nValue[])
bool	GetValue4i (int &nX, int &nY, int &nZ, int &nW) const
const int *	GetValue4iv () const
PLRENDERER_API bool	SetValue4i (int nX, int nY, int nZ, int nW)
PLRENDERER_API bool	SetValue4iv (const int nValue[])
bool	GetValue1f (float &fX) const
float	GetValue1f () const
PLRENDERER_API bool	SetValue1f (float fX)
bool	GetValue2f (float &fX, float &fY) const
const float *	GetValue2fv () const
PLRENDERER_API bool	SetValue2f (float fX, float fY)
PLRENDERER_API bool	SetValue2fv (const float fValue[])
bool	GetValue3f (float &fX, float &fY, float &fZ) const
const float *	GetValue3fv () const
PLRENDERER_API bool	SetValue3f (float fX, float fY, float fZ)
PLRENDERER_API bool	SetValue3fv (const float fValue[])
bool	GetValue4f (float &fX, float &fY, float &fZ, float &fW) const
const float *	GetValue4fv () const
PLRENDERER_API bool	SetValue4f (float fX, float fY, float fZ, float fW)
PLRENDERER_API bool	SetValue4fv (const float fValue[])
bool	GetValue1d (double &fW) const
PLRENDERER_API bool	SetValue1d (double fW)
bool	GetValue2d (double &fX, double &fY) const
const double *	GetValue2dv () const
PLRENDERER_API bool	SetValue2d (double fX, double fY)
PLRENDERER_API bool	SetValue2dv (const double fValue[])
bool	GetValue3d (double &fX, double &fY, double &fZ) const
const double *	GetValue3dv () const
PLRENDERER_API bool	SetValue3d (double fX, double fY, double fZ)
PLRENDERER_API bool	SetValue3dv (const double fValue[])
bool	GetValue4d (double &fX, double &fY, double &fZ, double &fW) const
const double *	GetValue4dv () const
PLRENDERER_API bool	SetValue4d (double fX, double fY, double fZ, double fW)
PLRENDERER_API bool	SetValue4dv (const double fValue[])
const float *	GetValueFloat3x3 () const
PLRENDERER_API bool	SetValueFloat3x3 (const float fValue[])
const float *	GetValueFloat3x4 () const
PLRENDERER_API bool	SetValueFloat3x4 (const float fValue[])
const float *	GetValueMatrixfv () const
PLRENDERER_API bool	SetValueMatrixfv (const float fValue[])
const double *	GetValueMatrixdv () const
PLRENDERER_API bool	SetValueMatrixdv (const double fValue[])
PLRENDERER_API Texture *	GetValueTexture () const
PLRENDERER_API TextureBuffer *	GetValueTextureBuffer () const
TextureHandler *	GetValueTextureHandler () const
PLRENDERER_API bool	SetValueTexture (Texture *pTexture)
PLRENDERER_API bool	SetValueTexture (const PLCore::String &sFilename)

---

Detailed Description

Parameters are used for material/effect parameters.

Note:

• You can only use the functions of the given parameter type!

---

Member Function Documentation

ParameterManager & PLRenderer::Parameter::GetManager

(

)

const [inline]

Returns the parameter manager this parameter is in.

Returns:

The parameter manager this parameter is in

PLRENDERER_API bool PLRenderer::Parameter::SetManagerParameterValue	(	Parameters &	cManager,
		const PLCore::String &	sName
	)		const

Sets the value of this parameter to a parameter within the given manager.

Parameters:

[in]	cManager	Parameter manager to use
[in]	sName	Name of the parameter within the given manager

Returns:

'true' if all went fine, else 'false' (maybe incompatible parameter types?)

PLRENDERER_API bool PLRenderer::Parameter::SetManagerParameterValue	(	Program &	cProgram,
		const PLCore::String &	sName
	)		const

Sets the value of this parameter to a parameter within the given GPU program.

Parameters:

[in]	cProgram	GPU program to use
[in]	sName	Name of the parameter within the given manager

Returns:

'true' if all went fine, else 'false' (maybe incompatible parameter types?)

Parameters::EDataType PLRenderer::Parameter::GetType

(

)

const [inline]

Get the parameter type.

Returns:

Parameter type, NEVER Parameters::UnknownDataType!

PLCore::String PLRenderer::Parameter::GetName

(

)

const [inline]

Get the parameter name.

Returns:

Parameter name

PLRENDERER_API bool PLRenderer::Parameter::SetName

(

const PLCore::String &

sName

)

Set the parameter name.

Parameters:

[in]

sName

New parameter name

Returns:

'true' if all went fine and the parameter name was changed, else 'false' (maybe the given name is empty or there's already a parameter with this name within the parameter manager this parameter is in)

PLRENDERER_API PLCore::String PLRenderer::Parameter::GetParameterString

(

)

const

Returns a parameter value as string (e.g. "1.0 5.4 0.21")

Returns:

The value of the parameter as string, empty string on error

Note:

• Not that performant, try to avoid using this multiple times within each frame

PLRENDERER_API bool PLRenderer::Parameter::SetParameterString

(

const PLCore::String &

sValue

)

Sets a parameter value from a string (e.g. "1.0 5.4 0.21")

param[in] sValue New parameter value

Returns:

'true' if all went fine, else 'false' (maybe unknown parameter)

See also:

• GetParameterString()

bool PLRenderer::Parameter::GetValue1i

(

int &

nX

)

const [inline]

int PLRenderer::Parameter::GetValue1i

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue1i

(

int

nX

)

bool PLRenderer::Parameter::GetValue2i	(	int &	nX,
		int &	nY
	)		const [inline]

const int * PLRenderer::Parameter::GetValue2iv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue2i	(	int	nX,
		int	nY
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue2iv

(

const int

nValue[]

)

bool PLRenderer::Parameter::GetValue3i	(	int &	nX,
		int &	nY,
		int &	nZ
	)		const [inline]

const int * PLRenderer::Parameter::GetValue3iv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue3i	(	int	nX,
		int	nY,
		int	nZ
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue3iv

(

const int

nValue[]

)

bool PLRenderer::Parameter::GetValue4i	(	int &	nX,
		int &	nY,
		int &	nZ,
		int &	nW
	)		const [inline]

const int * PLRenderer::Parameter::GetValue4iv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue4i	(	int	nX,
		int	nY,
		int	nZ,
		int	nW
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue4iv

(

const int

nValue[]

)

bool PLRenderer::Parameter::GetValue1f

(

float &

fX

)

const [inline]

float PLRenderer::Parameter::GetValue1f

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue1f

(

float

fX

)

bool PLRenderer::Parameter::GetValue2f	(	float &	fX,
		float &	fY
	)		const [inline]

const float * PLRenderer::Parameter::GetValue2fv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue2f	(	float	fX,
		float	fY
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue2fv

(

const float

fValue[]

)

bool PLRenderer::Parameter::GetValue3f	(	float &	fX,
		float &	fY,
		float &	fZ
	)		const [inline]

const float * PLRenderer::Parameter::GetValue3fv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue3f	(	float	fX,
		float	fY,
		float	fZ
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue3fv

(

const float

fValue[]

)

bool PLRenderer::Parameter::GetValue4f	(	float &	fX,
		float &	fY,
		float &	fZ,
		float &	fW
	)		const [inline]

const float * PLRenderer::Parameter::GetValue4fv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue4f	(	float	fX,
		float	fY,
		float	fZ,
		float	fW
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue4fv

(

const float

fValue[]

)

bool PLRenderer::Parameter::GetValue1d

(

double &

fW

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue1d

(

double

fW

)

bool PLRenderer::Parameter::GetValue2d	(	double &	fX,
		double &	fY
	)		const [inline]

const double * PLRenderer::Parameter::GetValue2dv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue2d	(	double	fX,
		double	fY
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue2dv

(

const double

fValue[]

)

bool PLRenderer::Parameter::GetValue3d	(	double &	fX,
		double &	fY,
		double &	fZ
	)		const [inline]

const double * PLRenderer::Parameter::GetValue3dv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue3d	(	double	fX,
		double	fY,
		double	fZ
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue3dv

(

const double

fValue[]

)

bool PLRenderer::Parameter::GetValue4d	(	double &	fX,
		double &	fY,
		double &	fZ,
		double &	fW
	)		const [inline]

const double * PLRenderer::Parameter::GetValue4dv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValue4d	(	double	fX,
		double	fY,
		double	fZ,
		double	fW
	)

PLRENDERER_API bool PLRenderer::Parameter::SetValue4dv

(

const double

fValue[]

)

const float * PLRenderer::Parameter::GetValueFloat3x3

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValueFloat3x3

(

const float

fValue[]

)

const float * PLRenderer::Parameter::GetValueFloat3x4

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValueFloat3x4

(

const float

fValue[]

)

const float * PLRenderer::Parameter::GetValueMatrixfv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValueMatrixfv

(

const float

fValue[]

)

const double * PLRenderer::Parameter::GetValueMatrixdv

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValueMatrixdv

(

const double

fValue[]

)

PLRENDERER_API Texture* PLRenderer::Parameter::GetValueTexture

(

)

const

PLRENDERER_API TextureBuffer* PLRenderer::Parameter::GetValueTextureBuffer

(

)

const

TextureHandler * PLRenderer::Parameter::GetValueTextureHandler

(

)

const [inline]

PLRENDERER_API bool PLRenderer::Parameter::SetValueTexture

(

Texture *

pTexture

)

PLRENDERER_API bool PLRenderer::Parameter::SetValueTexture

(

const PLCore::String &

sFilename

)

---

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

• Parameter.h
• Parameter.inl