Classe de configuration des buffers de profondeur et stencil. Plus de détails...

Graphe d'héritage de Castor3D::DepthStencilState:

Graphe de collaboration de Castor3D::DepthStencilState:

Classes
struct	stSTENCIL
	Fonction et opérations de stencil. Plus de détails...

Fonctions membres publiques
C3D_API	DepthStencilState (Engine &p_engine)
	Constructeur. Plus de détails...

virtual C3D_API	~DepthStencilState ()
	Destructeur. Plus de détails...

virtual C3D_API bool	Initialise ()=0
	Initialise les états. Plus de détails...

virtual C3D_API void	Cleanup ()=0
	Nettoie les états. Plus de détails...

virtual C3D_API bool	Apply ()=0
	Applique les états. Plus de détails...

void	SetDepthTest (bool p_enable)
	Définit le statut du test de profondeur. Plus de détails...

bool	GetDepthTest () const
	Récupère le statut du test de profondeur. Plus de détails...

void	SetDepthFunc (eDEPTH_FUNC p_func)
	Définit la fonction de profondeur. Plus de détails...

eDEPTH_FUNC	GetDepthFunc () const
	Récupère la fonction de profondeur. Plus de détails...

void	SetDepthRange (double p_near, double p_far)
	Définit l'intervalle profondeur. Plus de détails...

double	GetDepthNear () const
	Récupère la valeur proche pour la profondeur. Plus de détails...

double	GetDepthFar () const
	Récupère la valeur lointaine pour la profondeur. Plus de détails...

void	SetDepthMask (eWRITING_MASK p_eMask)
	Définit le masque d'écriture de la profondeur. Plus de détails...

eWRITING_MASK	GetDepthMask () const
	Récupère le masque d'écriture de la profondeur. Plus de détails...

void	SetStencilTest (bool p_enable)
	Définit le statut du test de stencil. Plus de détails...

bool	GetStencilTest () const
	Récupère le statut du test de stencil. Plus de détails...

void	SetStencilReadMask (uint32_t p_uiMask)
	Définit le masque de lecture du stencil. Plus de détails...

uint32_t	GetStencilReadMask () const
	Récupère le masque de lecture du stencil. Plus de détails...

void	SetStencilWriteMask (uint32_t p_uiMask)
	Définit le masque d'écriture du stencil. Plus de détails...

uint32_t	GetStencilWriteMask () const
	Récupère le masque d'écriture du stencil. Plus de détails...

void	SetStencilFrontRef (uint32_t p_ref)
	Définit la valeur de référence de stencil pour les faces avant. Plus de détails...

uint32_t	GetStencilFrontRef () const
	Récupère la valeur de référence de stencil pour les faces avant. Plus de détails...

void	SetStencilFrontFunc (eSTENCIL_FUNC p_func)
	Définit la fonction de stencil pour les faces avant. Plus de détails...

eSTENCIL_FUNC	GetStencilFrontFunc () const
	Récupère la fonction de stencil pour les faces avant. Plus de détails...

void	SetStencilFrontFailOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de l'échec du test de stencil, pour les faces avant. Plus de détails...

eSTENCIL_OP	GetStencilFrontFailOp () const
	Récupère l'opération lors de l'échec du test de stencil, pour les faces avant. Plus de détails...

void	SetStencilFrontDepthFailOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces avant. Plus de détails...

eSTENCIL_OP	GetStencilFrontDepthFailOp () const
	Récupère l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces avant. Plus de détails...

void	SetStencilFrontPassOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces avant. Plus de détails...

eSTENCIL_OP	GetStencilFrontPassOp () const
	Récupère l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces avant. Plus de détails...

void	SetStencilBackRef (uint32_t p_ref)
	Définit la valeur de référence de stencil pour les faces arrières. Plus de détails...

uint32_t	GetStencilBackRef () const
	Récupère la valeur de référence de stencil pour les faces arrières. Plus de détails...

void	SetStencilBackFunc (eSTENCIL_FUNC p_func)
	Définit la fonction de stencil pour les faces arrières. Plus de détails...

eSTENCIL_FUNC	GetStencilBackFunc () const
	Récupère la fonction de stencil pour les faces arrières. Plus de détails...

void	SetStencilBackFailOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de l'échec du test de stencil, pour les faces arrières. Plus de détails...

eSTENCIL_OP	GetStencilBackFailOp () const
	Récupère l'opération lors de l'échec du test de stencil, pour les faces arrières. Plus de détails...

void	SetStencilBackDepthFailOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces arrières. Plus de détails...

eSTENCIL_OP	GetStencilBackDepthFailOp () const
	Récupère l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces arrières. Plus de détails...

void	SetStencilBackPassOp (eSTENCIL_OP p_eOp)
	Définit l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces arrières. Plus de détails...

eSTENCIL_OP	GetStencilBackPassOp () const
	Récupère l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces arrières. Plus de détails...

Fonctions membres protégées
C3D_API void	CreateCurrent ()
	Crée l'état utilisé pour stocker l'état courant. Plus de détails...

C3D_API void	DestroyCurrent ()
	Détruit l'état utilisé pour stocker l'état courant. Plus de détails...

virtual C3D_API DepthStencilStateSPtr	DoCreateCurrent ()=0
	Crée l'état utilisé pour stocker l'état courant. Plus de détails...

Attributs protégés
bool	m_changed
	Dit que l'état a changé Plus de détails...

bool	m_bDepthTest
	Dit si oui on non le test de profondeur est activé Plus de détails...

eDEPTH_FUNC	m_eDepthFunc
	La fonction du test de profondeur. Plus de détails...

double	m_dDepthNear
	Le plan proche pour le test de profondeur. Plus de détails...

double	m_dDepthFar
	Le plan lointain pour le test de profondeur. Plus de détails...

eWRITING_MASK	m_eDepthMask
	Masque d'écriture de la profondeur. Plus de détails...

bool	m_bStencilTest
	Dit si le test stencil est activé ou non. Plus de détails...

uint32_t	m_uiStencilReadMask
	Le masque de lecture du stencil. Plus de détails...

uint32_t	m_uiStencilWriteMask
	Le masque d'écriture du stencil. Plus de détails...

stSTENCIL	m_stStencilFront
	Fonction stencil du tampon de premier plan. Plus de détails...

stSTENCIL	m_stStencilBack
	Fonction stencil du tampon d'arrière plan. Plus de détails...

DepthStencilStateSPtr	m_currentState
	Pointeur partag2 sur l'état interne global, utilisé pour avoir le comptage de références pour ce membre statique. Plus de détails...

Attributs protégés statiques
static DepthStencilStateWPtr	m_wCurrentState
	Etat interne global, utilisé pour n'appliquer que les changements d'état. Plus de détails...

Description détaillée

Classe de configuration des buffers de profondeur et stencil.

Auteur: Sylvain DOREMUS

Version: 0.7.0

Date: 02/06/2013

Documentation des constructeurs et destructeur

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

Constructeur.

Paramètres

[in] p_engine Le moteur.

virtual C3D_API Castor3D::DepthStencilState::~DepthStencilState ( )

virtual

Destructeur.

Documentation des fonctions membres

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

pure virtual

Applique les états.

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

pure virtual

Nettoie les états.

C3D_API void Castor3D::DepthStencilState::CreateCurrent ( )

protected

Crée l'état utilisé pour stocker l'état courant.

Référencé par GetStencilBackPassOp().

Voici le graphe des appelants de cette fonction :

C3D_API void Castor3D::DepthStencilState::DestroyCurrent ( )

protected

Détruit l'état utilisé pour stocker l'état courant.

Référencé par GetStencilBackPassOp().

Voici le graphe des appelants de cette fonction :

virtual C3D_API DepthStencilStateSPtr Castor3D::DepthStencilState::DoCreateCurrent ( )

protectedpure virtual

Crée l'état utilisé pour stocker l'état courant.

Référencé par GetStencilBackPassOp().

Voici le graphe des appelants de cette fonction :

double Castor3D::DepthStencilState::GetDepthFar ( ) const

inline

Récupère la valeur lointaine pour la profondeur.

Renvoie: La valeur

Références m_dDepthFar.

eDEPTH_FUNC Castor3D::DepthStencilState::GetDepthFunc ( ) const

inline

Récupère la fonction de profondeur.

Renvoie: La fonction

Références m_eDepthFunc.

eWRITING_MASK Castor3D::DepthStencilState::GetDepthMask ( ) const

inline

Récupère le masque d'écriture de la profondeur.

Renvoie: Le masque

Références m_eDepthMask.

double Castor3D::DepthStencilState::GetDepthNear ( ) const

inline

Récupère la valeur proche pour la profondeur.

Renvoie: La valeur

Références m_dDepthNear.

bool Castor3D::DepthStencilState::GetDepthTest ( ) const

inline

Récupère le statut du test de profondeur.

Renvoie: Le statut

Références m_bDepthTest.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilBackDepthFailOp ( ) const

inline

Récupère l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces arrières.

Renvoie: L'opération

Références Castor3D::DepthStencilState::stSTENCIL::m_eDepthFailOp, et m_stStencilBack.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilBackFailOp ( ) const

inline

Récupère l'opération lors de l'échec du test de stencil, pour les faces arrières.

Renvoie: L'opération

Références Castor3D::DepthStencilState::stSTENCIL::m_eFailOp, et m_stStencilBack.

eSTENCIL_FUNC Castor3D::DepthStencilState::GetStencilBackFunc ( ) const

inline

Récupère la fonction de stencil pour les faces arrières.

Renvoie: La fonction

Références Castor3D::DepthStencilState::stSTENCIL::m_eFunc, et m_stStencilBack.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilBackPassOp ( ) const

inline

Récupère l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces arrières.

Renvoie: L'opération

Références CreateCurrent(), DestroyCurrent(), DoCreateCurrent(), Castor3D::DepthStencilState::stSTENCIL::m_ePassOp, et m_stStencilBack.

Voici le graphe d'appel pour cette fonction :

uint32_t Castor3D::DepthStencilState::GetStencilBackRef ( ) const

inline

Récupère la valeur de référence de stencil pour les faces arrières.

Renvoie: La valeur de référence

Références Castor3D::DepthStencilState::stSTENCIL::m_ref, et m_stStencilBack.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilFrontDepthFailOp ( ) const

inline

Récupère l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces avant.

Renvoie: L'opération

Références Castor3D::DepthStencilState::stSTENCIL::m_eDepthFailOp, et m_stStencilFront.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilFrontFailOp ( ) const

inline

Récupère l'opération lors de l'échec du test de stencil, pour les faces avant.

Renvoie: L'opération

Références Castor3D::DepthStencilState::stSTENCIL::m_eFailOp, et m_stStencilFront.

eSTENCIL_FUNC Castor3D::DepthStencilState::GetStencilFrontFunc ( ) const

inline

Récupère la fonction de stencil pour les faces avant.

Renvoie: La fonction

Références Castor3D::DepthStencilState::stSTENCIL::m_eFunc, et m_stStencilFront.

eSTENCIL_OP Castor3D::DepthStencilState::GetStencilFrontPassOp ( ) const

inline

Récupère l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces avant.

Renvoie: L'opération

Références Castor3D::DepthStencilState::stSTENCIL::m_ePassOp, et m_stStencilFront.

uint32_t Castor3D::DepthStencilState::GetStencilFrontRef ( ) const

inline

Récupère la valeur de référence de stencil pour les faces avant.

Renvoie: La valeur de référence

Références Castor3D::DepthStencilState::stSTENCIL::m_ref, et m_stStencilFront.

uint32_t Castor3D::DepthStencilState::GetStencilReadMask ( ) const

inline

Récupère le masque de lecture du stencil.

Renvoie: Le masque

Références m_uiStencilReadMask.

bool Castor3D::DepthStencilState::GetStencilTest ( ) const

inline

Récupère le statut du test de stencil.

Renvoie: Le statut

Références m_bStencilTest.

uint32_t Castor3D::DepthStencilState::GetStencilWriteMask ( ) const

inline

Récupère le masque d'écriture du stencil.

Renvoie: Le masque

Références m_uiStencilWriteMask.

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

pure virtual

Initialise les états.

void Castor3D::DepthStencilState::SetDepthFunc ( eDEPTH_FUNC p_func )

inline

Définit la fonction de profondeur.

Paramètres

[in] p_func La fonction

Références m_changed, et m_eDepthFunc.

void Castor3D::DepthStencilState::SetDepthMask ( eWRITING_MASK p_eMask )

inline

Définit le masque d'écriture de la profondeur.

Paramètres

[in] p_eMask Le masque

Références m_changed, et m_eDepthMask.

void Castor3D::DepthStencilState::SetDepthRange	(	double	p_near,
		double	p_far
	)

inline

Définit l'intervalle profondeur.

Paramètres

[in]	p_near	La borne inférieure
[in]	p_far	La borne supérieure

Références m_changed, m_dDepthFar, et m_dDepthNear.

void Castor3D::DepthStencilState::SetDepthTest ( bool p_enable )

inline

Définit le statut du test de profondeur.

Paramètres

[in] p_enable Le nouveau statut

Références m_bDepthTest, et m_changed.

void Castor3D::DepthStencilState::SetStencilBackDepthFailOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces arrières.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eDepthFailOp, et m_stStencilBack.

void Castor3D::DepthStencilState::SetStencilBackFailOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de l'échec du test de stencil, pour les faces arrières.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eFailOp, et m_stStencilBack.

void Castor3D::DepthStencilState::SetStencilBackFunc ( eSTENCIL_FUNC p_func )

inline

Définit la fonction de stencil pour les faces arrières.

Paramètres

[in] p_func La fonction

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eFunc, et m_stStencilBack.

void Castor3D::DepthStencilState::SetStencilBackPassOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces arrières.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_ePassOp, et m_stStencilBack.

void Castor3D::DepthStencilState::SetStencilBackRef ( uint32_t p_ref )

inline

Définit la valeur de référence de stencil pour les faces arrières.

Paramètres

[in] p_ref La valeur de référence

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_ref, et m_stStencilBack.

void Castor3D::DepthStencilState::SetStencilFrontDepthFailOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur, pour les faces avant.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eDepthFailOp, et m_stStencilFront.

void Castor3D::DepthStencilState::SetStencilFrontFailOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de l'échec du test de stencil, pour les faces avant.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eFailOp, et m_stStencilFront.

void Castor3D::DepthStencilState::SetStencilFrontFunc ( eSTENCIL_FUNC p_func )

inline

Définit la fonction de stencil pour les faces avant.

Paramètres

[in] p_func La fonction

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_eFunc, et m_stStencilFront.

void Castor3D::DepthStencilState::SetStencilFrontPassOp ( eSTENCIL_OP p_eOp )

inline

Définit l'opération lors de la réussite des tests de stencil et de profondeur, pour les faces avant.

Paramètres

[in] p_eOp L'opération

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_ePassOp, et m_stStencilFront.

void Castor3D::DepthStencilState::SetStencilFrontRef ( uint32_t p_ref )

inline

Définit la valeur de référence de stencil pour les faces avant.

Paramètres

[in] p_ref La valeur de référence

Références m_changed, Castor3D::DepthStencilState::stSTENCIL::m_ref, et m_stStencilFront.

void Castor3D::DepthStencilState::SetStencilReadMask ( uint32_t p_uiMask )

inline

Définit le masque de lecture du stencil.

Paramètres

[in] p_uiMask Le masque

Références m_changed, et m_uiStencilReadMask.

void Castor3D::DepthStencilState::SetStencilTest ( bool p_enable )

inline

Définit le statut du test de stencil.

Paramètres

[in] p_enable Le nouveau statut

Références m_bStencilTest, et m_changed.

void Castor3D::DepthStencilState::SetStencilWriteMask ( uint32_t p_uiMask )

inline

Définit le masque d'écriture du stencil.

Paramètres

[in] p_uiMask Le masque

Références m_changed, et m_uiStencilWriteMask.

Documentation des données membres

bool Castor3D::DepthStencilState::m_bDepthTest

protected

Dit si oui on non le test de profondeur est activé

Référencé par GetDepthTest(), et SetDepthTest().

bool Castor3D::DepthStencilState::m_bStencilTest

protected

Dit si le test stencil est activé ou non.

Référencé par GetStencilTest(), et SetStencilTest().

bool Castor3D::DepthStencilState::m_changed

protected

Dit que l'état a changé

Référencé par SetDepthFunc(), SetDepthMask(), SetDepthRange(), SetDepthTest(), SetStencilBackDepthFailOp(), SetStencilBackFailOp(), SetStencilBackFunc(), SetStencilBackPassOp(), SetStencilBackRef(), SetStencilFrontDepthFailOp(), SetStencilFrontFailOp(), SetStencilFrontFunc(), SetStencilFrontPassOp(), SetStencilFrontRef(), SetStencilReadMask(), SetStencilTest(), et SetStencilWriteMask().

DepthStencilStateSPtr Castor3D::DepthStencilState::m_currentState

protected

Pointeur partag2 sur l'état interne global, utilisé pour avoir le comptage de références pour ce membre statique.

double Castor3D::DepthStencilState::m_dDepthFar

protected

Le plan lointain pour le test de profondeur.

Référencé par GetDepthFar(), et SetDepthRange().

double Castor3D::DepthStencilState::m_dDepthNear

protected

Le plan proche pour le test de profondeur.

Référencé par GetDepthNear(), et SetDepthRange().

eDEPTH_FUNC Castor3D::DepthStencilState::m_eDepthFunc

protected

La fonction du test de profondeur.

Référencé par GetDepthFunc(), et SetDepthFunc().

eWRITING_MASK Castor3D::DepthStencilState::m_eDepthMask

protected

Masque d'écriture de la profondeur.

Référencé par GetDepthMask(), et SetDepthMask().

stSTENCIL Castor3D::DepthStencilState::m_stStencilBack

protected

Fonction stencil du tampon d'arrière plan.

Référencé par GetStencilBackDepthFailOp(), GetStencilBackFailOp(), GetStencilBackFunc(), GetStencilBackPassOp(), GetStencilBackRef(), SetStencilBackDepthFailOp(), SetStencilBackFailOp(), SetStencilBackFunc(), SetStencilBackPassOp(), et SetStencilBackRef().

stSTENCIL Castor3D::DepthStencilState::m_stStencilFront

protected

Fonction stencil du tampon de premier plan.

Référencé par GetStencilFrontDepthFailOp(), GetStencilFrontFailOp(), GetStencilFrontFunc(), GetStencilFrontPassOp(), GetStencilFrontRef(), SetStencilFrontDepthFailOp(), SetStencilFrontFailOp(), SetStencilFrontFunc(), SetStencilFrontPassOp(), et SetStencilFrontRef().

uint32_t Castor3D::DepthStencilState::m_uiStencilReadMask

protected

Le masque de lecture du stencil.

Référencé par GetStencilReadMask(), et SetStencilReadMask().

uint32_t Castor3D::DepthStencilState::m_uiStencilWriteMask

protected

Le masque d'écriture du stencil.

Référencé par GetStencilWriteMask(), et SetStencilWriteMask().

DepthStencilStateWPtr Castor3D::DepthStencilState::m_wCurrentState

staticprotected

Etat interne global, utilisé pour n'appliquer que les changements d'état.

La documentation de cette classe a été générée à partir du fichier suivant :

Y:/software/Castor3D/source/Core/Castor3D/Src/DepthStencilState.hpp

Classes

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Attributs protégés statiques

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres