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

#include <ShadowMap.hpp>

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

Graphe de collaboration de castor3d::ShadowMap:

Classes
struct	AllPasses
struct	PassData
struct	Passes

Types publics
using	PassDataPtr = castor::RawUniquePtr< PassData >

Fonctions membres publiques
C3D_API	ShadowMap (crg::ResourcesCache &resources, RenderDevice const &device, Scene &scene, LightType lightType, VkImageCreateFlags createFlags, castor::Size const &size, uint32_t layerCount, uint32_t count)
	Constructeur.
virtual C3D_API	~ShadowMap () noexcept=default
	Destructeur.
C3D_API void	accept (ConfigurationVisitorBase &visitor)
	Fonction d'acceptation de visiteur.
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, uint32_t index)
	Dessine la texture d'ombres.
C3D_API ashes::VkClearValueArray const &	getClearValues () const
C3D_API ashes::Sampler const &	getSampler (SmTexture texture, uint32_t index=0u) const
virtual C3D_API crg::ImageViewId	getView (SmTexture texture, uint32_t index=0u) const
virtual C3D_API crg::ImageViewIdArray	getViews (SmTexture texture, uint32_t index=0u) const
ShadowMapResult const &	getShadowPassResult (bool isStatic) const noexcept
ShadowMapResult &	getShadowPassResult (bool isStatic) noexcept
Scene &	getScene () const noexcept
uint32_t	getCount () const noexcept
Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Fonctions membres protégées
C3D_API void	doRegisterGraphIO (crg::FramePassGroup &graph, bool vsm, bool rsm, bool isStatic) const
C3D_API bool	doEnableCopyStatic (uint32_t index) const
C3D_API bool	doEnableBlur (uint32_t index) const
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.

Attributs protégés
RenderDevice const &	m_device
crg::ResourcesCache &	m_resources
Scene &	m_scene
castor::String	m_name
LightType	m_lightType
ShadowMapResult	m_staticsResult
ShadowMapResult	m_result
uint32_t	m_count
castor::Array< AllPasses, 4u >	m_passes
uint32_t	m_passesIndex {}

Documentation des définitions de type membres

PassDataPtr

using castor3d::ShadowMap::PassDataPtr = castor::RawUniquePtr< PassData >

Documentation des constructeurs et destructeur

ShadowMap()

C3D_API castor3d::ShadowMap::ShadowMap	(	crg::ResourcesCache &	resources,
		RenderDevice const &	device,
		Scene &	scene,
		LightType	lightType,
		VkImageCreateFlags	createFlags,
		castor::Size const &	size,
		uint32_t	layerCount,
		uint32_t	count )

Constructeur.

Paramètres

[in]	resources	Le gestionnaire de ressources du render graph.
[in]	device	Le device GPU.
[in]	scene	La scène.
[in]	lightType	Le type de source lumineuse.
[in]	createFlags	Les flags de créqation de l'image résultat.
[in]	size	Les dimensions de l'image résultat.
[in]	layerCount	Le nombres de layers de l'image résultat.
[in]	count	Le nombre de passes.

~ShadowMap()

virtual C3D_API castor3d::ShadowMap::~ShadowMap ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

accept()

C3D_API void castor3d::ShadowMap::accept

(

ConfigurationVisitorBase &

visitor

)

Fonction d'acceptation de visiteur.

Paramètres

visitor

Le visiteur.

doEnableBlur()

C3D_API bool castor3d::ShadowMap::doEnableBlur ( uint32_t index ) const

protected

doEnableCopyStatic()

C3D_API bool castor3d::ShadowMap::doEnableCopyStatic ( uint32_t index ) const

protected

doRegisterGraphIO()

C3D_API void castor3d::ShadowMap::doRegisterGraphIO ( crg::FramePassGroup & graph, bool vsm, bool rsm, bool isStatic ) const

protected

getClearValues()

C3D_API ashes::VkClearValueArray const & castor3d::ShadowMap::getClearValues

(

)

const

name Accesseurs.

getCount()

uint32_t castor3d::ShadowMap::getCount ( ) const

inlinenoexcept

Références m_count.

getSampler()

C3D_API ashes::Sampler const & castor3d::ShadowMap::getSampler	(	SmTexture	texture,
		uint32_t	index = 0u ) const

getScene()

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

inlinenoexcept

Références m_scene.

getShadowPassResult() [1/2]

ShadowMapResult const & castor3d::ShadowMap::getShadowPassResult ( bool isStatic ) const

inlinenoexcept

Références m_result, et m_staticsResult.

getShadowPassResult() [2/2]

ShadowMapResult & castor3d::ShadowMap::getShadowPassResult ( bool isStatic )

inlinenoexcept

Références m_result, et m_staticsResult.

getView()

virtual C3D_API crg::ImageViewId castor3d::ShadowMap::getView ( SmTexture texture, uint32_t index = 0u ) const

virtual

getViews()

virtual C3D_API crg::ImageViewIdArray castor3d::ShadowMap::getViews ( SmTexture texture, uint32_t index = 0u ) const

virtual

render()

C3D_API crg::SemaphoreWaitArray castor3d::ShadowMap::render	(	crg::SemaphoreWaitArray const &	toWait,
		ashes::Queue const &	queue,
		uint32_t	index )

Dessine la texture d'ombres.

Paramètres

[in]	toWait	Les sémaphores à attendre.
[in]	queue	The queue recevant les commandes de dessin.
[in]	index	L'index de la layer à dessiner.

Renvoie

Les sémaphores signalés par ce dessin.

update() [1/2]

C3D_API void castor3d::ShadowMap::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::ShadowMap::update

(

GpuUpdater &

updater

)

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

Paramètres

[in,out]

updater

Les données d'update.

Documentation des données membres

m_count

uint32_t castor3d::ShadowMap::m_count

protected

Référencé par getCount().

m_device

RenderDevice const& castor3d::ShadowMap::m_device

protected

m_lightType

LightType castor3d::ShadowMap::m_lightType

protected

m_name

castor::String castor3d::ShadowMap::m_name

protected

m_passes

castor::Array< AllPasses, 4u > castor3d::ShadowMap::m_passes

protected

m_passesIndex

uint32_t castor3d::ShadowMap::m_passesIndex {}

protected

m_resources

crg::ResourcesCache& castor3d::ShadowMap::m_resources

protected

m_result

ShadowMapResult castor3d::ShadowMap::m_result

protected

Référencé par getShadowPassResult(), getShadowPassResult(), et castor3d::ShadowMapPoint::getTexture().

m_scene

Scene& castor3d::ShadowMap::m_scene

protected

Référencé par getScene().

m_staticsResult

ShadowMapResult castor3d::ShadowMap::m_staticsResult

protected

Référencé par getShadowPassResult(), et getShadowPassResult().

---

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

• Castor3D/Render/ShadowMap/ShadowMap.hpp