Référence de la structure castor3d::PassComponent

#include <PassComponent.hpp>

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

Graphe de collaboration de castor3d::PassComponent:

Fonctions membres publiques
Construction / Destruction.
C3D_API	PassComponent (Pass &pass, castor::String type, castor::StringArray deps={})
	Constructeur.
virtual C3D_API	~PassComponent () noexcept=default
C3D_API PassComponentUPtr	clone (Pass &pass) const
Common virtual functions.
C3D_API bool	writeText (castor::String const &tabs, castor::Path const &folder, castor::String const &subfolder, castor::StringStream &file) const
	Ecrit le contenu du composant en texte.
C3D_API void	fillBuffer (PassBuffer &buffer) const
	Remplit le pass buffer aves les données de cette passe.
virtual C3D_API void	accept (PassVisitorBase &vis)
	Fonction d'acceptation de PassVisitor.
virtual C3D_API void	update ()
Images.
C3D_API void	fillChannel (TextureConfiguration &configuration, uint32_t mask)
	Remplit une configuration de texture, pour utilisation par ce composant.
virtual C3D_API void	fillConfig (TextureConfiguration &config, PassVisitorBase &vis) const
	Fonction d'acceptation de PassVisitor, pour une configuration de texture.
Accesseurs.
virtual C3D_API bool	hasColour () const
virtual C3D_API castor::HdrRgbColour const &	getColour () const
virtual C3D_API void	setColour (castor::HdrRgbColour v)
virtual C3D_API bool	areNormalsInverted () const
virtual C3D_API PassComponentFlag	getPassFlags () const
castor::String const &	getType () const
castor::StringArray const &	getDependencies () const
PassComponentPlugin const &	getPlugin () const
PassComponentID	getId () const
void	setColour (castor::RgbColour const &v, float gamma=2.2f)
void	setColour (castor::Coords3f const &v)
void	setColour (castor::Point3f const &v)

Attributs protégés
castor::String	m_type
castor::StringArray	m_dependencies
PassComponentID	m_id
PassComponentPlugin const &	m_plugin
std::atomic_bool &	m_dirty
shader::PassMaterialShader *	m_materialShader {}

Documentation des constructeurs et destructeur

PassComponent()

C3D_API castor3d::PassComponent::PassComponent	(	Pass &	pass,
		castor::String	type,
		castor::StringArray	deps = {}
	)

Constructeur.

Paramètres

[in]	pass	Le sous-maillage pass.
[in]	type	Le type de composant.
[in]	deps	Les composants dont celui-ci dépend.

~PassComponent()

virtual C3D_API castor3d::PassComponent::~PassComponent ( )

virtualdefaultnoexcept

Documentation des fonctions membres

accept()

virtual C3D_API void castor3d::PassComponent::accept ( PassVisitorBase &  vis )

inlinevirtual

Fonction d'acceptation de PassVisitor.

Paramètres

vis	Le ... visiteur.

Réimplémentée dans castor3d::BlendComponent, castor3d::FractalMappingComponent, castor3d::NormalComponent, castor3d::PassHeaderComponent, castor3d::PickableComponent, castor3d::TwoSidedComponent, castor3d::UntileMappingComponent, castor3d::AmbientComponent, castor3d::AttenuationComponent, castor3d::ClearcoatComponent, castor3d::EmissiveComponent, castor3d::IridescenceComponent, castor3d::LightingModelComponent, castor3d::MetalnessComponent, castor3d::RoughnessComponent, castor3d::SheenComponent, castor3d::SpecularComponent, castor3d::SubsurfaceScatteringComponent, castor3d::ThicknessComponent, castor3d::TransmissionComponent, castor3d::AlphaTestComponent, castor3d::ColourComponent, castor3d::HeightComponent, castor3d::OpacityComponent, castor3d::ReflectionComponent, et castor3d::RefractionComponent.

areNormalsInverted()

virtual C3D_API bool castor3d::PassComponent::areNormalsInverted ( ) const

inlinevirtual

Réimplémentée dans castor3d::NormalComponent.

clone()

C3D_API PassComponentUPtr castor3d::PassComponent::clone

(

Pass &

pass

)

const

Renvoie

Clone ce composant dans la passe donnée.

Paramètres

[in,out]

pass

Reçoit le composant cloné.

fillBuffer()

C3D_API void castor3d::PassComponent::fillBuffer

(

PassBuffer &

buffer

)

const

Remplit le pass buffer aves les données de cette passe.

Paramètres

[in,out]

buffer

Le pass buffer.

fillChannel()

C3D_API void castor3d::PassComponent::fillChannel	(	TextureConfiguration &	configuration,
		uint32_t	mask
	)

Remplit une configuration de texture, pour utilisation par ce composant.

Paramètres

configuration	La configuration de texture.
mask	La valeur du masque.

fillConfig()

virtual C3D_API void castor3d::PassComponent::fillConfig ( TextureConfiguration &  config, PassVisitorBase &  vis  ) const

inlinevirtual

Fonction d'acceptation de PassVisitor, pour une configuration de texture.

Paramètres

config	La configuration de texture.
vis	Le ... visiteur.

Réimplémentée dans castor3d::PassMapComponent.

getColour()

virtual C3D_API castor::HdrRgbColour const & castor3d::PassComponent::getColour ( ) const

inlinevirtual

Réimplémentée dans castor3d::ColourComponent.

Références hasColour().

Voici le graphe d'appel pour cette fonction :

getDependencies()

castor::StringArray const & castor3d::PassComponent::getDependencies ( ) const

inline

Références m_dependencies.

getId()

PassComponentID castor3d::PassComponent::getId ( ) const

inline

Références m_id.

Référencé par getPassFlags(), castor3d::BlendComponent::getPassFlags(), castor3d::FractalMappingComponent::getPassFlags(), castor3d::NormalComponent::getPassFlags(), castor3d::PickableComponent::getPassFlags(), castor3d::UntileMappingComponent::getPassFlags(), castor3d::SubsurfaceScatteringComponent::getPassFlags(), castor3d::AlphaTestComponent::getPassFlags(), et castor3d::HeightComponent::getPassFlags().

Voici le graphe des appelants de cette fonction :

getPassFlags()

virtual C3D_API PassComponentFlag castor3d::PassComponent::getPassFlags ( ) const

inlinevirtual

Réimplémentée dans castor3d::BlendComponent, castor3d::FractalMappingComponent, castor3d::NormalComponent, castor3d::PickableComponent, castor3d::UntileMappingComponent, castor3d::SubsurfaceScatteringComponent, castor3d::AlphaTestComponent, et castor3d::HeightComponent.

Références castor3d::eNone, getId(), et castor3d::makePassComponentFlag().

Voici le graphe d'appel pour cette fonction :

getPlugin()

PassComponentPlugin const & castor3d::PassComponent::getPlugin ( ) const

inline

Références m_plugin.

Référencé par castor3d::PassMapComponent::fillChannel().

Voici le graphe des appelants de cette fonction :

getType()

castor::String const & castor3d::PassComponent::getType ( ) const

inline

Références m_type.

hasColour()

virtual C3D_API bool castor3d::PassComponent::hasColour ( ) const

inlinevirtual

Réimplémentée dans castor3d::ColourComponent.

Référencé par getColour(), et setColour().

Voici le graphe des appelants de cette fonction :

setColour() [1/4]

void castor3d::PassComponent::setColour ( castor::Coords3f const &  v )

inline

Références setColour().

Voici le graphe d'appel pour cette fonction :

setColour() [2/4]

virtual C3D_API void castor3d::PassComponent::setColour ( castor::HdrRgbColour  v )

inlinevirtual

Réimplémentée dans castor3d::ColourComponent, et castor3d::ColourComponent.

Références hasColour().

Référencé par setColour().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

setColour() [3/4]

void castor3d::PassComponent::setColour ( castor::Point3f const &  v )

inline

Références setColour().

Voici le graphe d'appel pour cette fonction :

setColour() [4/4]

void castor3d::PassComponent::setColour ( castor::RgbColour const &  v, float  gamma = 2.2f  )

inline

Références setColour().

Voici le graphe d'appel pour cette fonction :

update()

virtual C3D_API void castor3d::PassComponent::update ( )

inlinevirtual

Réimplémentée dans castor3d::SubsurfaceScatteringComponent.

writeText()

C3D_API bool castor3d::PassComponent::writeText	(	castor::String const &	tabs,
		castor::Path const &	folder,
		castor::String const &	subfolder,
		castor::StringStream &	file
	)		const

Ecrit le contenu du composant en texte.

Paramètres

[in]	tabs	Le niveau actuel de tabulation.
[in]	folder	Le dossier de ressources.
[in]	subfolder	Le sous-dossier de ressources.
[in,out]	file	Le fichier de sortie.

Documentation des données membres

m_dependencies

castor::StringArray castor3d::PassComponent::m_dependencies

protected

Référencé par getDependencies().

m_dirty

std::atomic_bool& castor3d::PassComponent::m_dirty

protected

Référencé par castor3d::BaseDataPassComponentT< DataT >::setData().

m_id

PassComponentID castor3d::PassComponent::m_id

protected

Référencé par getId().

m_materialShader

shader::PassMaterialShader* castor3d::PassComponent::m_materialShader {}

protected

m_plugin

PassComponentPlugin const& castor3d::PassComponent::m_plugin

protected

Référencé par getPlugin().

m_type

castor::String castor3d::PassComponent::m_type

protected

Référencé par getType().

---

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

• Material/Pass/Component/PassComponent.hpp