#include <VulkanShadowMapArrayIndexManager.h>

Inheritance diagram for ne::VulkanShadowMapArrayIndexManager:

Classes
struct	InternalData

Public Member Functions
	VulkanShadowMapArrayIndexManager (const VulkanShadowMapArrayIndexManager &)=delete

VulkanShadowMapArrayIndexManager &	operator= (const VulkanShadowMapArrayIndexManager &)=delete

	VulkanShadowMapArrayIndexManager (VulkanShadowMapArrayIndexManager &&) noexcept=delete

VulkanShadowMapArrayIndexManager &	operator= (VulkanShadowMapArrayIndexManager &&) noexcept=delete

	VulkanShadowMapArrayIndexManager (Renderer *pRenderer, const std::string &sShaderArrayResourceName)

Public Member Functions inherited from ne::ShadowMapArrayIndexManager
	ShadowMapArrayIndexManager (const ShadowMapArrayIndexManager &)=delete

ShadowMapArrayIndexManager &	operator= (const ShadowMapArrayIndexManager &)=delete

	ShadowMapArrayIndexManager (ShadowMapArrayIndexManager &&) noexcept=delete

ShadowMapArrayIndexManager &	operator= (ShadowMapArrayIndexManager &&) noexcept=delete

Protected Member Functions
virtual std::optional< Error >	registerShadowMapResource (ShadowMapHandle *pShadowMapHandle) override

virtual std::optional< Error >	unregisterShadowMapResource (ShadowMapHandle *pShadowMapHandle) override

virtual std::optional< Error >	bindShadowMapsToPipeline (Pipeline *pPipeline) override

virtual std::optional< Error >	bindShadowMapsToAllPipelines () override

Protected Member Functions inherited from ne::ShadowMapArrayIndexManager
	ShadowMapArrayIndexManager (Renderer *pRenderer, const std::string &sShaderArrayResourceName)

virtual std::optional< Error >	registerShadowMapResource (ShadowMapHandle *pShadowMapHandle)=0

virtual std::optional< Error >	unregisterShadowMapResource (ShadowMapHandle *pShadowMapHandle)=0

virtual std::optional< Error >	bindShadowMapsToPipeline (Pipeline *pPipeline)=0

virtual std::optional< Error >	bindShadowMapsToAllPipelines ()=0

std::string_view	getShaderArrayResourceName ()

Renderer *	getRenderer () const

Private Member Functions
std::optional< Error >	bindShadowMapsToAllPipelines (ShadowMapHandle *pOnlyBindThisShadowMap)

std::optional< Error >	bindShadowMapsToPipeline (Pipeline pPipeline, ShadowMapHandle pOnlyBindThisShadowMap)

std::optional< Error >	bindShadowMapToPipelineIfUsed (ShadowMapHandle pShadowMapHandle, VulkanPipeline pPipeline, VkSampler pSampler)

Private Attributes
std::pair< std::recursive_mutex, InternalData >	mtxInternalData

Additional Inherited Members
Static Public Member Functions inherited from ne::ShadowMapArrayIndexManager
static std::variant< std::unique_ptr< ShadowMapArrayIndexManager >, Error >	create (Renderer pRenderer, GpuResourceManager pResourceManager, const std::string &sShaderArrayResourceName)

Static Protected Member Functions inherited from ne::ShadowMapArrayIndexManager
static void	changeShadowMapArrayIndex (ShadowMapHandle *pShadowMapHandle, unsigned int iNewArrayIndex)

Detailed Description

Manages indices of shadows maps into a descriptor array used by shaders.

Constructor & Destructor Documentation

◆ VulkanShadowMapArrayIndexManager()

ne::VulkanShadowMapArrayIndexManager::VulkanShadowMapArrayIndexManager	(	Renderer *	pRenderer,
		const std::string &	sShaderArrayResourceName
	)

Initializes the manager.

Parameters

pRenderer	Renderer.
sShaderArrayResourceName	Name of the array (defined in shaders) that this manager controls.

Member Function Documentation

◆ bindShadowMapsToAllPipelines() [1/2]

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::bindShadowMapsToAllPipelines ( )

overrideprotectedvirtual

Goes through all graphics pipelines ad binds shadow maps to pipelines that use them.

Returns: Error if something went wrong.

Implements ne::ShadowMapArrayIndexManager.

◆ bindShadowMapsToAllPipelines() [2/2]

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::bindShadowMapsToAllPipelines ( ShadowMapHandle * pOnlyBindThisShadowMap )

private

Goes through all graphics pipelines ad binds shadow map(s) to pipelines that use them.

Parameters

pOnlyBindThisShadowMap If nullptr then binds all shadow maps from mtxInternalData, otherwise only binds the specified already registered (!) shadow map to all pipelines that reference it.

Returns: Error if something went wrong.

◆ bindShadowMapsToPipeline() [1/2]

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::bindShadowMapsToPipeline ( Pipeline * pPipeline )

overrideprotectedvirtual

Looks if the specified pipeline uses shadow maps and if uses binds shadow maps to the pipeline.

Parameters

pPipeline Pipeline to bind shadow maps to.

Returns: Error if something went wrong.

Implements ne::ShadowMapArrayIndexManager.

◆ bindShadowMapsToPipeline() [2/2]

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::bindShadowMapsToPipeline	(	Pipeline *	pPipeline,
		ShadowMapHandle *	pOnlyBindThisShadowMap
	)

private

Looks if the specified pipeline uses shadow map(s) and if uses binds shadow map(s) to the pipeline.

Parameters

pPipeline	Pipeline to bind shadow maps to.
pOnlyBindThisShadowMap	If `nullptr` then binds all shadow maps from mtxInternalData, otherwise only binds the specified already registered (!) shadow map to the specified pipelines if it references it.

Returns: Error if something went wrong.

◆ bindShadowMapToPipelineIfUsed()

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::bindShadowMapToPipelineIfUsed	(	ShadowMapHandle *	pShadowMapHandle,
		VulkanPipeline *	pPipeline,
		VkSampler	pSampler
	)

private

Binds the specified shadow map to the specified pipeline.

Parameters

pShadowMapHandle	Handle to shadow map to bind.
pPipeline	Pipeline to bind the shadow map to.
pSampler	Texture sampler to use.

Returns: Error if something went wrong.

◆ registerShadowMapResource()

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::registerShadowMapResource ( ShadowMapHandle * pShadowMapHandle )

overrideprotectedvirtual

Reserves an index into a descriptor array for the shadow map resource of the specified handle and bind internal GPU shadow map resource (if the handle) to that descriptor.

Remarks: Use unregisterShadowMapResource to unregister it later (must be done before this manager is destroyed) when shadow map is being destroyed.

Parameters

pShadowMapHandle Shadow map to register.

Returns: Error if something went wrong.

Implements ne::ShadowMapArrayIndexManager.

◆ unregisterShadowMapResource()

std::optional< Error > ne::VulkanShadowMapArrayIndexManager::unregisterShadowMapResource ( ShadowMapHandle * pShadowMapHandle )

overrideprotectedvirtual

Unregisters a shadow map and frees its index into a descriptor array to be used by others.

Parameters

pShadowMapHandle Shadow map to unregister.

Returns: Error if something went wrong.

Implements ne::ShadowMapArrayIndexManager.

Member Data Documentation

◆ mtxInternalData

std::pair<std::recursive_mutex, InternalData> ne::VulkanShadowMapArrayIndexManager::mtxInternalData

private

Mutex guarded internal data.

The documentation for this class was generated from the following files:

src/engine_lib/private/render/vulkan/resource/shadow/VulkanShadowMapArrayIndexManager.h
src/engine_lib/private/render/vulkan/resource/shadow/VulkanShadowMapArrayIndexManager.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VulkanShadowMapArrayIndexManager()

Member Function Documentation

◆ bindShadowMapsToAllPipelines() [1/2]

◆ bindShadowMapsToAllPipelines() [2/2]

◆ bindShadowMapsToPipeline() [1/2]

◆ bindShadowMapsToPipeline() [2/2]

◆ bindShadowMapToPipelineIfUsed()

◆ registerShadowMapResource()

◆ unregisterShadowMapResource()

Member Data Documentation

◆ mtxInternalData