ne::HlslGlobalShaderResourceBinding Class Reference

#include <HlslGlobalShaderResourceBinding.h>

Inheritance diagram for ne::HlslGlobalShaderResourceBinding:

Protected Member Functions
	HlslGlobalShaderResourceBinding (GlobalShaderResourceBindingManager *pManager, const std::string &sShaderResourceName, const std::array< GpuResource *, FrameResourceManager::getFrameResourceCount()> &vResourcesToBind)
virtual std::optional< Error >	bindToPipelines (Pipeline *pSpecificPipeline) override
Protected Member Functions inherited from ne::GlobalShaderResourceBinding
	GlobalShaderResourceBinding (GlobalShaderResourceBindingManager *pManager, const std::string &sShaderResourceName, const std::array< GpuResource *, FrameResourceManager::getFrameResourceCount()> &vResourcesToBind)
virtual std::optional< Error >	bindToPipelines (Pipeline *pSpecificPipeline)=0
void	unregisterBinding ()
const std::string &	getShaderResourceName () const
std::array< GpuResource *, FrameResourceManager::getFrameResourceCount()>	getBindedResources () const

Static Private Member Functions
static std::optional< Error >	bindResourceToGraphicsPipelines (PipelineManager *pPipelineManager, const std::function< std::optional< Error >(Pipeline *pPipeline)> &onBind)
static std::optional< Error >	bindResourcesToPipeline (const std::array< DirectXResource *, FrameResourceManager::getFrameResourceCount()> &vResourcesToBind, DirectXDescriptorType bindingType, Pipeline *pPipeline, const std::string &sShaderResourceName)

Friends
class	GlobalShaderResourceBinding

Additional Inherited Members
Public Member Functions inherited from ne::GlobalShaderResourceBinding
	GlobalShaderResourceBinding (const GlobalShaderResourceBinding &)=delete
GlobalShaderResourceBinding &	operator= (const GlobalShaderResourceBinding &)=delete
	GlobalShaderResourceBinding (GlobalShaderResourceBinding &&)=delete
GlobalShaderResourceBinding &	operator= (GlobalShaderResourceBinding &&)=delete
Static Protected Member Functions inherited from ne::GlobalShaderResourceBinding
static std::optional< Error >	create (Renderer *pRenderer, GlobalShaderResourceBindingManager *pManager, const std::string &sShaderResourceName, const std::array< GpuResource *, FrameResourceManager::getFrameResourceCount()> &vResourcesToBind)

Detailed Description

Used for binding GPU resources as "global" HLSL shader resources (that don't change on a per-object basis).

Constructor & Destructor Documentation

HlslGlobalShaderResourceBinding()

ne::HlslGlobalShaderResourceBinding::HlslGlobalShaderResourceBinding ( GlobalShaderResourceBindingManager *  pManager, const std::string &  sShaderResourceName, const std::array< GpuResource *, FrameResourceManager::getFrameResourceCount()> &  vResourcesToBind  )

protected

Initializes a new object, does not trigger bindToPipelines.

Parameters

pManager	Manager that creates this object.
sShaderResourceName	Name of the shader resource (name from shader code) to bind the resources.
vResourcesToBind	Resources to bind to pipelines. This can be the same resource for all frame resources (for example a texture) or a separate resource per frame (can be used for some CPU-write resources).

Member Function Documentation

bindResourcesToPipeline()

std::optional< Error > ne::HlslGlobalShaderResourceBinding::bindResourcesToPipeline ( const std::array< DirectXResource *, FrameResourceManager::getFrameResourceCount()> &  vResourcesToBind, DirectXDescriptorType  bindingType, Pipeline *  pPipeline, const std::string &  sShaderResourceName  )

staticprivate

Binds the specified resources to the specified pipeline as a global SRV binding.

Parameters

vResourcesToBind	Resource per frame to bind.
bindingType	Type of the binding to create.
pPipeline	Pipeline to bind to.
sShaderResourceName	Name of the shader resource to bind to.

Returns

bindResourceToGraphicsPipelines()

std::optional< Error > ne::HlslGlobalShaderResourceBinding::bindResourceToGraphicsPipelines ( PipelineManager *  pPipelineManager, const std::function< std::optional< Error >(Pipeline *pPipeline)> &  onBind  )

staticprivate

Specify a callback that will be called for each graphics pipeline to bind your resource.

Parameters

pPipelineManager	Manager to query graphics pipelines.
onBind	Called on each pipeline.

Returns

Error if something went wrong.

bindToPipelines()

std::optional< Error > ne::HlslGlobalShaderResourceBinding::bindToPipelines ( Pipeline *  pSpecificPipeline )

overrideprotectedvirtual

Binds the resource to a specific pipeline or all graphics pipelines that use it.

Parameters

pSpecificPipeline

nullptr if need to bind to all graphics pipelines, otherwise a valid pointer to bind only to that pipeline.

Returns

Error if something went wrong.

Implements ne::GlobalShaderResourceBinding.

---

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

• src/engine_lib/private/shader/hlsl/resource/binding/global/HlslGlobalShaderResourceBinding.h
• src/engine_lib/private/shader/hlsl/resource/binding/global/HlslGlobalShaderResourceBinding.cpp