#include <DirectXShadowMapArrayIndexManager.h>

Inheritance diagram for ne::DirectXShadowMapArrayIndexManager:

Public Member Functions
	DirectXShadowMapArrayIndexManager (const DirectXShadowMapArrayIndexManager &)=delete

DirectXShadowMapArrayIndexManager &	operator= (const DirectXShadowMapArrayIndexManager &)=delete

	DirectXShadowMapArrayIndexManager (DirectXShadowMapArrayIndexManager &&) noexcept=delete

DirectXShadowMapArrayIndexManager &	operator= (DirectXShadowMapArrayIndexManager &&) noexcept=delete

virtual	~DirectXShadowMapArrayIndexManager () override

ContinuousDirectXDescriptorRange *	getSrvDescriptorRange () const

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

Static Public Member Functions
static std::variant< std::unique_ptr< DirectXShadowMapArrayIndexManager >, Error >	create (Renderer pRenderer, GpuResourceManager pResourceManager, const std::string &sShaderArrayResourceName)

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)

Protected Member Functions
	DirectXShadowMapArrayIndexManager (Renderer *pRenderer, const std::string &sShaderArrayResourceName)

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::variant< unsigned int, Error >	getSrvDescriptorOffsetFromRangeStart (DirectXResource *pResource)

void	onSrvRangeIndicesChanged ()

Private Attributes
std::unique_ptr< ContinuousDirectXDescriptorRange >	pSrvRange

std::pair< std::recursive_mutex, std::unordered_set< ShadowMapHandle * > >	mtxRegisteredShadowMaps

Additional Inherited Members
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

◆ ~DirectXShadowMapArrayIndexManager()

ne::DirectXShadowMapArrayIndexManager::~DirectXShadowMapArrayIndexManager ( )

overridevirtual

Makes sure no descriptor is registered.

◆ DirectXShadowMapArrayIndexManager()

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

protected

Initializes the manager except for SRV range which is expected to be initialized after construction.

Warning: Only used internally, prefer to use create.

Parameters

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

Member Function Documentation

◆ bindShadowMapsToAllPipelines()

std::optional< Error > ne::DirectXShadowMapArrayIndexManager::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.

◆ bindShadowMapsToPipeline()

std::optional< Error > ne::DirectXShadowMapArrayIndexManager::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.

◆ create()

std::variant< std::unique_ptr< DirectXShadowMapArrayIndexManager >, Error > ne::DirectXShadowMapArrayIndexManager::create	(	Renderer *	pRenderer,
		GpuResourceManager *	pResourceManager,
		const std::string &	sShaderArrayResourceName
	)

static

Creates a new index manager.

Parameters

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

Returns: Error if something went wrong, otherwise created manager.

◆ getSrvDescriptorOffsetFromRangeStart()

std::variant< unsigned int, Error > ne::DirectXShadowMapArrayIndexManager::getSrvDescriptorOffsetFromRangeStart ( DirectXResource * pResource )

private

Calculates offset of the SRV descriptor (of the specified resource) from the start of the continuous SRV descriptor range that this manager stores.

Parameters

pResource Resource with binded SRV descriptor.

Returns: Error if something went wrong, otherwise offset of the SRV descriptor from range start.

◆ getSrvDescriptorRange()

ContinuousDirectXDescriptorRange * ne::DirectXShadowMapArrayIndexManager::getSrvDescriptorRange ( ) const

inline

Returns internal SRV descriptor range to the array of shadow maps.

Returns: SRV descriptor range.

◆ onSrvRangeIndicesChanged()

void ne::DirectXShadowMapArrayIndexManager::onSrvRangeIndicesChanged ( )

private

Called after SRV range changed its location in the heap.

◆ registerShadowMapResource()

std::optional< Error > ne::DirectXShadowMapArrayIndexManager::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::DirectXShadowMapArrayIndexManager::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

◆ mtxRegisteredShadowMaps

std::pair<std::recursive_mutex, std::unordered_set<ShadowMapHandle*> > ne::DirectXShadowMapArrayIndexManager::mtxRegisteredShadowMaps

private

Info about shadows maps that take place in this array.

◆ pSrvRange

std::unique_ptr<ContinuousDirectXDescriptorRange> ne::DirectXShadowMapArrayIndexManager::pSrvRange

private

Continuous SRV descriptor range of registered shadow maps for shaders.

Remarks: Always valid, never changing pointer.

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

src/engine_lib/private/render/directx/resources/shadow/DirectXShadowMapArrayIndexManager.h
src/engine_lib/private/render/directx/resources/shadow/DirectXShadowMapArrayIndexManager.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~DirectXShadowMapArrayIndexManager()

◆ DirectXShadowMapArrayIndexManager()

Member Function Documentation

◆ bindShadowMapsToAllPipelines()

◆ bindShadowMapsToPipeline()

◆ create()

◆ getSrvDescriptorOffsetFromRangeStart()

◆ getSrvDescriptorRange()

◆ onSrvRangeIndicesChanged()

◆ registerShadowMapResource()

◆ unregisterShadowMapResource()

Member Data Documentation

◆ mtxRegisteredShadowMaps

◆ pSrvRange