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

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

+ Graphe de collaboration de castor3d::DepthStencilState:

Classes

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

Fonctions membres publiques

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 (DepthFunc p_func)
 Définit la fonction de profondeur. Plus de détails...
 
DepthFunc 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 (WritingMask p_eMask)
 Définit le masque d'écriture de la profondeur. Plus de détails...
 
WritingMask 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 (StencilFunc p_func)
 Définit la fonction de stencil pour les faces avant. Plus de détails...
 
StencilFunc getStencilFrontFunc () const
 Récupère la fonction de stencil pour les faces avant. Plus de détails...
 
void setStencilFrontFailOp (StencilOp p_op)
 Définit l'opération lors de l'échec du test de stencil, pour les faces avant. Plus de détails...
 
StencilOp 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 (StencilOp p_op)
 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...
 
StencilOp 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 (StencilOp p_op)
 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...
 
StencilOp 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 setStencilFrontOps (StencilOp p_fail, StencilOp p_depthFail, StencilOp p_pass)
 Définit toutes les opération des tests de stencil, 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 (StencilFunc p_func)
 Définit la fonction de stencil pour les faces arrières. Plus de détails...
 
StencilFunc getStencilBackFunc () const
 Récupère la fonction de stencil pour les faces arrières. Plus de détails...
 
void setStencilBackFailOp (StencilOp p_op)
 Définit l'opération lors de l'échec du test de stencil, pour les faces arrières. Plus de détails...
 
StencilOp 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 (StencilOp p_op)
 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...
 
StencilOp 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 (StencilOp p_op)
 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...
 
void setStencilBackOps (StencilOp p_fail, StencilOp p_depthFail, StencilOp p_pass)
 Définit toutes les opération des tests de stencil, pour les faces arrières. Plus de détails...
 
StencilOp 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...
 
void setStencilRef (uint32_t p_ref)
 Définit la valeur de référence de stencil. Plus de détails...
 
void setStencilFunc (StencilFunc p_func)
 Définit la fonction de stencil. Plus de détails...
 
void setStencilFailOp (StencilOp p_op)
 Définit l'opération lors de l'échec du test de stencil. Plus de détails...
 
void setStencilDepthFailOp (StencilOp p_op)
 Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur. Plus de détails...
 
void setStencilPassOp (StencilOp p_op)
 Définit l'opération lors de la réussite des tests de stencil et de profondeur. Plus de détails...
 
void setStencilOps (StencilOp p_fail, StencilOp p_depthFail, StencilOp p_pass)
 Définit toutes les opération des tests de stencil. Plus de détails...
 

Attributs protégés

bool m_bDepthTest { false }
 
DepthFunc m_eDepthFunc { DepthFunc::eLess }
 
double m_dDepthNear { 0.0 }
 
double m_dDepthFar { 1.0 }
 
WritingMask m_eDepthMask { WritingMask::eAll }
 
bool m_bStencilTest { false }
 
uint32_t m_uiStencilReadMask { 0xFFFFFFFF }
 
uint32_t m_uiStencilWriteMask { 0xFFFFFFFF }
 
StencilConfiguration m_stStencilFront
 
StencilConfiguration m_stStencilBack
 

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 fonctions membres

◆ getDepthFar()

double castor3d::DepthStencilState::getDepthFar ( ) const
inline

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

Renvoie
La valeur

Références m_dDepthFar.

◆ getDepthFunc()

DepthFunc castor3d::DepthStencilState::getDepthFunc ( ) const
inline

Récupère la fonction de profondeur.

Renvoie
La fonction

Références m_eDepthFunc.

◆ getDepthMask()

WritingMask castor3d::DepthStencilState::getDepthMask ( ) const
inline

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

Renvoie
Le masque

Références m_eDepthMask.

◆ getDepthNear()

double castor3d::DepthStencilState::getDepthNear ( ) const
inline

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

Renvoie
La valeur

Références m_dDepthNear.

◆ getDepthTest()

bool castor3d::DepthStencilState::getDepthTest ( ) const
inline

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

Renvoie
Le statut

Références m_bDepthTest.

◆ getStencilBackDepthFailOp()

StencilOp 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::StencilConfiguration::m_depthFailOp, et m_stStencilBack.

◆ getStencilBackFailOp()

StencilOp 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::StencilConfiguration::m_failOp, et m_stStencilBack.

◆ getStencilBackFunc()

StencilFunc 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::StencilConfiguration::m_eFunc, et m_stStencilBack.

◆ getStencilBackPassOp()

StencilOp 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 castor3d::DepthStencilState::StencilConfiguration::m_passOp, et m_stStencilBack.

◆ getStencilBackRef()

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::StencilConfiguration::m_ref, et m_stStencilBack.

◆ getStencilFrontDepthFailOp()

StencilOp 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::StencilConfiguration::m_depthFailOp, et m_stStencilFront.

◆ getStencilFrontFailOp()

StencilOp 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::StencilConfiguration::m_failOp, et m_stStencilFront.

◆ getStencilFrontFunc()

StencilFunc castor3d::DepthStencilState::getStencilFrontFunc ( ) const
inline

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

Renvoie
La fonction

Références castor3d::DepthStencilState::StencilConfiguration::m_eFunc, et m_stStencilFront.

◆ getStencilFrontPassOp()

StencilOp 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::StencilConfiguration::m_passOp, et m_stStencilFront.

◆ getStencilFrontRef()

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::StencilConfiguration::m_ref, et m_stStencilFront.

◆ getStencilReadMask()

uint32_t castor3d::DepthStencilState::getStencilReadMask ( ) const
inline

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

Renvoie
Le masque

Références m_uiStencilReadMask.

◆ getStencilTest()

bool castor3d::DepthStencilState::getStencilTest ( ) const
inline

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

Renvoie
Le statut

Références m_bStencilTest.

◆ getStencilWriteMask()

uint32_t castor3d::DepthStencilState::getStencilWriteMask ( ) const
inline

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

Renvoie
Le masque

Références m_uiStencilWriteMask.

◆ setDepthFunc()

void castor3d::DepthStencilState::setDepthFunc ( DepthFunc  p_func)
inline

Définit la fonction de profondeur.

Paramètres
[in]p_funcLa fonction

Références m_eDepthFunc.

◆ setDepthMask()

void castor3d::DepthStencilState::setDepthMask ( WritingMask  p_eMask)
inline

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

Paramètres
[in]p_eMaskLe masque

Références m_eDepthMask.

◆ setDepthRange()

void castor3d::DepthStencilState::setDepthRange ( double  p_near,
double  p_far 
)
inline

Définit l'intervalle profondeur.

Paramètres
[in]p_nearLa borne inférieure
[in]p_farLa borne supérieure

Références m_dDepthFar, et m_dDepthNear.

◆ setDepthTest()

void castor3d::DepthStencilState::setDepthTest ( bool  p_enable)
inline

Définit le statut du test de profondeur.

Paramètres
[in]p_enableLe nouveau statut

Références m_bDepthTest.

◆ setStencilBackDepthFailOp()

void castor3d::DepthStencilState::setStencilBackDepthFailOp ( StencilOp  p_op)
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_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, et m_stStencilBack.

◆ setStencilBackFailOp()

void castor3d::DepthStencilState::setStencilBackFailOp ( StencilOp  p_op)
inline

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

Paramètres
[in]p_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_failOp, et m_stStencilBack.

◆ setStencilBackFunc()

void castor3d::DepthStencilState::setStencilBackFunc ( StencilFunc  p_func)
inline

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

Paramètres
[in]p_funcLa fonction

Références castor3d::DepthStencilState::StencilConfiguration::m_eFunc, et m_stStencilBack.

◆ setStencilBackOps()

void castor3d::DepthStencilState::setStencilBackOps ( StencilOp  p_fail,
StencilOp  p_depthFail,
StencilOp  p_pass 
)
inline

Définit toutes les opération des tests de stencil, pour les faces arrières.

Paramètres
[in]p_failL'opération d'échec stencil
[in]p_depthFailL'opération de réussite stencil, échec profondeur
[in]p_passL'opération de réussite stencil, réussite profondeur

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, castor3d::DepthStencilState::StencilConfiguration::m_failOp, castor3d::DepthStencilState::StencilConfiguration::m_passOp, et m_stStencilBack.

◆ setStencilBackPassOp()

void castor3d::DepthStencilState::setStencilBackPassOp ( StencilOp  p_op)
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_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_passOp, et m_stStencilBack.

◆ setStencilBackRef()

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

Références castor3d::DepthStencilState::StencilConfiguration::m_ref, et m_stStencilBack.

◆ setStencilDepthFailOp()

void castor3d::DepthStencilState::setStencilDepthFailOp ( StencilOp  p_op)
inline

Définit l'opération lors de la réussite du test de stencil mais de l'échec du test de profondeur.

Paramètres
[in]p_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, m_stStencilBack, et m_stStencilFront.

◆ setStencilFailOp()

void castor3d::DepthStencilState::setStencilFailOp ( StencilOp  p_op)
inline

Définit l'opération lors de l'échec du test de stencil.

Paramètres
[in]p_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_failOp, m_stStencilBack, et m_stStencilFront.

◆ setStencilFrontDepthFailOp()

void castor3d::DepthStencilState::setStencilFrontDepthFailOp ( StencilOp  p_op)
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_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, et m_stStencilFront.

◆ setStencilFrontFailOp()

void castor3d::DepthStencilState::setStencilFrontFailOp ( StencilOp  p_op)
inline

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

Paramètres
[in]p_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_failOp, et m_stStencilFront.

◆ setStencilFrontFunc()

void castor3d::DepthStencilState::setStencilFrontFunc ( StencilFunc  p_func)
inline

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

Paramètres
[in]p_funcLa fonction

Références castor3d::DepthStencilState::StencilConfiguration::m_eFunc, et m_stStencilFront.

◆ setStencilFrontOps()

void castor3d::DepthStencilState::setStencilFrontOps ( StencilOp  p_fail,
StencilOp  p_depthFail,
StencilOp  p_pass 
)
inline

Définit toutes les opération des tests de stencil, pour les faces avant.

Paramètres
[in]p_failL'opération d'échec stencil
[in]p_depthFailL'opération de réussite stencil, échec profondeur
[in]p_passL'opération de réussite stencil, réussite profondeur

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, castor3d::DepthStencilState::StencilConfiguration::m_failOp, castor3d::DepthStencilState::StencilConfiguration::m_passOp, et m_stStencilFront.

◆ setStencilFrontPassOp()

void castor3d::DepthStencilState::setStencilFrontPassOp ( StencilOp  p_op)
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_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_passOp, et m_stStencilFront.

◆ setStencilFrontRef()

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

Références castor3d::DepthStencilState::StencilConfiguration::m_ref, et m_stStencilFront.

◆ setStencilFunc()

void castor3d::DepthStencilState::setStencilFunc ( StencilFunc  p_func)
inline

Définit la fonction de stencil.

Paramètres
[in]p_funcLa fonction

Références castor3d::DepthStencilState::StencilConfiguration::m_eFunc, m_stStencilBack, et m_stStencilFront.

◆ setStencilOps()

void castor3d::DepthStencilState::setStencilOps ( StencilOp  p_fail,
StencilOp  p_depthFail,
StencilOp  p_pass 
)
inline

Définit toutes les opération des tests de stencil.

Paramètres
[in]p_failL'opération d'échec stencil
[in]p_depthFailL'opération de réussite stencil, échec profondeur
[in]p_passL'opération de réussite stencil, réussite profondeur

Références castor3d::DepthStencilState::StencilConfiguration::m_depthFailOp, castor3d::DepthStencilState::StencilConfiguration::m_failOp, castor3d::DepthStencilState::StencilConfiguration::m_passOp, m_stStencilBack, et m_stStencilFront.

◆ setStencilPassOp()

void castor3d::DepthStencilState::setStencilPassOp ( StencilOp  p_op)
inline

Définit l'opération lors de la réussite des tests de stencil et de profondeur.

Paramètres
[in]p_opL'opération

Références castor3d::DepthStencilState::StencilConfiguration::m_passOp, m_stStencilBack, et m_stStencilFront.

◆ setStencilReadMask()

void castor3d::DepthStencilState::setStencilReadMask ( uint32_t  p_uiMask)
inline

Définit le masque de lecture du stencil.

Paramètres
[in]p_uiMaskLe masque

Références m_uiStencilReadMask.

◆ setStencilRef()

void castor3d::DepthStencilState::setStencilRef ( uint32_t  p_ref)
inline

Définit la valeur de référence de stencil.

Paramètres
[in]p_refLa valeur de référence

Références castor3d::DepthStencilState::StencilConfiguration::m_ref, m_stStencilBack, et m_stStencilFront.

◆ setStencilTest()

void castor3d::DepthStencilState::setStencilTest ( bool  p_enable)
inline

Définit le statut du test de stencil.

Paramètres
[in]p_enableLe nouveau statut

Références m_bStencilTest.

◆ setStencilWriteMask()

void castor3d::DepthStencilState::setStencilWriteMask ( uint32_t  p_uiMask)
inline

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

Paramètres
[in]p_uiMaskLe masque

Références m_uiStencilWriteMask.

Documentation des données membres

◆ m_bDepthTest

bool castor3d::DepthStencilState::m_bDepthTest { false }
protected

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

Référencé par getDepthTest(), et setDepthTest().

◆ m_bStencilTest

bool castor3d::DepthStencilState::m_bStencilTest { false }
protected

Dit si le test stencil est activé ou non.

Référencé par getStencilTest(), et setStencilTest().

◆ m_dDepthFar

double castor3d::DepthStencilState::m_dDepthFar { 1.0 }
protected

Le plan lointain pour le test de profondeur.

Référencé par getDepthFar(), et setDepthRange().

◆ m_dDepthNear

double castor3d::DepthStencilState::m_dDepthNear { 0.0 }
protected

Le plan proche pour le test de profondeur.

Référencé par getDepthNear(), et setDepthRange().

◆ m_eDepthFunc

DepthFunc castor3d::DepthStencilState::m_eDepthFunc { DepthFunc::eLess }
protected

La fonction du test de profondeur.

Référencé par getDepthFunc(), et setDepthFunc().

◆ m_eDepthMask

WritingMask castor3d::DepthStencilState::m_eDepthMask { WritingMask::eAll }
protected

Masque d'écriture de la profondeur.

Référencé par getDepthMask(), et setDepthMask().

◆ m_stStencilBack

StencilConfiguration castor3d::DepthStencilState::m_stStencilBack
protected

◆ m_stStencilFront

StencilConfiguration castor3d::DepthStencilState::m_stStencilFront
protected

◆ m_uiStencilReadMask

uint32_t castor3d::DepthStencilState::m_uiStencilReadMask { 0xFFFFFFFF }
protected

Le masque de lecture du stencil.

Référencé par getStencilReadMask(), et setStencilReadMask().

◆ m_uiStencilWriteMask

uint32_t castor3d::DepthStencilState::m_uiStencilWriteMask { 0xFFFFFFFF }
protected

Le masque d'écriture du stencil.

Référencé par getStencilWriteMask(), et setStencilWriteMask().


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