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

#include <Image.hpp>

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

Graphe de collaboration de castor3d::ImageBackground:

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

Membres hérités additionnels
Attributs publics hérités de castor3d::SceneBackground
OnBackgroundChanged	onChanged
Attributs publics statiques hérités de castor3d::SceneBackground
static uint32_t constexpr	VisiblePassIndex = 0u
static uint32_t constexpr	HiddenPassIndex = 1u
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
TextureLayoutUPtr	m_texture
SamplerObs	m_sampler {}
std::unique_ptr< IblTextures >	m_ibl
bool	m_hasIBLSupport
bool	m_visible { true }
uint32_t	m_passIndex { 0u }

Documentation des constructeurs et destructeur

ImageBackground()

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

explicit

Constructeur.

Paramètres

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

Documentation des fonctions membres

accept() [1/2]

C3D_API void castor3d::ImageBackground::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::ImageBackground::accept ( PipelineVisitor &  visitor )

overridevirtual

Fonction d'acceptation de visiteur.

Paramètres

visitor

Le visiteur.

Implémente castor3d::SceneBackground.

getImagePath()

castor::Path const & castor3d::ImageBackground::getImagePath ( ) const

inlinenoexcept

getModelName()

castor::String const & castor3d::ImageBackground::getModelName ( ) const

overridevirtual

Renvoie

Le nom du modèle de fond.

Réimplémentée à partir de castor3d::SceneBackground.

loadImage()

C3D_API bool castor3d::ImageBackground::loadImage	(	castor::Path const &	folder,
		castor::Path const &	relative
	)

Renvoie

Définit l'image de la texture.

Paramètres

[in]	folder	Le dossier de l'image.
[in]	relative	Le chemin d'accès à l'image, relatif à folder.

write()

C3D_API bool castor3d::ImageBackground::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/Image.hpp