This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
HdLight Class Reference

A light model, used in conjunction with HdRenderPass. More...

#include <light.h>

+ Inheritance diagram for HdLight:

Public Types

enum  DirtyBits : HdDirtyBits {
  Clean = 0 , DirtyTransform = 1 << 0 , DirtyParams = 1 << 1 , DirtyShadowParams = 1 << 2 ,
  DirtyCollection = 1 << 3 , DirtyResource = 1 << 4 , DirtyInstancer = 1 << 16 , AllDirty
}
 

Public Member Functions

HD_API HdLight (SdfPath const &id)
 
const SdfPathGetInstancerId () const
 Returns the identifier of the instancer (if any) for this Sprim.
 
HD_API void _UpdateInstancer (HdSceneDelegate *sceneDelegate, HdDirtyBits *dirtyBits)
 
- 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.
 

Static Public Member Functions

static HD_API std::string StringifyDirtyBits (HdDirtyBits dirtyBits)
 

Detailed Description

A light model, used in conjunction with HdRenderPass.

Definition at line 66 of file light.h.

Member Enumeration Documentation

◆ DirtyBits

enum DirtyBits : HdDirtyBits

Definition at line 75 of file light.h.

Member Function Documentation

◆ GetInstancerId()

const SdfPath & GetInstancerId ( ) const
inline

Returns the identifier of the instancer (if any) for this Sprim.

If this Sprim is not instanced, an empty SdfPath will be returned.

Definition at line 101 of file light.h.


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