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

#include <Colour.hpp>

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

Graphe de collaboration de castor3d::ColourBackground:

Fonctions membres publiques
C3D_API	ColourBackground (Engine &engine, Scene &scene, castor::String const &name=castor::String{})
	Constructeur. Plus de détails...
C3D_API void	accept (BackgroundVisitor &visitor) override
	Fonction d'acceptation de visiteur. Plus de détails...
C3D_API void	accept (PipelineVisitor &visitor) override
	Fonction d'acceptation de visiteur. Plus de détails...
C3D_API bool	write (castor::String const &tabs, castor::Path const &folder, castor::StringStream &stream) const override
	Ecrit le fond dans un flux texte. Plus de détails...
TextureLayout const &	getTexture () const
TextureLayout &	getTexture ()
ashes::Image const &	getImage () const
ashes::ImageView const &	getView () const
castor::HdrRgbColour const &	getColour () const
Fonctions membres publiques hérités de castor3d::SceneBackground
C3D_API	SceneBackground (Engine &engine, Scene &scene, castor::String const &name, castor::String type)
	Constructeur. Plus de détails...
virtual C3D_API	~SceneBackground ()
	Destructeur. Plus de détails...
C3D_API bool	initialise (RenderDevice const &device)
	Fonction d'initialisation. Plus de détails...
C3D_API void	cleanup ()
	Fonction de nettoyage. Plus de détails...
C3D_API void	update (CpuUpdater &updater) const
	Met à jour le fond, niveau CPU. Plus de détails...
C3D_API void	update (GpuUpdater &updater) const
	Met à jour le fond, niveau GPU. Plus de détails...
C3D_API void	notifyChanged ()
	Notifie un changement affectant le GPU pour le fond. Plus de détails...
virtual C3D_API void	accept (BackgroundVisitor &visitor)=0
	Fonction d'acceptation de visiteur. Plus de détails...
virtual C3D_API void	accept (PipelineVisitor &visitor)=0
	Fonction d'acceptation de visiteur. Plus de détails...
virtual C3D_API crg::FramePass &	createBackgroundPass (crg::FramePassGroup &graph, RenderDevice const &device, ProgressBar *progress, VkExtent2D const &size, crg::ImageViewId const &colour, crg::ImageViewId const *depth, crg::ImageViewId const *depthObj, UniformBufferOffsetT< ModelBufferConfiguration > const &modelUbo, MatrixUbo const &matrixUbo, HdrConfigUbo const &hdrConfigUbo, SceneUbo const &sceneUbo, bool clearColour, BackgroundPassBase *&backgroundPass)
	Crée la passe de rendu du fond. Plus de détails...
C3D_API void	addPassBindings (crg::FramePass &pass, crg::ImageData const &targetImage, uint32_t &index) const
	Ajoute les bindings spécifiques au fond à une passe de frame. Plus de détails...
C3D_API void	addBindings (ashes::VkDescriptorSetLayoutBindingArray &bindings, uint32_t &index) const
	Ajoute les bindings spécifiques au fond. Plus de détails...
C3D_API void	addDescriptors (ashes::WriteDescriptorSetArray &descriptorWrites, crg::ImageData const &targetImage, uint32_t &index) const
	Ajoute les descripteurs spécifiques au fond. Plus de détails...
virtual C3D_API castor::String const &	getModelName () const
virtual C3D_API bool	write (castor::String const &tabs, castor::Path const &folder, castor::StringStream &stream) const =0
	Ecrit le fond dans un flux texte. Plus de détails...
virtual bool	isDepthSampled () const
virtual bool	hasScattering () const
Scene const &	getScene () const
Scene &	getScene ()
castor::String const &	getType () const
TextureLayout const &	getTexture () const
TextureLayout &	getTexture ()
ashes::Image const &	getImage () const
ashes::ImageView const &	getView () const
bool	isHdr () const
bool	isSRGB () const
bool	hasIbl () const
bool	isInitialised () const
IblTextures const &	getIbl () const
Sampler const &	getSampler () const

Membres hérités additionnels
Attributs publics hérités de castor3d::SceneBackground
OnBackgroundChanged	onChanged
Attributs protégés hérités de castor3d::SceneBackground
Scene &	m_scene
castor::String	m_type
std::atomic_bool	m_initialised { false }
bool	m_hdr { true }
bool	m_srgb { false }
Texture	m_textureId
TextureLayoutSPtr	m_texture
SamplerResPtr	m_sampler
std::unique_ptr< IblTextures >	m_ibl

Documentation des constructeurs et destructeur

ColourBackground()

C3D_API castor3d::ColourBackground::ColourBackground	(	Engine &	engine,
		Scene &	scene,
		castor::String const &	name = castor::String{}
	)

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	scene	La scène.
	name	Le nom du fond.

Documentation des fonctions membres

accept() [1/2]

C3D_API void castor3d::ColourBackground::accept ( BackgroundVisitor &  visitor )

overridevirtual

Fonction d'acceptation de visiteur.

Paramètres

visitor

Le visiteur.

Implémente castor3d::SceneBackground.

accept() [2/2]

C3D_API void castor3d::ColourBackground::accept ( PipelineVisitor &  visitor )

overridevirtual

Fonction d'acceptation de visiteur.

Paramètres

visitor

Le visiteur.

Implémente castor3d::SceneBackground.

getColour()

castor::HdrRgbColour const & castor3d::ColourBackground::getColour ( ) const

inline

getImage()

ashes::Image const & castor3d::ColourBackground::getImage ( ) const

inline

Références castor3d::SceneBackground::m_texture.

getTexture() [1/2]

TextureLayout & castor3d::ColourBackground::getTexture ( )

inline

Références castor3d::SceneBackground::m_texture.

getTexture() [2/2]

TextureLayout const & castor3d::ColourBackground::getTexture ( ) const

inline

name Accesseurs.

Références castor3d::SceneBackground::m_texture.

getView()

ashes::ImageView const & castor3d::ColourBackground::getView ( ) const

inline

Références castor3d::SceneBackground::m_texture.

write()

C3D_API bool castor3d::ColourBackground::write ( castor::String const &  tabs, castor::Path const &  folder, castor::StringStream &  stream  ) const

overridevirtual

Ecrit le fond dans un flux texte.

Paramètres

tabs	L'indentation actuelle.
folder	Le dossier de travail.
stream	Le flux.

Implémente castor3d::SceneBackground.

---

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

• Scene/Background/Colour.hpp