PixelLightAPI  .
Public Member Functions
PLRenderer::RenderStates Class Reference

Render states RTTI wrapper class. More...

#include <RenderStates.h>

Inheritance diagram for PLRenderer::RenderStates:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PLRENDERER_API RenderStates ()
 Constructor.
PLRENDERER_API RenderStates (const RenderStates &cSource)
 Copy constructor.
virtual PLRENDERER_API ~RenderStates ()
 Destructor.
PLCore::uint32 Get (RenderState::Enum nState) const
 Retrieves a render-state value.
bool Set (RenderState::Enum nState, PLCore::uint32 nValue)
 Sets a single render-state parameter.
RenderStatesoperator= (const RenderStates &cSource)
 Copy operator.

Detailed Description

Render states RTTI wrapper class.


Constructor & Destructor Documentation

Constructor.

PLRENDERER_API PLRenderer::RenderStates::RenderStates ( const RenderStates cSource)

Copy constructor.

Parameters:
[in]cSourceSource to copy from
virtual PLRENDERER_API PLRenderer::RenderStates::~RenderStates ( ) [virtual]

Destructor.


Member Function Documentation

PLCore::uint32 PLRenderer::RenderStates::Get ( RenderState::Enum  nState) const [inline]

Retrieves a render-state value.

Parameters:
[in]nStateState 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 like stencil, fog and scissor test aren't set by the material through the default setting
bool PLRenderer::RenderStates::Set ( RenderState::Enum  nState,
PLCore::uint32  nValue 
) [inline]

Sets a single render-state parameter.

Parameters:
[in]nStateState variable that is being modified. This parameter can be any member of the render state enumerated type.
[in]nValueNew 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 Shade, the second parameter must be one member of the Shade enumerated type. (e.g. Shade::Flat) You can also set the value to unknown - then this state is ignored.
Returns:
'true' if all went fine, else 'false'
RenderStates & PLRenderer::RenderStates::operator= ( const RenderStates cSource) [inline]

Copy operator.

Parameters:
[in]cSourceSource to copy from
Returns:
This class

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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:39
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported