HdStLight Class Referencefinal

A light model for use in Storm. More...

+ Inheritance diagram for HdStLight:

Public Member Functions

HDST_API HdStLight (SdfPath const &id, TfToken const &lightType)
 
HDST_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Synchronizes state from the delegate to this object. More...
 
HDST_API void Finalize (HdRenderParam *renderParam) override
 Finalizes object resources. More...
 
HDST_API VtValue Get (TfToken const &token) const
 Accessor for tasks to get the parameters cached in this object. More...
 
HDST_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. More...
 
- Public Member Functions inherited from HdLight
HD_API HdLight (SdfPath const &id)
 
- 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...
 

Additional Inherited Members

- Public Types inherited from HdLight
enum  DirtyBits : HdDirtyBits {
  Clean = 0, DirtyTransform = 1 << 0, DirtyParams = 1 << 1, DirtyShadowParams = 1 << 2,
  DirtyCollection = 1 << 3, DirtyResource = 1 << 4, AllDirty
}
 

Detailed Description

A light model for use in Storm.

Note: This class simply stores the light parameters and relies on an external task (HdxSimpleLightTask) to upload them to the GPU.

Definition at line 44 of file light.h.

Member Function Documentation

◆ Finalize()

HDST_API 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.

◆ Get()

HDST_API VtValue Get ( TfToken const &  token) const

Accessor for tasks to get the parameters cached in this object.

◆ GetInitialDirtyBitsMask()

HDST_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()

HDST_API 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: