ne::HlslShaderTextureResourceBinding Class Reference

#include <HlslShaderTextureResourceBinding.h>

Inheritance diagram for ne::HlslShaderTextureResourceBinding:

Public Member Functions
void	copyResourceIndexToRootConstants (PipelineShaderConstantsManager *pShaderConstantsManager, DirectXPso *pUsedPipeline)
virtual std::optional< Error >	useNewTexture (std::unique_ptr< TextureHandle > pTextureToUse) override
virtual std::optional< Error >	changeUsedPipelines (const std::unordered_set< Pipeline * > &pipelinesToUse) override
virtual std::optional< Error >	useNewTexture (std::unique_ptr< TextureHandle > pTextureToUse)=0
Public Member Functions inherited from ne::ShaderResourceBindingBase
virtual std::optional< Error >	changeUsedPipelines (const std::unordered_set< Pipeline * > &pipelinesToUse)=0
std::string	getShaderResourceName () const

Protected Member Functions
	HlslShaderTextureResourceBinding (const std::string &sResourceName, std::unique_ptr< TextureHandle > pTextureToUse, std::unordered_map< DirectXPso *, size_t > &&shaderConstantOffsetPerPipeline)
virtual std::optional< Error >	onAfterAllPipelinesRefreshedResources () override
Protected Member Functions inherited from ne::ShaderTextureResourceBinding
	ShaderTextureResourceBinding (const std::string &sShaderResourceName)
Protected Member Functions inherited from ne::ShaderResourceBindingBase
	ShaderResourceBindingBase (const std::string &sShaderResourceName)
virtual std::optional< Error >	onAfterAllPipelinesRefreshedResources ()=0

Static Private Member Functions
static std::variant< std::unique_ptr< ShaderTextureResourceBinding >, Error >	create (const std::string &sShaderResourceName, const std::unordered_set< Pipeline * > &pipelinesToUse, std::unique_ptr< TextureHandle > pTextureToUse)
static std::variant< std::shared_ptr< ContinuousDirectXDescriptorRange >, Error >	getSrvDescriptorRange (DirectXPso *pPipeline, const std::string &sShaderResourceName)

Private Attributes
std::pair< std::mutex, std::unique_ptr< TextureHandle > >	mtxUsedTexture
std::pair< std::recursive_mutex, std::unordered_map< DirectXPso *, size_t > >	mtxShaderConstantOffsetPerPipeline

Static Private Attributes
static constexpr bool	bBindSrvToCubemapFaces = false

Friends
class	ShaderTextureResourceBindingManager

Detailed Description

References some texture from shader code.

Constructor & Destructor Documentation

HlslShaderTextureResourceBinding()

ne::HlslShaderTextureResourceBinding::HlslShaderTextureResourceBinding ( const std::string &  sResourceName, std::unique_ptr< TextureHandle >  pTextureToUse, std::unordered_map< DirectXPso *, size_t > &&  shaderConstantOffsetPerPipeline  )

protected

Initializes the resource.

Remarks

Used internally, for outside usage prefer to use create.

Parameters

sResourceName	Name of the resource we are referencing (should be exactly the same as the resource name written in the shader file we are referencing).
pTextureToUse	Texture with an SRV already bound from an SRV range.
shaderConstantOffsetPerPipeline	A shader constant index for our shader resource (per pipeline).

Member Function Documentation

changeUsedPipelines()

std::optional< Error > ne::HlslShaderTextureResourceBinding::changeUsedPipelines ( const std::unordered_set< Pipeline * > &  pipelinesToUse )

overridevirtual

Called to make the resource to discard currently used pipelines and bind/reference other pipelines.

Warning

Expects that the caller is using some mutex to protect this shader resource from being used in the draw function while this function is not finished (i.e. make sure the CPU will not queue a new frame while this function is not finished).

Remarks

For example, for this function can be called from a mesh node that changed its geometry and thus added/removed some material slots, or if some material that mesh node is using changed its pipeline.

Parameters

pipelinesToUse

Pipelines to use instead of the current ones.

Returns

Error if something went wrong.

Implements ne::ShaderResourceBindingBase.

copyResourceIndexToRootConstants()

void ne::HlslShaderTextureResourceBinding::copyResourceIndexToRootConstants ( PipelineShaderConstantsManager *  pShaderConstantsManager, DirectXPso *  pUsedPipeline  )

inline

Copies resource index (into shader arrays) to a root constant.

Parameters

pShaderConstantsManager	Shader constants manager.
pUsedPipeline	Current pipeline.

create()

std::variant< std::unique_ptr< ShaderTextureResourceBinding >, Error > ne::HlslShaderTextureResourceBinding::create ( const std::string &  sShaderResourceName, const std::unordered_set< Pipeline * > &  pipelinesToUse, std::unique_ptr< TextureHandle >  pTextureToUse  )

staticprivate

Creates a new HLSL 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).
pipelinesToUse	Pipelines that use shader/parameters we are referencing.
pTextureToUse	Texture to which a descriptor should be binded.

Returns

Error if something went wrong, otherwise created shader resource.

getSrvDescriptorRange()

std::variant< std::shared_ptr< ContinuousDirectXDescriptorRange >, Error > ne::HlslShaderTextureResourceBinding::getSrvDescriptorRange ( DirectXPso *  pPipeline, const std::string &  sShaderResourceName  )

staticprivate

In the specified pipeline looks for a descriptor range that handles a shader resource with the specified name (creates a new descriptor range if not found and returns a pointer to it).

Parameters

pPipeline	Pipeline to look in.
sShaderResourceName	Shader resource to look for.

Returns

Error if something went wrong, otherwise a pointer to descriptor range from the pipeline.

onAfterAllPipelinesRefreshedResources()

std::optional< Error > ne::HlslShaderTextureResourceBinding::onAfterAllPipelinesRefreshedResources ( )

overrideprotectedvirtual

Called from pipeline manager to notify that all pipelines released their internal resources and now restored them so their internal resources (for example push constants) might be different now and shader resource now needs to check that everything that it needs is still there and possibly re-bind to pipeline's descriptors since these might have been also re-created.

Returns

Error if something went wrong.

Implements ne::ShaderResourceBindingBase.

useNewTexture()

std::optional< Error > ne::HlslShaderTextureResourceBinding::useNewTexture ( std::unique_ptr< TextureHandle >  pTextureToUse )

overridevirtual

Makes the shader resource to reference the new (specified) texture.

Warning

Expects that the caller is using some mutex to protect this shader resource from being used in the draw function while this function is not finished (i.e. make sure the CPU will not queue a new frame while this function is not finished).

Parameters

pTextureToUse

Texture to reference.

Returns

Error if something went wrong.

Implements ne::ShaderTextureResourceBinding.

Member Data Documentation

bBindSrvToCubemapFaces

constexpr bool ne::HlslShaderTextureResourceBinding::bBindSrvToCubemapFaces = false

staticconstexprprivate

false to avoid binding descriptors to cubemap faces - I don't see any point in that here, we don't use individual cubemap faces in this case

mtxShaderConstantOffsetPerPipeline

std::pair<std::recursive_mutex, std::unordered_map<DirectXPso*, size_t> > ne::HlslShaderTextureResourceBinding::mtxShaderConstantOffsetPerPipeline

private

Stores an offset of the shader constant to copy mtxUsedTexture SRV descriptor offset to.

mtxUsedTexture

std::pair<std::mutex, std::unique_ptr<TextureHandle> > ne::HlslShaderTextureResourceBinding::mtxUsedTexture

private

Texture to which a descriptor should be bound.

---

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

• src/engine_lib/private/shader/hlsl/resource/binding/texture/HlslShaderTextureResourceBinding.h
• src/engine_lib/private/shader/hlsl/resource/binding/texture/HlslShaderTextureResourceBinding.cpp