LightFilter

Use filters to modulate the effects of a light. Light filters are associated with lights using the LightAPI light:filters relationship. See Representing Filters on Lights for more details on light filters.

Note that a LightFilter prim is considered a connectable prim for UsdShade networks, and should follow the rules for UsdShade node encapsulation. Additionally, a LightFilter is a connectable container and may have connectable children such as shaders that implement the filter. While the order of application of LightFilters is expressed via the LightAPI’s light:filters relationship, LightFilters may also be nested inside other LightFilters to indicate they only apply to that one LightFilter’s contribution in the filter-chain. While LightFilters can (and are encouraged to be) nested inside light prims (with LightAPI applied), they cannot be nested under unrelated connectable container prims like UsdShade Material.

Properties

collection:filterLink:includeRoot

USD type: bool

Fallback value: True

Use the filterLink collection to specify which geometry Prims to be included or excluded from this light filter. Prims excluded or not included will not be affected by this light filter.

The includeRoot attribute indicates whether the pseudo-root path / should be counted as one of the included target paths. Note that the fallback value is true, which means that light filters will affect all objects illuminated by the light(s) the filter is associated with.

See Collections and Patterns for more details on USD collections.

lightFilter:shaderId

USD type: token

Fallback value: ``

The shader ID for a LightFilter. The fallback value is no shader ID.

Inherited Properties (Xformable)

xformOpOrder

USD type: token[]

Inherited Properties (Imageable)

proxyPrim

USD type: rel (relationship)

purpose

USD type: token

Fallback value: default

visibility

USD type: token

Fallback value: inherited