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

#include <Material.hpp>

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, LightingModelID lightingModelId)
	Constructeur.
virtual C3D_API	~Material ()=default
C3D_API void	initialise ()
C3D_API void	cleanup ()
C3D_API PassRPtr	createPass (LightingModelID lightingModelId)
	Crée une passe.
C3D_API PassRPtr	createPass ()
	Crée une passe.
C3D_API void	addPass (Pass const &pass)
	Ajoute une passe, en clonant celle donnée.
C3D_API void	removePass (PassRPtr pass)
	Supprime une passe externe.
C3D_API PassRPtr	getPass (uint32_t index) const
	Récupère une passe.
C3D_API void	destroyPass (uint32_t index)
	Destroys the pass at the given index.
C3D_API bool	hasAlphaBlending () const
C3D_API bool	hasEnvironmentMapping () const
C3D_API bool	hasSubsurfaceScattering () const
LightingModelID	getLightingModelId () const noexcept
uint32_t	getPassCount () const
RenderPassRegisterInfo *	getRenderPassInfo () const noexcept
bool	isSerialisable () const noexcept
bool	isInitialised () const noexcept
PassPtrArrayConstIt	begin () const
PassPtrArrayIt	begin ()
PassPtrArrayConstIt	end () const
PassPtrArrayIt	end ()
void	setRenderPassInfo (RenderPassRegisterInfo *renderPassInfo) noexcept
void	setSerialisable (bool v) noexcept

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,
		LightingModelID	lightingModelId
	)

Constructeur.

Paramètres

[in]	name	Le nom du matériau.
[in]	engine	Le moteur.
[in]	lightingModelId	L'ID du modèle d'éclairage du matériau.

~Material()

virtual C3D_API castor3d::Material::~Material ( )

virtualdefault

Documentation des fonctions membres

addPass()

C3D_API void castor3d::Material::addPass

(

Pass const &

pass

)

Ajoute une passe, en clonant celle donnée.

begin() [1/2]

PassPtrArrayIt castor3d::Material::begin ( )

inline

begin() [2/2]

PassPtrArrayConstIt castor3d::Material::begin ( ) const

inline

name Itération sur les passes.

cleanup()

C3D_API void castor3d::Material::cleanup

(

)

createPass() [1/2]

C3D_API PassRPtr castor3d::Material::createPass

(

)

Crée une passe.

Renvoie

La passe créée.

createPass() [2/2]

C3D_API PassRPtr castor3d::Material::createPass

(

LightingModelID

lightingModelId

)

Crée une passe.

Paramètres

[in]

lightingModelId

L'ID du modèle d'éclairage de la 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]

PassPtrArrayIt castor3d::Material::end ( )

inline

end() [2/2]

PassPtrArrayConstIt castor3d::Material::end ( ) const

inline

getLightingModelId()

LightingModelID castor3d::Material::getLightingModelId ( ) const

inlinenoexcept

getPass()

C3D_API PassRPtr 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 castor3d::ControlStyle::doCreateMaterial().

Voici le graphe des appelants de cette fonction :

getPassCount()

uint32_t castor3d::Material::getPassCount ( ) const

inline

getRenderPassInfo()

RenderPassRegisterInfo * castor3d::Material::getRenderPassInfo ( ) const

inlinenoexcept

hasAlphaBlending()

C3D_API bool castor3d::Material::hasAlphaBlending

(

)

const

name Accesseurs.

hasEnvironmentMapping()

C3D_API bool castor3d::Material::hasEnvironmentMapping

(

)

const

hasSubsurfaceScattering()

C3D_API bool castor3d::Material::hasSubsurfaceScattering

(

)

const

initialise()

C3D_API void castor3d::Material::initialise

(

)

isInitialised()

bool castor3d::Material::isInitialised ( ) const

inlinenoexcept

isSerialisable()

bool castor3d::Material::isSerialisable ( ) const

inlinenoexcept

removePass()

C3D_API void castor3d::Material::removePass

(

PassRPtr

pass

)

Supprime une passe externe.

Paramètres

[in]

pass

La passe.

setRenderPassInfo()

void castor3d::Material::setRenderPassInfo ( RenderPassRegisterInfo *  renderPassInfo )

inlinenoexcept

name Mutateurs.

setSerialisable()

void castor3d::Material::setSerialisable ( bool  v )

inlinenoexcept

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