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

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

Graphe de collaboration de castor3d::Material:

Fonctions membres publiques
C3D_API	Material (castor::String const &name, Engine &engine, MaterialType type)
	Constructeur. Plus de détails...
virtual C3D_API	~Material ()
	Destructeur. Plus de détails...
C3D_API void	initialise (RenderDevice const &device)
	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 pass)
	Supprime une passe externe. Plus de détails...
C3D_API PassSPtr	getPass (uint32_t index) const
	Récupère une passe. Plus de détails...
C3D_API void	destroyPass (uint32_t index)
	Destroys the pass at the given index. Plus de détails...
C3D_API bool	hasAlphaBlending () const
C3D_API bool	hasEnvironmentMapping () const
C3D_API bool	hasSubsurfaceScattering () const
C3D_API bool	isTextured (TextureFlags mask=TextureFlag::eAll) 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 index) const
	Récupère une passe. Plus de détails...

Attributs publics
OnMaterialChanged	onChanged

Attributs publics statiques
static const castor::String	DefaultMaterialName

Documentation des constructeurs et destructeur

Material()

C3D_API castor3d::Material::Material	(	castor::String const &	name,
		Engine &	engine,
		MaterialType	type
	)

Constructeur.

Paramètres

[in]	name	Le nom du matériau.
[in]	engine	Le moteur.
[in]	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

index

)

Destroys the pass at the given index.

Paramètres

[in]

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

index

)

const

Récupère une passe.

Paramètres

[in]

index

L'index de la passe voulue.

Renvoie

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

Référencé par getTypedPass().

Voici le graphe des appelants de cette fonction :

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  index ) const

inline

Récupère une passe.

Paramètres

[in]

index

L'index de la passe voulue.

Renvoie

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

Références getPass().

Voici le graphe d'appel pour cette fonction :

hasAlphaBlending()

C3D_API bool castor3d::Material::hasAlphaBlending

(

)

const

Renvoie

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

hasEnvironmentMapping()

C3D_API bool castor3d::Material::hasEnvironmentMapping

(

)

const

Renvoie

true si au moins une passe a besoin d'une reflection map.

hasSubsurfaceScattering()

C3D_API bool castor3d::Material::hasSubsurfaceScattering

(

)

const

Renvoie

Dit si le matériau a du subsurface scattering.

initialise()

C3D_API void castor3d::Material::initialise

(

RenderDevice const &

device

)

Initialise le matériau et toutes ses passes.

Paramètres

[in]

device

Le device GPU.

isTextured()

C3D_API bool castor3d::Material::isTextured

(

TextureFlags

mask = TextureFlag::eAll

)

const

Renvoie

Dit si le matériau a des textures.

Paramètres

[in]

mask

Un masque de textures pour les filtrer.

removePass()

C3D_API void castor3d::Material::removePass

(

PassSPtr

pass

)

Supprime une passe externe.

Paramètres

[in]

pass

La passe.

Documentation des données membres

DefaultMaterialName

const castor::String castor3d::Material::DefaultMaterialName

static

Le nom du matériau par défaut.

onChanged

OnMaterialChanged castor3d::Material::onChanged

Le signal levé lorsque le matériau a changé.

---

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

• Material/Material.hpp