HdStComputeShader Class Reference

#include <computeShader.h>

Inheritance diagram for HdStComputeShader:

Public Member Functions
HDST_API	HdStComputeShader ()
virtual HDST_API	~HdStComputeShader ()
Public Member Functions inherited from HdStShaderCode
HDST_API	HdStShaderCode ()
virtual HDST_API	~HdStShaderCode ()
virtual ID	ComputeTextureSourceHash () const
virtual HDST_API bool	IsEnabledPrimvarFiltering () const
	Returns whether primvar filtering is enabled for this shader. More...
virtual HDST_API TfTokenVector const &	GetPrimvarNames () const
	Returns the names of primvar that are used by this shader. More...
virtual HDST_API TfToken	GetMaterialTag () const
virtual HDST_API void	AddResourcesFromTextures (ResourceContext &ctx) const
virtual HDST_API NamedTextureHandleVector const &	GetNamedTextureHandles () const

HdShader Virtual Interface //
virtual HDST_API std::string	GetSource (TfToken const &shaderStageKey) const
	Setter method for prim. More...
virtual HDST_API HdSt_MaterialParamVector const &	GetParams () const
	Setter method for prim. More...
virtual HDST_API HdBufferArrayRangeSharedPtr const &	GetShaderData () const
	Setter method for prim. More...
virtual HDST_API TextureDescriptorVector	GetTextures () const
	Setter method for prim. More...
virtual HDST_API void	BindResources (int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
	Setter method for prim. More...
virtual HDST_API void	UnbindResources (int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
	Setter method for prim. More...
virtual HDST_API void	AddBindings (HdBindingRequestVector *customBindings)
	Setter method for prim. More...
virtual HDST_API ID	ComputeHash () const
	Setter method for prim. More...
HDST_API void	SetComputeSource (const std::string &source)
	Setter method for prim. More...
virtual HDST_API void	Reload ()
	If the prim is based on asset, reload that asset. More...
HDST_API void	_SetSource (TfToken const &shaderStageKey, std::string const &source)
	Setter method for prim. More...

Additional Inherited Members
Public Types inherited from HdStShaderCode
typedef size_t	ID
typedef std::vector < TextureDescriptor >	TextureDescriptorVector
using	NamedTextureHandleVector = std::vector< NamedTextureHandle >
Static Public Member Functions inherited from HdStShaderCode
static HDST_API ID	ComputeHash (HdStShaderCodeSharedPtrVector const &shaders)
	Returns the combined hash values of multiple shaders. More...

Detailed Description

A scene-based ComputeShader object.

When compute shaders are expressed in the scene graph, the HdSceneDelegate can use this object to express these compute shaders in Storm. In addition to the shader itself, a binding from the Computation Sprim to the ComputeShader must be expressed as well.

Definition at line 54 of file computeShader.h.

Constructor & Destructor Documentation

HDST_API HdStComputeShader::HdStComputeShader

(

)

virtual HDST_API HdStComputeShader::~HdStComputeShader ( )

virtual

Member Function Documentation

HDST_API void HdStComputeShader::_SetSource ( TfToken const &  shaderStageKey, std::string const &  source  )

protected

Setter method for prim.

virtual HDST_API void HdStComputeShader::AddBindings ( HdBindingRequestVector *  customBindings )

virtual

Setter method for prim.

Implements HdStShaderCode.

virtual HDST_API void HdStComputeShader::BindResources ( int  program, HdSt_ResourceBinder const &  binder, HdRenderPassState const &  state  )

overridevirtual

Setter method for prim.

Implements HdStShaderCode.

virtual HDST_API ID HdStComputeShader::ComputeHash ( ) const

virtual

Setter method for prim.

Implements HdStShaderCode.

virtual HDST_API HdSt_MaterialParamVector const& HdStComputeShader::GetParams ( ) const

virtual

Setter method for prim.

Reimplemented from HdStShaderCode.

virtual HDST_API HdBufferArrayRangeSharedPtr const& HdStComputeShader::GetShaderData ( ) const

virtual

Setter method for prim.

Reimplemented from HdStShaderCode.

virtual HDST_API std::string HdStComputeShader::GetSource ( TfToken const &  shaderStageKey ) const

virtual

Setter method for prim.

Implements HdStShaderCode.

virtual HDST_API TextureDescriptorVector HdStComputeShader::GetTextures ( ) const

virtual

Setter method for prim.

Reimplemented from HdStShaderCode.

virtual HDST_API void HdStComputeShader::Reload ( )

virtual

If the prim is based on asset, reload that asset.

HDST_API void HdStComputeShader::SetComputeSource

(

const std::string &

source

)

Setter method for prim.

virtual HDST_API void HdStComputeShader::UnbindResources ( int  program, HdSt_ResourceBinder const &  binder, HdRenderPassState const &  state  )

overridevirtual

Setter method for prim.

Implements HdStShaderCode.

---

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

• pxr/imaging/hdSt/computeShader.h