#include <Background.hpp>

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

Graphe de collaboration de castor3d::SceneBackground:

[légende]

Fonctions membres publiques
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

Attributs publics
OnBackgroundChanged	onChanged

Attributs protégés
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

◆ SceneBackground()

C3D_API castor3d::SceneBackground::SceneBackground	(	Engine &	engine,
		Scene &	scene,
		castor::String const &	name,
		castor::String	type
	)

explicit

Constructeur.

Paramètres

engine	Le moteur.
scene	La scène parente.
name	Le nom du fond.
type	Le type de fond.

◆ ~SceneBackground()

virtual C3D_API castor3d::SceneBackground::~SceneBackground ( )

virtual

Destructeur.

Documentation des fonctions membres

◆ accept() [1/2]

virtual C3D_API void castor3d::SceneBackground::accept ( BackgroundVisitor & visitor )

pure virtual

Fonction d'acceptation de visiteur.

Paramètres

visitor Le visiteur.

Implémenté dans castor3d::ColourBackground, castor3d::ImageBackground, et castor3d::SkyboxBackground.

◆ accept() [2/2]

virtual C3D_API void castor3d::SceneBackground::accept ( PipelineVisitor & visitor )

pure virtual

Fonction d'acceptation de visiteur.

Paramètres

visitor Le visiteur.

Implémenté dans castor3d::ColourBackground, castor3d::ImageBackground, et castor3d::SkyboxBackground.

◆ addBindings()

C3D_API void castor3d::SceneBackground::addBindings	(	ashes::VkDescriptorSetLayoutBindingArray &	bindings,
		uint32_t &	index
	)		const

Ajoute les bindings spécifiques au fond.

Paramètres

bindings	Reçoit les bindings.
index	L'indice de départ des bindings.

◆ addDescriptors()

C3D_API void castor3d::SceneBackground::addDescriptors	(	ashes::WriteDescriptorSetArray &	descriptorWrites,
		crg::ImageData const &	targetImage,
		uint32_t &	index
	)		const

Ajoute les descripteurs spécifiques au fond.

Paramètres

descriptorWrites	Reçoit les descripteurs.
targetImage	L'image dans laquelle cette passe fait son rendu.
index	L'indice de départ des descripteurs.

◆ addPassBindings()

C3D_API void castor3d::SceneBackground::addPassBindings	(	crg::FramePass &	pass,
		crg::ImageData const &	targetImage,
		uint32_t &	index
	)		const

Ajoute les bindings spécifiques au fond à une passe de frame.

Paramètres

pass	Reçoit les bindings.
targetImage	L'image dans laquelle cette passe fait son rendu.
index	L'indice de départ des bindings.

◆ cleanup()

C3D_API void castor3d::SceneBackground::cleanup ( )

Fonction de nettoyage.

Paramètres

[in] device Le device actuel.

◆ createBackgroundPass()

virtual C3D_API crg::FramePass & castor3d::SceneBackground::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
	)

virtual

Crée la passe de rendu du fond.

Paramètres

	graph	Le runnable graph.
	device	Le device GPU.
	progress	La barre de progression, optionnelle.
	size	Les dimensions de la zone de rendu.
	colour	Le résultat de couleur.
	depth	L'image de profondeur, optionnelle.
	depthObj	L'image de profondeurs de d'objets, optionnelle.
	modelUbo	L'UBO de modèle.
	matrixUbo	L'UBO de matrices.
	hdrConfigUbo	L'UBO de configuration HDR.
	sceneUbo	L'UBO de scène.
	clearColour	`true` pour vider le résultat de couleur.
[out]	backgroundPass	Reçoit la passe de rendu du fond.

◆ getIbl()

IblTextures const & castor3d::SceneBackground::getIbl ( ) const

inline

Références m_ibl.

◆ getImage()

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

inline

Références m_texture.

◆ getModelName()

virtual C3D_API castor::String const & castor3d::SceneBackground::getModelName ( ) const

virtual

Renvoie: Le nom du modèle de fond.

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

◆ getSampler()

Sampler const & castor3d::SceneBackground::getSampler ( ) const

inline

Références m_sampler.

◆ getScene() [1/2]

Scene & castor3d::SceneBackground::getScene ( )

inline

Références m_scene.

◆ getScene() [2/2]

Scene const & castor3d::SceneBackground::getScene ( ) const

inline

Références m_scene.

◆ getTexture() [1/2]

TextureLayout & castor3d::SceneBackground::getTexture ( )

inline

Références m_texture.

◆ getTexture() [2/2]

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

inline

Références m_texture.

◆ getType()

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

inline

Références m_type.

◆ getView()

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

inline

Références m_texture.

◆ hasIbl()

bool castor3d::SceneBackground::hasIbl ( ) const

inline

Références m_ibl.

◆ hasScattering()

virtual bool castor3d::SceneBackground::hasScattering ( ) const

inlinevirtual

◆ initialise()

C3D_API bool castor3d::SceneBackground::initialise ( RenderDevice const & device )

Fonction d'initialisation.

Paramètres

[in] device Le device actuel.

Renvoie: true if ok.

◆ isDepthSampled()

virtual bool castor3d::SceneBackground::isDepthSampled ( ) const

inlinevirtual

name Accesseurs.

◆ isHdr()

bool castor3d::SceneBackground::isHdr ( ) const

inline

Références m_hdr.

◆ isInitialised()

bool castor3d::SceneBackground::isInitialised ( ) const

inline

Références m_initialised.

◆ isSRGB()

bool castor3d::SceneBackground::isSRGB ( ) const

inline

Références m_srgb.

◆ notifyChanged()

C3D_API void castor3d::SceneBackground::notifyChanged ( )

Notifie un changement affectant le GPU pour le fond.

◆ update() [1/2]

C3D_API void castor3d::SceneBackground::update ( CpuUpdater & updater ) const

Met à jour le fond, niveau CPU.

Paramètres

[in] updater Les données d'update.

◆ update() [2/2]

C3D_API void castor3d::SceneBackground::update ( GpuUpdater & updater ) const

Met à jour le fond, niveau GPU.

Paramètres

[in] updater Les données d'update.

◆ write()

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

pure virtual

Ecrit le fond dans un flux texte.

Paramètres

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

Implémenté dans castor3d::ColourBackground, castor3d::ImageBackground, et castor3d::SkyboxBackground.

Documentation des données membres

◆ m_hdr

bool castor3d::SceneBackground::m_hdr { true }

protected

Référencé par isHdr().

◆ m_ibl

std::unique_ptr< IblTextures > castor3d::SceneBackground::m_ibl

protected

Référencé par getIbl(), et hasIbl().

◆ m_initialised

std::atomic_bool castor3d::SceneBackground::m_initialised { false }

protected

Référencé par isInitialised().

◆ m_sampler

SamplerResPtr castor3d::SceneBackground::m_sampler

protected

Référencé par getSampler().

◆ m_scene

Scene& castor3d::SceneBackground::m_scene

protected

Référencé par getScene().

◆ m_srgb

bool castor3d::SceneBackground::m_srgb { false }

protected

Référencé par isSRGB().

◆ m_texture

TextureLayoutSPtr castor3d::SceneBackground::m_texture

protected

Référencé par getImage(), castor3d::ColourBackground::getImage(), getTexture(), castor3d::ColourBackground::getTexture(), getView(), castor3d::ColourBackground::getView(), et castor3d::SkyboxBackground::setTexture().

◆ m_textureId

Texture castor3d::SceneBackground::m_textureId

protected

◆ m_type

castor::String castor3d::SceneBackground::m_type

protected

Référencé par getType().

◆ onChanged

OnBackgroundChanged castor3d::SceneBackground::onChanged

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

Scene/Background/Background.hpp

Fonctions membres publiques

Attributs publics

Attributs protégés

Documentation des constructeurs et destructeur

◆ SceneBackground()

◆ ~SceneBackground()

Documentation des fonctions membres

◆ accept() [1/2]

◆ accept() [2/2]

◆ addBindings()

◆ addDescriptors()

◆ addPassBindings()

◆ cleanup()

◆ createBackgroundPass()

◆ getIbl()

◆ getImage()

◆ getModelName()

◆ getSampler()

◆ getScene() [1/2]

◆ getScene() [2/2]

◆ getTexture() [1/2]

◆ getTexture() [2/2]

◆ getType()

◆ getView()

◆ hasIbl()

◆ hasScattering()

◆ initialise()

◆ isDepthSampled()

◆ isHdr()

◆ isInitialised()

◆ isSRGB()

◆ notifyChanged()

◆ update() [1/2]

◆ update() [2/2]

◆ write()

Documentation des données membres

◆ m_hdr

◆ m_ibl

◆ m_initialised

◆ m_sampler

◆ m_scene

◆ m_srgb

◆ m_texture

◆ m_textureId

◆ m_type

◆ onChanged