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

#include <EnvironmentMap.hpp>

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

Graphe de collaboration de castor3d::EnvironmentMap:

Types publics
using	EnvironmentMapPasses = castor::Array< EnvironmentMapPassUPtr, size_t( CubeMapFace::eCount ) >

Fonctions membres publiques
C3D_API	EnvironmentMap (crg::ResourcesCache &resources, RenderDevice const &device, QueueData const &queueData, Scene &scene)
	Constructeur.
C3D_API void	cleanup () noexcept
	Vide les passes.
C3D_API void	update (CpuUpdater &updater)
	Met à jour la passe de rendu, au niveau CPU.
C3D_API void	update (GpuUpdater &updater)
	Met à jour la passe de rendu, au niveau GPU.
C3D_API crg::SemaphoreWaitArray	render (crg::SemaphoreWaitArray const &toWait, ashes::Queue const &queue)
	Dessine la texture d'environnement.
C3D_API void	addNode (SceneNode &node)
	Crée une reflection map pour le noeud donné.
C3D_API void	removeNode (SceneNode &node)
	Crée une reflection map pour le noeud donné.
C3D_API bool	hasNode (SceneNode &node) const
C3D_API uint32_t	getIndex (SceneNode const &node) const
VkExtent3D const &	getSize () const noexcept
Scene &	getScene () const noexcept
Texture const &	getColourId () const noexcept
VkImageView	getColourView (uint32_t index) const noexcept
crg::ImageViewId	getColourViewId (uint32_t index, CubeMapFace face) const noexcept
crg::ImageViewId	getDepthViewId (uint32_t index, CubeMapFace face) const noexcept
crg::ImageViewId	getTmpImage (uint32_t index, CubeMapFace face) const noexcept
Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Membres hérités additionnels
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.

Documentation des définitions de type membres

EnvironmentMapPasses

using castor3d::EnvironmentMap::EnvironmentMapPasses = castor::Array< EnvironmentMapPassUPtr, size_t( CubeMapFace::eCount ) >

Documentation des constructeurs et destructeur

EnvironmentMap()

C3D_API castor3d::EnvironmentMap::EnvironmentMap	(	crg::ResourcesCache &	resources,
		RenderDevice const &	device,
		QueueData const &	queueData,
		Scene &	scene )

Constructeur.

Paramètres

[in]	resources	Le gestionnaire de ressources.
[in]	device	Le device GPU.
[in]	queueData	La queue recevant les commandes d'initialisation.
[in]	scene	La scène.

Documentation des fonctions membres

addNode()

C3D_API void castor3d::EnvironmentMap::addNode

(

SceneNode &

node

)

Crée une reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène depuis lequel la reflection map est générée.

cleanup()

C3D_API void castor3d::EnvironmentMap::cleanup ( )

noexcept

Vide les passes.

getColourId()

Texture const & castor3d::EnvironmentMap::getColourId ( ) const

inlinenoexcept

getColourView()

VkImageView castor3d::EnvironmentMap::getColourView ( uint32_t index ) const

inlinenoexcept

getColourViewId()

crg::ImageViewId castor3d::EnvironmentMap::getColourViewId ( uint32_t index, CubeMapFace face ) const

inlinenoexcept

Références castor3d::Texture::subViewsId.

getDepthViewId()

crg::ImageViewId castor3d::EnvironmentMap::getDepthViewId ( uint32_t index, CubeMapFace face ) const

inlinenoexcept

Références castor3d::Texture::subViewsId.

getIndex()

C3D_API uint32_t castor3d::EnvironmentMap::getIndex

(

SceneNode const &

node

)

const

Remarques

Appelez hasEnvironmentMap avant d'appeler cette fonction (celle-ci retournant une référence sur une EnvironmentMap existante)

Renvoie

Récupère la reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène.

getScene()

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

inlinenoexcept

getSize()

VkExtent3D const & castor3d::EnvironmentMap::getSize ( ) const

inlinenoexcept

name Accesseurs.

getTmpImage()

crg::ImageViewId castor3d::EnvironmentMap::getTmpImage ( uint32_t index, CubeMapFace face ) const

inlinenoexcept

Références castor3d::Texture::subViewsId.

hasNode()

C3D_API bool castor3d::EnvironmentMap::hasNode

(

SceneNode &

node

)

const

Renvoie

Dit s'il y a une reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène.

removeNode()

C3D_API void castor3d::EnvironmentMap::removeNode

(

SceneNode &

node

)

Crée une reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène depuis lequel la reflection map est générée.

render()

C3D_API crg::SemaphoreWaitArray castor3d::EnvironmentMap::render	(	crg::SemaphoreWaitArray const &	toWait,
		ashes::Queue const &	queue )

Dessine la texture d'environnement.

Paramètres

[in]	toWait	Les sémaphores à attendre.
[in]	queue	The queue recevant les commandes de dessin.

Renvoie

Les sémaphores signalés par ce dessin.

update() [1/2]

C3D_API void castor3d::EnvironmentMap::update

(

CpuUpdater &

updater

)

Met à jour la passe de rendu, au niveau CPU.

Paramètres

[in,out]

updater

Les données d'update.

update() [2/2]

C3D_API void castor3d::EnvironmentMap::update

(

GpuUpdater &

updater

)

Met à jour la passe de rendu, au niveau GPU.

Paramètres

[in,out]

updater

Les données d'update.

---

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

• Castor3D/Render/EnvironmentMap/EnvironmentMap.hpp