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

Graphe de collaboration de Castor3D::BlendState:

Classes
struct	stRT_BLEND_STATE

Fonctions membres publiques
bool	IsIndependantBlendEnabled () const

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

const Castor::Colour &	GetBlendFactors () const

void	SetBlendFactors (const Castor::Colour &p_factors)
	Définit les facteurs de blend. 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...

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

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

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

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

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

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

void	SetRgbBlend (BlendOperation p_op, BlendOperand p_src, BlendOperand p_dst, uint8_t p_index=0)
	Définit l'opération et les opérandes de blend RGB. Plus de détails...

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

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

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

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

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

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

void	SetAlphaBlend (BlendOperation p_op, BlendOperand p_src, BlendOperand p_dst, uint8_t p_index=0)
	Définit l'opération et les opérandes de blend alpha. Plus de détails...

void	SetSrcBlend (BlendOperand p_value, uint8_t p_index=0)
	Définit le facteur source pour l'alpha et le RGB. Plus de détails...

void	SetDstBlend (BlendOperand p_value, uint8_t p_index=0)
	Définit le facteur destination pour l'alpha et le RGB. Plus de détails...

void	SetBlendOp (BlendOperation p_value, uint8_t p_index=0)
	Définit l'opération de blend alpha et 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 (WritingMask p_r, WritingMask p_g, WritingMask p_b, WritingMask p_a)
	Définit le masque d'écriture des couleurs. Plus de détails...

WritingMask	GetColourMaskR () const

WritingMask	GetColourMaskG () const

WritingMask	GetColourMaskB () const

WritingMask	GetColourMaskA () const

Attributs protégés
bool	m_independantBlend { false }

Castor::Colour	m_blendFactors

std::array< stRT_BLEND_STATE, 8 >	m_states

WritingMask	m_colourMask [4] = { WritingMask::eAll, WritingMask::eAll, WritingMask::eAll, WritingMask::eAll }

Description détaillée

Classe regroupant les configurations de blend.

Auteur: Sylvain DOREMUS

Version: 0.7.0

Date: 02/06/2013

Documentation des fonctions membres

◆ EnableBlend()

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_states.

◆ EnableIndependantBlend()

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_independantBlend.

◆ GetAlphaBlendOp()

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

inline

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

Paramètres

[in] p_index L'indice de la valeur.

Renvoie: La valeur.

Références m_states.

◆ GetAlphaDstBlend()

BlendOperand 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_states.

◆ GetAlphaSrcBlend()

BlendOperand 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_states.

◆ GetBlendFactors()

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

inline

Renvoie: Les facteurs de blend.

Références m_blendFactors.

◆ GetColourMaskA()

WritingMask Castor3D::BlendState::GetColourMaskA ( ) const

inline

Renvoie: Le masque d'écriture de la composante alpha.

Références m_colourMask.

◆ GetColourMaskB()

WritingMask Castor3D::BlendState::GetColourMaskB ( ) const

inline

Renvoie: Le masque d'écriture de la composante bleue.

Références m_colourMask.

◆ GetColourMaskG()

WritingMask Castor3D::BlendState::GetColourMaskG ( ) const

inline

Renvoie: Le masque d'écriture de la composante verte.

Références m_colourMask.

◆ GetColourMaskR()

WritingMask Castor3D::BlendState::GetColourMaskR ( ) const

inline

Renvoie: Le masque d'écriture de la composante rouge.

Références m_colourMask.

◆ GetRgbBlendOp()

BlendOperation 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_states.

◆ GetRgbDstBlend()

BlendOperand 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_states.

◆ GetRgbSrcBlend()

BlendOperand 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_states.

◆ GetWriteMask()

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_states.

◆ IsBlendEnabled()

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_states.

◆ IsIndependantBlendEnabled()

bool Castor3D::BlendState::IsIndependantBlendEnabled ( ) const

inline

Renvoie: Le statut d'activation du blending indépendant.

Références m_independantBlend.

◆ SetAlphaBlend()

void Castor3D::BlendState::SetAlphaBlend	(	BlendOperation	p_op,
		BlendOperand	p_src,
		BlendOperand	p_dst,
		uint8_t	p_index = `0`
	)

inline

Définit l'opération et les opérandes de blend alpha.

Paramètres

[in]	p_op	L'opération de blend.
[in]	p_src	L'opérande source du blend.
[in]	p_dst	L'opérande destination du blend.
[in]	p_index	L'indice de la valeur.

Références m_states.

◆ SetAlphaBlendOp()

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

inline

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

Paramètres

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

Références m_states.

◆ SetAlphaDstBlend()

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

inline

Définit le facteur destination alpha.

Paramètres

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

Références m_states.

◆ SetAlphaSrcBlend()

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

inline

Définit le facteur source alpha.

Paramètres

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

Références m_states.

◆ SetBlendFactors()

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

inline

Définit les facteurs de blend.

Paramètres

[in] p_factors La nouvelle valeur.

Références m_blendFactors.

◆ SetBlendOp()

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

inline

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

Paramètres

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

Références m_states.

◆ SetColourMask()

void Castor3D::BlendState::SetColourMask	(	WritingMask	p_r,
		WritingMask	p_g,
		WritingMask	p_b,
		WritingMask	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_colourMask.

◆ SetDstBlend()

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

inline

Définit le facteur destination pour l'alpha et le RGB.

Paramètres

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

Références m_states.

◆ SetRgbBlend()

void Castor3D::BlendState::SetRgbBlend	(	BlendOperation	p_op,
		BlendOperand	p_src,
		BlendOperand	p_dst,
		uint8_t	p_index = `0`
	)

inline

Définit l'opération et les opérandes de blend RGB.

Paramètres

[in]	p_op	L'opération de blend.
[in]	p_src	L'opérande source du blend.
[in]	p_dst	L'opérande destination du blend.
[in]	p_index	L'indice de la valeur.

Références m_states.

◆ SetRgbBlendOp()

void Castor3D::BlendState::SetRgbBlendOp	(	BlendOperation	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_states.

◆ SetRgbDstBlend()

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

inline

Définit le facteur destination RGB.

Paramètres

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

Références m_states.

◆ SetRgbSrcBlend()

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

inline

Définit le facteur source RGB.

Paramètres

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

Références m_states.

◆ SetSrcBlend()

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

inline

Définit le facteur source pour l'alpha et le RGB.

Paramètres

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

Références m_states.

◆ SetWriteMask()

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_states.

Documentation des données membres

◆ m_blendFactors

Castor::Colour Castor3D::BlendState::m_blendFactors

protected

La couleur de mélange.

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

◆ m_colourMask

WritingMask Castor3D::BlendState::m_colourMask[4] = { WritingMask::eAll, WritingMask::eAll, WritingMask::eAll, WritingMask::eAll }

protected

Masque d'écriture des couleurs.

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

◆ m_independantBlend

bool Castor3D::BlendState::m_independantBlend { false }

protected

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

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

◆ m_states

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

protected

Les états de mélange.

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

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/State/BlendState.hpp

Classes

Fonctions membres publiques

Attributs protégés

Description détaillée

Documentation des fonctions membres

◆ EnableBlend()

◆ EnableIndependantBlend()

◆ GetAlphaBlendOp()

◆ GetAlphaDstBlend()

◆ GetAlphaSrcBlend()

◆ GetBlendFactors()

◆ GetColourMaskA()

◆ GetColourMaskB()

◆ GetColourMaskG()

◆ GetColourMaskR()

◆ GetRgbBlendOp()

◆ GetRgbDstBlend()

◆ GetRgbSrcBlend()

◆ GetWriteMask()

◆ IsBlendEnabled()

◆ IsIndependantBlendEnabled()

◆ SetAlphaBlend()

◆ SetAlphaBlendOp()

◆ SetAlphaDstBlend()

◆ SetAlphaSrcBlend()

◆ SetBlendFactors()

◆ SetBlendOp()

◆ SetColourMask()

◆ SetDstBlend()

◆ SetRgbBlend()

◆ SetRgbBlendOp()

◆ SetRgbDstBlend()

◆ SetRgbSrcBlend()

◆ SetSrcBlend()

◆ SetWriteMask()

Documentation des données membres

◆ m_blendFactors

◆ m_colourMask

◆ m_independantBlend

◆ m_states