Castor3D  ..
Classes | Fonctions membres publiques | Attributs protégés | Liste de tous les membres
Référence de la classe Castor3D::DepthStencilStateabstract

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

+ Graphe de collaboration de Castor3D::DepthStencilState:

Classes

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

Fonctions membres publiques

 DepthStencilState ()
 Constructeur. Plus de détails...
 
virtual ~DepthStencilState ()
 Destructeur. Plus de détails...
 
virtual bool Initialise ()=0
 Initialise les états. Plus de détails...
 
virtual void Cleanup ()=0
 Nettoie les états. Plus de détails...
 
virtual bool Apply ()=0
 Applique les états. Plus de détails...
 
void SetDepthTest (bool p_bEnable)
 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_eFunc)
 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_dNear, double p_dFar)
 Définit la fonction de 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_bEnable)
 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_eFunc)
 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_eFunc)
 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...
 

Attributs protégés

bool m_bChanged
 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...
 

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

Castor3D::DepthStencilState::DepthStencilState ( )

Constructeur.

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

Destructeur.

Documentation des fonctions membres

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

Applique les états.

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

Nettoie les états.

double Castor3D::DepthStencilState::GetDepthFar ( ) const
inline

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

Renvoie
La valeur
eDEPTH_FUNC Castor3D::DepthStencilState::GetDepthFunc ( ) const
inline

Récupère la fonction de profondeur.

Renvoie
La fonction
eWRITING_MASK Castor3D::DepthStencilState::GetDepthMask ( ) const
inline

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

Renvoie
Le masque
double Castor3D::DepthStencilState::GetDepthNear ( ) const
inline

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

Renvoie
La valeur
bool Castor3D::DepthStencilState::GetDepthTest ( ) const
inline

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

Renvoie
Le statut
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
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
eSTENCIL_FUNC Castor3D::DepthStencilState::GetStencilBackFunc ( ) const
inline

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

Renvoie
La fonction
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
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
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
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
eSTENCIL_FUNC Castor3D::DepthStencilState::GetStencilFrontFunc ( ) const
inline

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

Renvoie
La fonction
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
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
uint32_t Castor3D::DepthStencilState::GetStencilReadMask ( ) const
inline

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

Renvoie
Le masque
bool Castor3D::DepthStencilState::GetStencilTest ( ) const
inline

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

Renvoie
Le statut
uint32_t Castor3D::DepthStencilState::GetStencilWriteMask ( ) const
inline

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

Renvoie
Le masque
virtual bool Castor3D::DepthStencilState::Initialise ( )
pure virtual

Initialise les états.

void Castor3D::DepthStencilState::SetDepthFunc ( eDEPTH_FUNC  p_eFunc)
inline

Définit la fonction de profondeur.

Paramètres
[in]p_eFuncLa fonction
void Castor3D::DepthStencilState::SetDepthMask ( eWRITING_MASK  p_eMask)
inline

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

Paramètres
[in]p_eMaskLe masque
void Castor3D::DepthStencilState::SetDepthRange ( double  p_dNear,
double  p_dFar 
)
inline

Définit la fonction de profondeur.

Paramètres
[in]p_eFuncLa fonction
void Castor3D::DepthStencilState::SetDepthTest ( bool  p_bEnable)
inline

Définit le statut du test de profondeur.

Paramètres
[in]p_bEnableLe nouveau statut
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_eOpL'opération
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_eOpL'opération
void Castor3D::DepthStencilState::SetStencilBackFunc ( eSTENCIL_FUNC  p_eFunc)
inline

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

Paramètres
[in]p_eFuncLa fonction
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_eOpL'opération
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_refLa valeur de référence
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_eOpL'opération
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_eOpL'opération
void Castor3D::DepthStencilState::SetStencilFrontFunc ( eSTENCIL_FUNC  p_eFunc)
inline

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

Paramètres
[in]p_eFuncLa fonction
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_eOpL'opération
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_refLa valeur de référence
void Castor3D::DepthStencilState::SetStencilReadMask ( uint32_t  p_uiMask)
inline

Définit le masque de lecture du stencil.

Paramètres
[in]p_uiMaskLe masque
void Castor3D::DepthStencilState::SetStencilTest ( bool  p_bEnable)
inline

Définit le statut du test de stencil.

Paramètres
[in]p_bEnableLe nouveau statut
void Castor3D::DepthStencilState::SetStencilWriteMask ( uint32_t  p_uiMask)
inline

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

Paramètres
[in]p_uiMaskLe masque

Documentation des données membres

bool Castor3D::DepthStencilState::m_bChanged
protected

Dit que l'état a changé

bool Castor3D::DepthStencilState::m_bDepthTest
protected

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

bool Castor3D::DepthStencilState::m_bStencilTest
protected

Dit si le test stencil est activé ou non.

double Castor3D::DepthStencilState::m_dDepthFar
protected

Le plan lointain pour le test de profondeur.

double Castor3D::DepthStencilState::m_dDepthNear
protected

Le plan proche pour le test de profondeur.

eDEPTH_FUNC Castor3D::DepthStencilState::m_eDepthFunc
protected

La fonction du test de profondeur.

eWRITING_MASK Castor3D::DepthStencilState::m_eDepthMask
protected

Masque d'écriture de la profondeur.

stSTENCIL Castor3D::DepthStencilState::m_stStencilBack
protected

Fonction stencil du tampon d'arrière plan.

stSTENCIL Castor3D::DepthStencilState::m_stStencilFront
protected

Fonction stencil du tampon de premier plan.

uint32_t Castor3D::DepthStencilState::m_uiStencilReadMask
protected

Le masque de lecture du stencil.

uint32_t Castor3D::DepthStencilState::m_uiStencilWriteMask
protected

Le masque d'écriture du stencil.

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Mercredi 3 Décembre 2014 03:41:41 pour Castor3D par   doxygen 1.8.8