All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdPrmanLight Class Referencefinal

A representation for lights. More...

+ Inheritance diagram for HdPrmanLight:

Public Member Functions

 HdPrmanLight (SdfPath const &id, TfToken const &lightType)
 
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...
 
bool IsValid () const
 Return true if this light is valid. More...
 
void Finalize (HdRenderParam *renderParam) override
 Finalizes object resources. 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 representation for lights.

Definition at line 40 of file light.h.

Member Function Documentation

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.

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.

bool IsValid ( ) const

Return true if this light is valid.

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: