ne::ShaderTextureResourceManager Class Reference

#include <ShaderTextureResourceManager.h>

Public Member Functions
	ShaderTextureResourceManager (const ShaderTextureResourceManager &)=delete
ShaderTextureResourceManager &	operator= (const ShaderTextureResourceManager &)=delete
	~ShaderTextureResourceManager ()
std::variant< ShaderTextureResourceUniquePtr, Error >	createShaderTextureResource (const std::string &sShaderResourceName, const std::string &sResourceAdditionalInfo, const std::unordered_set< Pipeline * > &pipelinesToUse, std::unique_ptr< TextureHandle > pTextureToUse)
std::pair< std::recursive_mutex, std::unordered_map< ShaderTextureResource *, std::unique_ptr< ShaderTextureResource > > > *	getResources ()

Private Member Functions
	ShaderTextureResourceManager (Renderer *pRenderer)
std::variant< ShaderTextureResourceUniquePtr, Error >	handleResourceCreation (std::variant< std::unique_ptr< ShaderTextureResource >, Error > result)
void	destroyResource (ShaderTextureResource *pResourceToDestroy)

Private Attributes
Renderer *	pRenderer = nullptr
std::pair< std::recursive_mutex, std::unordered_map< ShaderTextureResource *, std::unique_ptr< ShaderTextureResource > > >	mtxShaderTextureResources

Friends
class	Renderer
class	ShaderTextureResourceUniquePtr

Detailed Description

Owns all shader resources that references texture resource.

Remarks

This manager does not really do anything but it provides a single and thread-safe way to interact with all shader resources. Initial motivation for this manager was to have a safe way to notify all texture resources using ShaderResourceBase::onAfterAllPipelinesRefreshedResources from pipeline manager (to avoid running this function on not fully initialized shader resources or shader resources that are being destroyed because this could happen if instead of this manager we just had some notifications on ShaderResourceBase constructor/destructor).

Constructor & Destructor Documentation

~ShaderTextureResourceManager()

ne::ShaderTextureResourceManager::~ShaderTextureResourceManager

(

)

Makes sure that no resource exists.

ShaderTextureResourceManager()

ne::ShaderTextureResourceManager::ShaderTextureResourceManager ( Renderer *  pRenderer )

private

Initializes manager.

Parameters

pRenderer

Member Function Documentation

createShaderTextureResource()

std::variant< ShaderTextureResourceUniquePtr, Error > ne::ShaderTextureResourceManager::createShaderTextureResource	(	const std::string &	sShaderResourceName,
		const std::string &	sResourceAdditionalInfo,
		const std::unordered_set< Pipeline * > &	pipelinesToUse,
		std::unique_ptr< TextureHandle >	pTextureToUse
	)

Creates a new render-specific shader resource.

Parameters

sShaderResourceName	Name of the resource we are referencing (should be exactly the same as the resource name written in the shader file we are referencing).
sResourceAdditionalInfo	Additional text that we will append to created resource name (used for logging).
pipelinesToUse	Pipelines that use shader/parameters we are referencing.
pTextureToUse	Texture that should be binded to a descriptor.

Returns

Error if something went wrong, otherwise created shader resource.

destroyResource()

void ne::ShaderTextureResourceManager::destroyResource ( ShaderTextureResource *  pResourceToDestroy )

private

Called by shader texture resource unique pointers to destroy the specified resource because it will no longer be used.

Parameters

pResourceToDestroy

Resource to destroy.

getResources()

std::pair< std::recursive_mutex, std::unordered_map< ShaderTextureResource *, std::unique_ptr< ShaderTextureResource > > > * ne::ShaderTextureResourceManager::getResources

(

)

Returns all shader resources that reference textures.

Remarks

Do not free (delete) or modify unique pointers or returned map.

Returns

Internal resources.

handleResourceCreation()

std::variant< ShaderTextureResourceUniquePtr, Error > ne::ShaderTextureResourceManager::handleResourceCreation ( std::variant< std::unique_ptr< ShaderTextureResource >, Error >  result )

private

Processes resource creation.

Parameters

result

Result of resource creation function.

Returns

Result of resource creation.

Member Data Documentation

mtxShaderTextureResources

std::pair< std::recursive_mutex, std::unordered_map<ShaderTextureResource*, std::unique_ptr<ShaderTextureResource> > > ne::ShaderTextureResourceManager::mtxShaderTextureResources

private

Shader texture resources.

Remarks

Storing pairs of "raw pointer" - "unique pointer" to quickly find needed resources when need to destroy some resource given a raw pointer.

pRenderer

Renderer* ne::ShaderTextureResourceManager::pRenderer = nullptr

private

Renderer that owns this manager.

---

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

• src/engine_lib/private/shader/general/resources/texture/ShaderTextureResourceManager.h
• src/engine_lib/private/shader/general/resources/texture/ShaderTextureResourceManager.cpp