Référence de la classe Castor3D::Material

Définition d'un matériau. Plus de détails...

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

Graphe de collaboration de Castor3D::Material:

Classes
class	TextWriter
	Loader de Material. Plus de détails...

Fonctions membres publiques
C3D_API	Material (Castor::String const &p_name, Engine &p_engine, MaterialType p_type)
	Constructeur. Plus de détails...
virtual C3D_API	~Material ()
	Destructeur. Plus de détails...
C3D_API void	Initialise ()
	Initialise le matériau et toutes ses passes. Plus de détails...
C3D_API void	Cleanup ()
	Supprime les passes. Plus de détails...
C3D_API PassSPtr	CreatePass ()
	Crée une passe. Plus de détails...
C3D_API void	RemovePass (PassSPtr p_pass)
	Supprime une passe externe. Plus de détails...
C3D_API PassSPtr	GetPass (uint32_t p_index) const
	Récupère une passe. Plus de détails...
C3D_API void	DestroyPass (uint32_t p_index)
	Destroys the pass at the given index. Plus de détails...
C3D_API bool	HasAlphaBlending () const
uint32_t	GetPassCount () const
PassPtrArrayConstIt	begin () const
PassPtrArrayIt	begin ()
PassPtrArrayConstIt	end () const
PassPtrArrayIt	end ()
MaterialType	GetType () const
template<MaterialType Type>
std::shared_ptr< typename PassTyper< Type >::Type >	GetTypedPass (uint32_t p_index) const
	Récupère une passe. Plus de détails...

Attributs publics statiques
static const Castor::String	DefaultMaterialName

Description détaillée

Définition d'un matériau.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

Un matériau est composé d'une ou plusieurs passes

Documentation des constructeurs et destructeur

Material()

C3D_API Castor3D::Material::Material	(	Castor::String const &	p_name,
		Engine &	p_engine,
		MaterialType	p_type
	)

Constructeur.

Paramètres

[in]	p_name	Le nom du matériau.
[in]	p_engine	Le moteur.
[in]	p_type	Le type de matériau.

~Material()

virtual C3D_API Castor3D::Material::~Material ( )

virtual

Destructeur.

Documentation des fonctions membres

begin() [1/2]

PassPtrArrayConstIt Castor3D::Material::begin ( ) const

inline

Renvoie

L'itérateur constant sur le début du tableau de passes.

begin() [2/2]

PassPtrArrayIt Castor3D::Material::begin ( )

inline

Renvoie

L'itérateur sur le début du tableau de passes.

Cleanup()

C3D_API void Castor3D::Material::Cleanup

(

)

Supprime les passes.

CreatePass()

C3D_API PassSPtr Castor3D::Material::CreatePass

(

)

Crée une passe.

Renvoie

La passe créée.

DestroyPass()

C3D_API void Castor3D::Material::DestroyPass

(

uint32_t

p_index

)

Destroys the pass at the given index.

Paramètres

[in]

p_index

L'index de la passe.

end() [1/2]

PassPtrArrayConstIt Castor3D::Material::end ( ) const

inline

Renvoie

L'itérateur constant sur la fin du tableau de passes.

end() [2/2]

PassPtrArrayIt Castor3D::Material::end ( )

inline

Renvoie

L'itérateur sur la fin du tableau de passes.

GetPass()

C3D_API PassSPtr Castor3D::Material::GetPass

(

uint32_t

p_index

)

const

Récupère une passe.

Paramètres

[in]

p_index

L'index de la passe voulue.

Renvoie

La passe récupére ou nullptr si non trouvés.

GetPassCount()

uint32_t Castor3D::Material::GetPassCount ( ) const

inline

Renvoie

Le nombre de passes.

GetType()

MaterialType Castor3D::Material::GetType ( ) const

inline

Renvoie

Le type de matériau.

GetTypedPass()

template<MaterialType Type>

std::shared_ptr< typename PassTyper< Type >::Type > Castor3D::Material::GetTypedPass ( uint32_t  p_index ) const

inline

Récupère une passe.

Paramètres

[in]

p_index

L'index de la passe voulue.

Renvoie

La passe récupére ou nullptr si non trouvés.

HasAlphaBlending()

C3D_API bool Castor3D::Material::HasAlphaBlending

(

)

const

Renvoie

true si toutes les passes ont besoin d'alpha blending.

Initialise()

C3D_API void Castor3D::Material::Initialise

(

)

Initialise le matériau et toutes ses passes.

RemovePass()

C3D_API void Castor3D::Material::RemovePass

(

PassSPtr

p_pass

)

Supprime une passe externe.

Paramètres

[in]

p_pass

La passe.

Documentation des données membres

DefaultMaterialName

const Castor::String Castor3D::Material::DefaultMaterialName

static

Le nom du matériau par défaut.

---

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

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Material/Material.hpp