HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdImageShader Class Reference

#include <imageShader.h>

+ Inheritance diagram for HdImageShader:

Public Types

enum  DirtyBits : HdDirtyBits {
  Clean = 0, DirtyEnabled = 1 << 0, DirtyPriority = 1 << 1, DirtyFilePath = 1 << 2,
  DirtyConstants = 1 << 3, AllDirty
}
 

Public Member Functions

HD_API HdImageShader (SdfPath const &id)
 
HD_API ~HdImageShader () override
 
HD_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Sprim API. More...
 
HD_API HdDirtyBits GetInitialDirtyBitsMask () const override
 
HD_API bool GetEnabled () const
 Image shader parameters accessor API. More...
 
HD_API int GetPriority () const
 
HD_API const std::stringGetFilePath () const
 
HD_API const VtDictionaryGetConstants () const
 
- Public Member Functions inherited from HdSprim
HD_API HdSprim (SdfPath const &id)
 
virtual HD_API ~HdSprim ()
 
SdfPath const & GetId () const
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 

Detailed Description

An image shader.

Definition at line 53 of file imageShader.h.

Member Enumeration Documentation

Enumerator
Clean 
DirtyEnabled 
DirtyPriority 
DirtyFilePath 
DirtyConstants 
AllDirty 

Definition at line 62 of file imageShader.h.

Constructor & Destructor Documentation

HD_API HdImageShader::HdImageShader ( SdfPath const &  id)
HD_API HdImageShader::~HdImageShader ( )
override

Member Function Documentation

HD_API const VtDictionary& HdImageShader::GetConstants ( ) const
HD_API bool HdImageShader::GetEnabled ( ) const

Image shader parameters accessor API.

HD_API const std::string& HdImageShader::GetFilePath ( ) const
HD_API HdDirtyBits HdImageShader::GetInitialDirtyBitsMask ( ) const
overridevirtual

Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim. Typically this would be all dirty bits.

Implements HdSprim.

HD_API int HdImageShader::GetPriority ( ) const
HD_API void HdImageShader::Sync ( HdSceneDelegate sceneDelegate,
HdRenderParam renderParam,
HdDirtyBits dirtyBits 
)
overridevirtual

Sprim API.

Synchronizes state from the delegate to this object.

Implements HdSprim.


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