Classe regroupant les configurations de blend. Plus de détails...

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

Graphe de collaboration de Castor3D::BlendState:

Classes
struct	stRT_BLEND_STATE

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

virtual C3D_API	~BlendState ()
	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...

bool	IsAlphaToCoverageEnabled () const
	Récupère le statut d'activation de l'alpha to coverage. Plus de détails...

void	EnableAlphaToCoverage (bool p_enable)
	Définit le statut d'activation de l'alpha to coverage. Plus de détails...

bool	IsIndependantBlendEnabled () const
	Récupère le statut d'activation du blending indépendant. Plus de détails...

void	EnableIndependantBlend (bool p_enable)
	Définit le statut d'activation du blending indépendant. Plus de détails...

const Castor::Colour &	GetBlendFactors () const
	Récupère les facteurs de blend. Plus de détails...

void	SetBlendFactors (const Castor::Colour &p_clFactors)
	Définit les facteurs de blend. Plus de détails...

uint32_t	GetSampleCoverageMask () const
	Récupère le masque de couverture de samples. Plus de détails...

void	SetSampleCoverageMask (uint32_t p_uiMask)
	Définit le masque de couverture de samples. Plus de détails...

bool	IsBlendEnabled (uint8_t p_index=0) const
	Récupère le statut d'activation du blending. Plus de détails...

void	EnableBlend (bool p_enable, uint8_t p_index=0)
	Définit le statut d'activation du blending. Plus de détails...

eBLEND	GetRgbSrcBlend (uint8_t p_index=0) const
	Récupère le facteur source RGB. Plus de détails...

void	SetRgbSrcBlend (eBLEND p_eValue, uint8_t p_index=0)
	Définit le facteur source RGB. Plus de détails...

eBLEND	GetRgbDstBlend (uint8_t p_index=0) const
	Récupère le facteur destination RGB. Plus de détails...

void	SetRgbDstBlend (eBLEND p_eValue, uint8_t p_index=0)
	Définit le facteur destination RGB. Plus de détails...

eBLEND_OP	GetRgbBlendOp (uint8_t p_index=0) const
	Récupère l'opération de blend RGB. Plus de détails...

void	SetRgbBlendOp (eBLEND_OP p_eValue, uint8_t p_index=0)
	Définit l'opération de blend RGB. Plus de détails...

eBLEND	GetAlphaSrcBlend (uint8_t p_index=0) const
	Récupère le facteur source alpha. Plus de détails...

void	SetAlphaSrcBlend (eBLEND p_eValue, uint8_t p_index=0)
	Définit le facteur source alpha. Plus de détails...

eBLEND	GetAlphaDstBlend (uint8_t p_index=0) const
	Récupère le facteur destination alpha. Plus de détails...

void	SetAlphaDstBlend (eBLEND p_eValue, uint8_t p_index=0)
	Définit le facteur destination alpha. Plus de détails...

eBLEND_OP	GetAlphaBlendOp (uint8_t p_index=0) const
	Récupère l'opération de blend RGB. Plus de détails...

void	SetAlphaBlendOp (eBLEND_OP p_value, uint8_t p_index=0)
	Définit l'opération de blend RGB. Plus de détails...

uint8_t	GetWriteMask (uint8_t p_index=0) const
	Récupère le masque d'écriture de la cible de rendu. Plus de détails...

void	SetWriteMask (uint8_t p_value, uint8_t p_index=0)
	Définit le masque d'écriture de la cible de rendu. Plus de détails...

void	SetColourMask (eWRITING_MASK p_r, eWRITING_MASK p_g, eWRITING_MASK p_b, eWRITING_MASK p_a)
	Définit le masque d'écriture des couleurs. Plus de détails...

eWRITING_MASK	GetColourMaskR () const
	Récupère le masque d'écriture de la composante rouge. Plus de détails...

eWRITING_MASK	GetColourMaskG () const
	Récupère le masque d'écriture de la composante verte. Plus de détails...

eWRITING_MASK	GetColourMaskB () const
	Récupère le masque d'écriture de la composante bleue. Plus de détails...

eWRITING_MASK	GetColourMaskA () const
	Récupère le masque d'écriture de la composante alpha. 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 BlendStateSPtr	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_bEnableAlphaToCoverage
	Dit si l'alpha to coverage est activé Plus de détails...

bool	m_bIndependantBlend
	Dit si les états indépendants de mélange sont activés. Plus de détails...

Castor::Colour	m_blendFactors
	La couleur de mélange. Plus de détails...

uint32_t	m_uiSampleMask
	Le masque d'échantillonage. Plus de détails...

std::array< stRT_BLEND_STATE, 8 >	m_rtStates
	Les états de mélange. Plus de détails...

eWRITING_MASK	m_eColourMask [4]
	Masque d'écriture des couleurs. Plus de détails...

BlendStateSPtr	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 BlendStateWPtr	m_wCurrentState
	Etat interne global, utilisé pour n'appliquer que les changements d'état. Plus de détails...

Description détaillée

Classe regroupant les configurations de blend.

Auteur: Sylvain DOREMUS

Version: 0.7.0

Date: 02/06/2013

Documentation des constructeurs et destructeur

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

Constructeur.

Paramètres

[in] p_engine Le moteur.

virtual C3D_API Castor3D::BlendState::~BlendState ( )

virtual

Destructeur.

Documentation des fonctions membres

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

pure virtual

Applique les états.

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

pure virtual

Nettoie les états.

C3D_API void Castor3D::BlendState::CreateCurrent ( )

protected

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

C3D_API void Castor3D::BlendState::DestroyCurrent ( )

protected

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

virtual C3D_API BlendStateSPtr Castor3D::BlendState::DoCreateCurrent ( )

protectedpure virtual

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

void Castor3D::BlendState::EnableAlphaToCoverage ( bool p_enable )

inline

Définit le statut d'activation de l'alpha to coverage.

Paramètres

[in] p_enable La nouvelle valeur

Références m_bEnableAlphaToCoverage, et m_changed.

void Castor3D::BlendState::EnableBlend	(	bool	p_enable,
		uint8_t	p_index = `0`
	)

inline

Définit le statut d'activation du blending.

Paramètres

[in]	p_enable	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::EnableIndependantBlend ( bool p_enable )

inline

Définit le statut d'activation du blending indépendant.

Paramètres

[in] p_enable La nouvelle valeur

Références m_bIndependantBlend, et m_changed.

eBLEND_OP Castor3D::BlendState::GetAlphaBlendOp ( uint8_t p_index = 0 ) const

inline

Récupère l'opération de blend RGB.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

eBLEND Castor3D::BlendState::GetAlphaDstBlend ( uint8_t p_index = 0 ) const

inline

Récupère le facteur destination alpha.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

eBLEND Castor3D::BlendState::GetAlphaSrcBlend ( uint8_t p_index = 0 ) const

inline

Récupère le facteur source alpha.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

const Castor::Colour& Castor3D::BlendState::GetBlendFactors ( ) const

inline

Récupère les facteurs de blend.

Renvoie: La valeur

Références m_blendFactors.

eWRITING_MASK Castor3D::BlendState::GetColourMaskA ( ) const

inline

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

Renvoie: Le masque

Références m_eColourMask.

eWRITING_MASK Castor3D::BlendState::GetColourMaskB ( ) const

inline

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

Renvoie: Le masque

Références m_eColourMask.

eWRITING_MASK Castor3D::BlendState::GetColourMaskG ( ) const

inline

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

Renvoie: Le masque

Références m_eColourMask.

eWRITING_MASK Castor3D::BlendState::GetColourMaskR ( ) const

inline

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

Renvoie: Le masque

Références m_eColourMask.

eBLEND_OP Castor3D::BlendState::GetRgbBlendOp ( uint8_t p_index = 0 ) const

inline

Récupère l'opération de blend RGB.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

eBLEND Castor3D::BlendState::GetRgbDstBlend ( uint8_t p_index = 0 ) const

inline

Récupère le facteur destination RGB.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

eBLEND Castor3D::BlendState::GetRgbSrcBlend ( uint8_t p_index = 0 ) const

inline

Récupère le facteur source RGB.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

uint32_t Castor3D::BlendState::GetSampleCoverageMask ( ) const

inline

Récupère le masque de couverture de samples.

Renvoie: La valeur

Références m_uiSampleMask.

uint8_t Castor3D::BlendState::GetWriteMask ( uint8_t p_index = 0 ) const

inline

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

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

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

pure virtual

Initialise les états.

bool Castor3D::BlendState::IsAlphaToCoverageEnabled ( ) const

inline

Récupère le statut d'activation de l'alpha to coverage.

Renvoie: La valeur

Références m_bEnableAlphaToCoverage.

bool Castor3D::BlendState::IsBlendEnabled ( uint8_t p_index = 0 ) const

inline

Récupère le statut d'activation du blending.

Paramètres

[in] p_index L'indice de la valeur

Renvoie: La valeur

Références m_rtStates.

bool Castor3D::BlendState::IsIndependantBlendEnabled ( ) const

inline

Récupère le statut d'activation du blending indépendant.

Renvoie: La valeur

Références m_bIndependantBlend.

void Castor3D::BlendState::SetAlphaBlendOp	(	eBLEND_OP	p_value,
		uint8_t	p_index = `0`
	)

inline

Définit l'opération de blend RGB.

Paramètres

[in]	p_value	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetAlphaDstBlend	(	eBLEND	p_eValue,
		uint8_t	p_index = `0`
	)

inline

Définit le facteur destination alpha.

Paramètres

[in]	p_eValue	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetAlphaSrcBlend	(	eBLEND	p_eValue,
		uint8_t	p_index = `0`
	)

inline

Définit le facteur source alpha.

Paramètres

[in]	p_eValue	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetBlendFactors ( const Castor::Colour & p_clFactors )

inline

Définit les facteurs de blend.

Paramètres

[in] p_clFactors La nouvelle valeur

Références m_blendFactors, et m_changed.

void Castor3D::BlendState::SetColourMask	(	eWRITING_MASK	p_r,
		eWRITING_MASK	p_g,
		eWRITING_MASK	p_b,
		eWRITING_MASK	p_a
	)

inline

Définit le masque d'écriture des couleurs.

Paramètres

[in] p_r,p_g,p_b,p_a Le masque pour chaque composante

Références m_changed, et m_eColourMask.

void Castor3D::BlendState::SetRgbBlendOp	(	eBLEND_OP	p_eValue,
		uint8_t	p_index = `0`
	)

inline

Définit l'opération de blend RGB.

Paramètres

[in]	p_eValue	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetRgbDstBlend	(	eBLEND	p_eValue,
		uint8_t	p_index = `0`
	)

inline

Définit le facteur destination RGB.

Paramètres

[in]	p_eValue	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetRgbSrcBlend	(	eBLEND	p_eValue,
		uint8_t	p_index = `0`
	)

inline

Définit le facteur source RGB.

Paramètres

[in]	p_eValue	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

void Castor3D::BlendState::SetSampleCoverageMask ( uint32_t p_uiMask )

inline

Définit le masque de couverture de samples.

Paramètres

[in] p_uiMask La nouvelle valeur

Références m_changed, et m_uiSampleMask.

void Castor3D::BlendState::SetWriteMask	(	uint8_t	p_value,
		uint8_t	p_index = `0`
	)

inline

Définit le masque d'écriture de la cible de rendu.

Paramètres

[in]	p_value	La nouvelle valeur
[in]	p_index	L'indice de la valeur

Références m_changed, et m_rtStates.

Documentation des données membres

bool Castor3D::BlendState::m_bEnableAlphaToCoverage

protected

Dit si l'alpha to coverage est activé

Référencé par EnableAlphaToCoverage(), et IsAlphaToCoverageEnabled().

bool Castor3D::BlendState::m_bIndependantBlend

protected

Dit si les états indépendants de mélange sont activés.

Référencé par EnableIndependantBlend(), et IsIndependantBlendEnabled().

Castor::Colour Castor3D::BlendState::m_blendFactors

protected

La couleur de mélange.

Référencé par GetBlendFactors(), et SetBlendFactors().

bool Castor3D::BlendState::m_changed

protected

Dit que l'état a changé

Référencé par EnableAlphaToCoverage(), EnableBlend(), EnableIndependantBlend(), SetAlphaBlendOp(), SetAlphaDstBlend(), SetAlphaSrcBlend(), SetBlendFactors(), SetColourMask(), SetRgbBlendOp(), SetRgbDstBlend(), SetRgbSrcBlend(), SetSampleCoverageMask(), et SetWriteMask().

BlendStateSPtr Castor3D::BlendState::m_currentState

protected

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

eWRITING_MASK Castor3D::BlendState::m_eColourMask[4]

protected

Masque d'écriture des couleurs.

Référencé par GetColourMaskA(), GetColourMaskB(), GetColourMaskG(), GetColourMaskR(), et SetColourMask().

std::array< stRT_BLEND_STATE, 8 > Castor3D::BlendState::m_rtStates

protected

Les états de mélange.

Référencé par EnableBlend(), GetAlphaBlendOp(), GetAlphaDstBlend(), GetAlphaSrcBlend(), GetRgbBlendOp(), GetRgbDstBlend(), GetRgbSrcBlend(), GetWriteMask(), IsBlendEnabled(), SetAlphaBlendOp(), SetAlphaDstBlend(), SetAlphaSrcBlend(), SetRgbBlendOp(), SetRgbDstBlend(), SetRgbSrcBlend(), et SetWriteMask().

uint32_t Castor3D::BlendState::m_uiSampleMask

protected

Le masque d'échantillonage.

Référencé par GetSampleCoverageMask(), et SetSampleCoverageMask().

BlendStateWPtr Castor3D::BlendState::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/BlendState.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