PLRenderer::FixedFunctionsRenderStates Class Reference

Fixed functions render states RTTI wrapper class. More...

#include <FixedFunctionsRenderStates.h>

Inheritance diagram for PLRenderer::FixedFunctionsRenderStates:

List of all members.

Public Member Functions
PLRENDERER_API bool	GetFogEnable () const
PLRENDERER_API void	SetFogEnable (bool bValue)
PLRENDERER_API PLGraphics::Color4	GetFogColor () const
PLRENDERER_API void	SetFogColor (const PLGraphics::Color4 &cValue)
PLRENDERER_API float	GetFogDensity () const
PLRENDERER_API void	SetFogDensity (float fValue)
PLRENDERER_API float	GetFogStart () const
PLRENDERER_API void	SetFogStart (float fValue)
PLRENDERER_API float	GetFogEnd () const
PLRENDERER_API void	SetFogEnd (float fValue)
PLRENDERER_API FixedFunctions::Fog::Enum	GetFogMode () const
PLRENDERER_API void	SetFogMode (FixedFunctions::Fog::Enum nValue)
PLRENDERER_API bool	GetAlphaTestEnable () const
PLRENDERER_API void	SetAlphaTestEnable (bool bValue)
PLRENDERER_API Compare::Enum	GetAlphaTestFunction () const
PLRENDERER_API void	SetAlphaTestFunction (Compare::Enum nValue)
PLRENDERER_API float	GetAlphaTestReference () const
PLRENDERER_API void	SetAlphaTestReference (float fValue)
PLRENDERER_API bool	GetLighting () const
PLRENDERER_API void	SetLighting (bool bValue)
PLRENDERER_API PLGraphics::Color4	GetAmbient () const
PLRENDERER_API void	SetAmbient (const PLGraphics::Color4 &cValue)
PLRENDERER_API bool	GetNormalizeNormals () const
PLRENDERER_API void	SetNormalizeNormals (bool bValue)
PLRENDERER_API FixedFunctions::Shade::Enum	GetShadeMode () const
PLRENDERER_API void	SetShadeMode (FixedFunctions::Shade::Enum nValue)
PLRENDERER_API	FixedFunctionsRenderStates ()
	Constructor.
PLRENDERER_API	FixedFunctionsRenderStates (const FixedFunctionsRenderStates &cSource)
	Copy constructor.
virtual PLRENDERER_API	~FixedFunctionsRenderStates ()
	Destructor.
PLRENDERER_API PLCore::uint32	Get (FixedFunctions::RenderState::Enum nState) const
	Retrieves a render-state value.
PLRENDERER_API bool	Set (FixedFunctions::RenderState::Enum nState, PLCore::uint32 nValue)
	Sets a single render-state parameter.
PLRENDERER_API FixedFunctionsRenderStates &	operator= (const FixedFunctionsRenderStates &cSource)
	Copy operator.

---

Detailed Description

Fixed functions render states RTTI wrapper class.

---

Constructor & Destructor Documentation

PLRENDERER_API PLRenderer::FixedFunctionsRenderStates::FixedFunctionsRenderStates

(

)

Constructor.

PLRENDERER_API PLRenderer::FixedFunctionsRenderStates::FixedFunctionsRenderStates

(

const FixedFunctionsRenderStates &

cSource

)

Copy constructor.

Parameters:

[in]

cSource

Source to copy from

virtual PLRENDERER_API PLRenderer::FixedFunctionsRenderStates::~FixedFunctionsRenderStates

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLRENDERER_API bool PLRenderer::FixedFunctionsRenderStates::GetFogEnable

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogEnable

(

bool

bValue

)

PLRENDERER_API PLGraphics::Color4 PLRenderer::FixedFunctionsRenderStates::GetFogColor

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogColor

(

const PLGraphics::Color4 &

cValue

)

PLRENDERER_API float PLRenderer::FixedFunctionsRenderStates::GetFogDensity

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogDensity

(

float

fValue

)

PLRENDERER_API float PLRenderer::FixedFunctionsRenderStates::GetFogStart

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogStart

(

float

fValue

)

PLRENDERER_API float PLRenderer::FixedFunctionsRenderStates::GetFogEnd

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogEnd

(

float

fValue

)

PLRENDERER_API FixedFunctions::Fog::Enum PLRenderer::FixedFunctionsRenderStates::GetFogMode

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetFogMode

(

FixedFunctions::Fog::Enum

nValue

)

PLRENDERER_API bool PLRenderer::FixedFunctionsRenderStates::GetAlphaTestEnable

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetAlphaTestEnable

(

bool

bValue

)

PLRENDERER_API Compare::Enum PLRenderer::FixedFunctionsRenderStates::GetAlphaTestFunction

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetAlphaTestFunction

(

Compare::Enum

nValue

)

PLRENDERER_API float PLRenderer::FixedFunctionsRenderStates::GetAlphaTestReference

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetAlphaTestReference

(

float

fValue

)

PLRENDERER_API bool PLRenderer::FixedFunctionsRenderStates::GetLighting

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetLighting

(

bool

bValue

)

PLRENDERER_API PLGraphics::Color4 PLRenderer::FixedFunctionsRenderStates::GetAmbient

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetAmbient

(

const PLGraphics::Color4 &

cValue

)

PLRENDERER_API bool PLRenderer::FixedFunctionsRenderStates::GetNormalizeNormals

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetNormalizeNormals

(

bool

bValue

)

PLRENDERER_API FixedFunctions::Shade::Enum PLRenderer::FixedFunctionsRenderStates::GetShadeMode

(

)

const

PLRENDERER_API void PLRenderer::FixedFunctionsRenderStates::SetShadeMode

(

FixedFunctions::Shade::Enum

nValue

)

PLRENDERER_API PLCore::uint32 PLRenderer::FixedFunctionsRenderStates::Get

(

FixedFunctions::RenderState::Enum

nState

)

const

Retrieves a render-state value.

Parameters:

[in]

nState

State variable that is being queried. This parameter can be any member of the render state enumerated type.

Returns:

The value of the queried render state variable

Note:

• Some settings aren't set by the material through the default setting

PLRENDERER_API bool PLRenderer::FixedFunctionsRenderStates::Set	(	FixedFunctions::RenderState::Enum	nState,
		PLCore::uint32	nValue
	)

Sets a single render-state parameter.

Parameters:

[in]	nState	State variable that is being modified. This parameter can be any member of the render state enumerated type.
[in]	nValue	New value for the render state to be set. The meaning of this parameter is dependent on the value specified for nState. For example, if nState is FogMode, the second parameter must be one member of the FogMode enumerated type. (e.g. Fog::Exp) You can also set the value to unknown - then this state is ignored.

Returns:

'true' if all went fine, else 'false'

PLRENDERER_API FixedFunctionsRenderStates& PLRenderer::FixedFunctionsRenderStates::operator=

(

const FixedFunctionsRenderStates &

cSource

)

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This class

---

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

• FixedFunctionsRenderStates.h