HdPrmanMaterial Class Referencefinal

A representation for materials (including displacement) in prman. More...

+ Inheritance diagram for HdPrmanMaterial:

Public Member Functions

 HdPrmanMaterial (SdfPath const &id)
 
void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Synchronizes state from the delegate to this object. More...
 
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. More...
 
riley::MaterialId GetMaterialId () const
 
riley::DisplacementId GetDisplacementId () const
 
bool IsValid () const
 Return true if this material is valid. More...
 
void Finalize (HdRenderParam *renderParam) override
 Finalizes object resources. More...
 
HdMaterialNetwork2 const & GetMaterialNetwork () const
 Return the material network after filtering. More...
 
- 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. More...
 

Static Public Member Functions

static TfTokenVector const & GetShaderSourceTypes ()
 Return the static list of tokens supported. More...
 
static MatfiltFilterChain GetFilterChain ()
 Get material filtering chain. More...
 
static void SetFilterChain (MatfiltFilterChain const &chain)
 Set material filtering chain. More...
 
static bool GetUseSceneIndexForMatfilt ()
 Returns whether it's possible and preferred to use scene indices in place of matfilt callbacks. More...
 

Additional Inherited Members

- Public Types inherited from HdMaterial
enum  DirtyBits : HdDirtyBits { Clean = 0, DirtyParams = 1 << 2, DirtyResource = 1 << 3, AllDirty = (DirtyParams | DirtyResource) }
 
- Protected Member Functions inherited from HdMaterial
HD_API HdMaterial (SdfPath const &id)
 

Detailed Description

A representation for materials (including displacement) in prman.

Definition at line 41 of file material.h.

Member Function Documentation

◆ Finalize()

void Finalize ( HdRenderParam renderParam)
overridevirtual

Finalizes object resources.

This function might not delete resources, but it should deal with resource ownership so that the sprim is deletable.

Reimplemented from HdSprim.

◆ GetFilterChain()

static MatfiltFilterChain GetFilterChain ( )
static

Get material filtering chain.

◆ GetInitialDirtyBitsMask()

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.

◆ GetMaterialNetwork()

HdMaterialNetwork2 const& GetMaterialNetwork ( ) const

Return the material network after filtering.

◆ GetShaderSourceTypes()

static TfTokenVector const& GetShaderSourceTypes ( )
static

Return the static list of tokens supported.

◆ GetUseSceneIndexForMatfilt()

static bool GetUseSceneIndexForMatfilt ( )
static

Returns whether it's possible and preferred to use scene indices in place of matfilt callbacks.

◆ IsValid()

bool IsValid ( ) const

Return true if this material is valid.

◆ SetFilterChain()

static void SetFilterChain ( MatfiltFilterChain const &  chain)
static

Set material filtering chain.

◆ Sync()

void Sync ( HdSceneDelegate sceneDelegate,
HdRenderParam renderParam,
HdDirtyBits *  dirtyBits 
)
overridevirtual

Synchronizes state from the delegate to this object.

Implements HdSprim.


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