Rasteriser configuration class. More...

Inheritance diagram for Castor3D::RasteriserState:

Collaboration diagram for Castor3D::RasteriserState:

Public Member Functions
C3D_API	RasteriserState (Engine &p_engine)
	Constructor. More...

virtual C3D_API	~RasteriserState ()
	Destructor. More...

virtual C3D_API bool	Initialise ()=0
	Initialises the states. More...

virtual C3D_API void	Cleanup ()=0
	Cleans the states. More...

virtual C3D_API bool	Apply ()=0
	Applies the states. More...

Castor3D::eFILL_MODE	GetFillMode () const
	Retrieves the fill mode. More...

void	SetFillMode (Castor3D::eFILL_MODE p_mode)
	Sets the fill mode. More...

Castor3D::eFACE	GetCulledFaces () const
	Retrieves the culled faces. More...

void	SetCulledFaces (Castor3D::eFACE p_eFace)
	Sets the culled faces. More...

bool	GetFrontCCW () const
	Retrieves the faces considered front facing. More...

void	SetFrontCCW (bool p_bCCW)
	Sets the faces considered front facing. More...

bool	GetAntialiasedLines () const
	Retrieves the antialiased lines status. More...

void	SetAntialiasedLines (bool p_bAA)
	Sets the antialiased lines status. More...

float	GetDepthBias () const
	Retrieves the depth bias. More...

void	SetDepthBias (float p_fBias)
	Sets the depth bias. More...

bool	GetDepthClipping () const
	Retrieves the depth clipping status. More...

void	SetDepthClipping (bool p_enable)
	Sets the depth clipping status. More...

bool	GetMultisample () const
	Retrieves the multisample activation status. More...

void	SetMultisample (bool p_enable)
	Sets the multisample activation status. More...

bool	GetScissor () const
	Retrieves the scissor test activation status. More...

void	SetScissor (bool p_enable)
	Sets the scissor test activation status. More...

Protected Member Functions
C3D_API void	CreateCurrent ()
	Creates the state used to save the current state. More...

C3D_API void	DestroyCurrent ()
	Destroys the state used to save the current state. More...

virtual C3D_API RasteriserStateSPtr	DoCreateCurrent ()=0
	Creates the state used to save the current state. More...

Protected Attributes
bool	m_changed
	Tells it has changed. More...

eFILL_MODE	m_eFillMode
	The fill mode. More...

eFACE	m_eCulledFaces
	The culled faces. More...

bool	m_bFrontCCW
	The faces considered front facing. More...

bool	m_bAntialiasedLines
	The antialiased lines status. More...

float	m_fDepthBias
	The depth bias. More...

bool	m_bScissor
	The scissor test activation status. More...

bool	m_bDepthClipping
	The depth clipping status. More...

bool	m_bMultisampled
	The multisample activation status. More...

RasteriserStateSPtr	m_currentState
	Shared_pointer to the internal global state, to use reference counting for this static member. More...

Static Protected Attributes
static RasteriserStateWPtr	m_wCurrentState
	The internal global state used to commit only the changed states. More...

Detailed Description

Rasteriser configuration class.

Author: Sylvain DOREMUS

Version: 0.7.0

Date: 02/06/2013

Constructor & Destructor Documentation

◆ RasteriserState()

C3D_API Castor3D::RasteriserState::RasteriserState ( Engine & p_engine )

Constructor.

Parameters

[in] p_engine The engine.

◆ ~RasteriserState()

virtual C3D_API Castor3D::RasteriserState::~RasteriserState ( )

virtual

Destructor.

Member Function Documentation

◆ Apply()

virtual C3D_API bool Castor3D::RasteriserState::Apply ( )

pure virtual

Applies the states.

◆ Cleanup()

virtual C3D_API void Castor3D::RasteriserState::Cleanup ( )

pure virtual

Cleans the states.

◆ CreateCurrent()

C3D_API void Castor3D::RasteriserState::CreateCurrent ( )

protected

Creates the state used to save the current state.

◆ DestroyCurrent()

C3D_API void Castor3D::RasteriserState::DestroyCurrent ( )

protected

Destroys the state used to save the current state.

◆ DoCreateCurrent()

virtual C3D_API RasteriserStateSPtr Castor3D::RasteriserState::DoCreateCurrent ( )

protectedpure virtual

Creates the state used to save the current state.

◆ GetAntialiasedLines()

bool Castor3D::RasteriserState::GetAntialiasedLines ( ) const

inline

Retrieves the antialiased lines status.

Returns: The value

References m_bAntialiasedLines.

◆ GetCulledFaces()

Castor3D::eFACE Castor3D::RasteriserState::GetCulledFaces ( ) const

inline

Retrieves the culled faces.

Returns: The value

References m_eCulledFaces.

◆ GetDepthBias()

float Castor3D::RasteriserState::GetDepthBias ( ) const

inline

Retrieves the depth bias.

Returns: The value

References m_fDepthBias.

◆ GetDepthClipping()

bool Castor3D::RasteriserState::GetDepthClipping ( ) const

inline

Retrieves the depth clipping status.

Returns: The value

References m_bDepthClipping.

◆ GetFillMode()

Castor3D::eFILL_MODE Castor3D::RasteriserState::GetFillMode ( ) const

inline

Retrieves the fill mode.

Returns: The value

References m_eFillMode.

◆ GetFrontCCW()

bool Castor3D::RasteriserState::GetFrontCCW ( ) const

inline

Retrieves the faces considered front facing.

Returns: The value

References m_bFrontCCW.

◆ GetMultisample()

bool Castor3D::RasteriserState::GetMultisample ( ) const

inline

Retrieves the multisample activation status.

Returns: The value

References m_bMultisampled.

◆ GetScissor()

bool Castor3D::RasteriserState::GetScissor ( ) const

inline

Retrieves the scissor test activation status.

Returns: The value

References m_bScissor.

◆ Initialise()

virtual C3D_API bool Castor3D::RasteriserState::Initialise ( )

pure virtual

Initialises the states.

◆ SetAntialiasedLines()

void Castor3D::RasteriserState::SetAntialiasedLines ( bool p_bAA )

inline

Sets the antialiased lines status.

Parameters

[in] p_bAA The new value

References m_bAntialiasedLines, and m_changed.

◆ SetCulledFaces()

void Castor3D::RasteriserState::SetCulledFaces ( Castor3D::eFACE p_eFace )

inline

Sets the culled faces.

Parameters

[in] p_eFace The new value

References m_changed, and m_eCulledFaces.

◆ SetDepthBias()

void Castor3D::RasteriserState::SetDepthBias ( float p_fBias )

inline

Sets the depth bias.

Parameters

[in] p_fBias The new value

References m_changed, and m_fDepthBias.

◆ SetDepthClipping()

void Castor3D::RasteriserState::SetDepthClipping ( bool p_enable )

inline

Sets the depth clipping status.

Parameters

[in] p_enable The new value

References m_bDepthClipping, and m_changed.

◆ SetFillMode()

void Castor3D::RasteriserState::SetFillMode ( Castor3D::eFILL_MODE p_mode )

inline

Sets the fill mode.

Parameters

[in] p_mode The new value

References m_changed, and m_eFillMode.

◆ SetFrontCCW()

void Castor3D::RasteriserState::SetFrontCCW ( bool p_bCCW )

inline

Sets the faces considered front facing.

Parameters

[in] p_bCCW The new value

References m_bFrontCCW, and m_changed.

◆ SetMultisample()

void Castor3D::RasteriserState::SetMultisample ( bool p_enable )

inline

Sets the multisample activation status.

Parameters

[in] p_enable The new value

References m_bMultisampled, and m_changed.

◆ SetScissor()

void Castor3D::RasteriserState::SetScissor ( bool p_enable )

inline

Sets the scissor test activation status.

Parameters

[in] p_enable The new value

References m_bScissor, and m_changed.

Member Data Documentation

◆ m_bAntialiasedLines

bool Castor3D::RasteriserState::m_bAntialiasedLines

protected

The antialiased lines status.

Referenced by GetAntialiasedLines(), and SetAntialiasedLines().

◆ m_bDepthClipping

bool Castor3D::RasteriserState::m_bDepthClipping

protected

The depth clipping status.

Referenced by GetDepthClipping(), and SetDepthClipping().

◆ m_bFrontCCW

bool Castor3D::RasteriserState::m_bFrontCCW

protected

The faces considered front facing.

Referenced by GetFrontCCW(), and SetFrontCCW().

◆ m_bMultisampled

bool Castor3D::RasteriserState::m_bMultisampled

protected

The multisample activation status.

Referenced by GetMultisample(), and SetMultisample().

◆ m_bScissor

bool Castor3D::RasteriserState::m_bScissor

protected

The scissor test activation status.

Referenced by GetScissor(), and SetScissor().

◆ m_changed

bool Castor3D::RasteriserState::m_changed

protected

Tells it has changed.

Referenced by SetAntialiasedLines(), SetCulledFaces(), SetDepthBias(), SetDepthClipping(), SetFillMode(), SetFrontCCW(), SetMultisample(), and SetScissor().

◆ m_currentState

RasteriserStateSPtr Castor3D::RasteriserState::m_currentState

protected

Shared_pointer to the internal global state, to use reference counting for this static member.

◆ m_eCulledFaces

eFACE Castor3D::RasteriserState::m_eCulledFaces

protected

The culled faces.

Referenced by GetCulledFaces(), and SetCulledFaces().

◆ m_eFillMode

eFILL_MODE Castor3D::RasteriserState::m_eFillMode

protected

The fill mode.

Referenced by GetFillMode(), and SetFillMode().

◆ m_fDepthBias

float Castor3D::RasteriserState::m_fDepthBias

protected

The depth bias.

Referenced by GetDepthBias(), and SetDepthBias().

◆ m_wCurrentState

RasteriserStateWPtr Castor3D::RasteriserState::m_wCurrentState

staticprotected

The internal global state used to commit only the changed states.

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/RasteriserState.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RasteriserState()

◆ ~RasteriserState()

Member Function Documentation

◆ Apply()

◆ Cleanup()

◆ CreateCurrent()

◆ DestroyCurrent()

◆ DoCreateCurrent()

◆ GetAntialiasedLines()

◆ GetCulledFaces()

◆ GetDepthBias()

◆ GetDepthClipping()

◆ GetFillMode()

◆ GetFrontCCW()

◆ GetMultisample()

◆ GetScissor()

◆ Initialise()

◆ SetAntialiasedLines()

◆ SetCulledFaces()

◆ SetDepthBias()

◆ SetDepthClipping()

◆ SetFillMode()

◆ SetFrontCCW()

◆ SetMultisample()

◆ SetScissor()

Member Data Documentation

◆ m_bAntialiasedLines

◆ m_bDepthClipping

◆ m_bFrontCCW

◆ m_bMultisampled

◆ m_bScissor

◆ m_changed

◆ m_currentState

◆ m_eCulledFaces

◆ m_eFillMode

◆ m_fDepthBias

◆ m_wCurrentState