Loading...
Searching...
No Matches
HdImageShader Class Reference

An image shader. More...

#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 , DirtyMaterialNetwork = 1 << 4 , AllDirty
}
 

Public Member Functions

HD_API HdImageShader (SdfPath const &id)
 
HD_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Sprim API.
 
HD_API HdDirtyBits GetInitialDirtyBitsMask () const override
 Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.
 
HD_API bool GetEnabled () const
 Image shader parameters accessor API.
 
HD_API int GetPriority () const
 
HD_API const std::string & GetFilePath () const
 
HD_API const VtDictionaryGetConstants () const
 
HD_API const HdMaterialNetworkInterfaceGetMaterialNetwork () const
 
- Public Member Functions inherited from HdSprim
HD_API HdSprim (SdfPath const &id)
 
SdfPath const & GetId () const
 Returns the identifier by which this state is known.
 
virtual void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
 Synchronizes state from the delegate to this object.
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 Finalizes object resources.
 
virtual HdDirtyBits GetInitialDirtyBitsMask () const =0
 Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.
 

Detailed Description

An image shader.

Definition at line 56 of file imageShader.h.

Member Enumeration Documentation

◆ DirtyBits

enum DirtyBits : HdDirtyBits

Definition at line 65 of file imageShader.h.

Member Function Documentation

◆ GetEnabled()

HD_API bool GetEnabled ( ) const

Image shader parameters accessor API.

◆ GetInitialDirtyBitsMask()

HD_API HdDirtyBits 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.

◆ Sync()

HD_API void 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: