HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdLight Class Reference

#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)
 
HD_API ~HdLight () override
 
const SdfPathGetInstancerId () const
 
HD_API void _UpdateInstancer (HdSceneDelegate *sceneDelegate, HdDirtyBits *dirtyBits)
 
- Public Member Functions inherited from HdSprim
HD_API HdSprim (SdfPath const &id)
 
virtual HD_API ~HdSprim ()
 
SdfPath constGetId () const
 
virtual void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 
virtual HdDirtyBits GetInitialDirtyBitsMask () const =0
 

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 82 of file light.h.

Member Enumeration Documentation

Enumerator
Clean 
DirtyTransform 
DirtyParams 
DirtyShadowParams 
DirtyCollection 
DirtyResource 
DirtyInstancer 
AllDirty 

Definition at line 91 of file light.h.

Constructor & Destructor Documentation

HD_API HdLight::HdLight ( SdfPath const id)
HD_API HdLight::~HdLight ( )
override

Member Function Documentation

HD_API void HdLight::_UpdateInstancer ( HdSceneDelegate sceneDelegate,
HdDirtyBits dirtyBits 
)
const SdfPath& HdLight::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 115 of file light.h.

static HD_API std::string HdLight::StringifyDirtyBits ( HdDirtyBits  dirtyBits)
static

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