% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT. % Generated: 11:28PM on April 14, 2025

(VolumeLightAPI)=

VolumeLightAPI

Use this schema to apply light behavior to a Volume prim. This schema is preferred over applying a LightAPI to a Volume, as VolumeLightAPI applies commonly needed built-in behavior, such as overriding the default light:materialSyncMode to "materialGlowTintsLight" to use the Volume's bound material, and defaults light:shaderId to "VolumeLight", to facilitate adding hooks for plugins to attach additional volume light properties.

{contents}

:depth: 2
:local:
:backlinks: none

(VolumeLightAPI_properties)=

Properties

(VolumeLightAPI_light:materialSyncMode)=

light:materialSyncMode

USD type: token

Fallback value: materialGlowTintsLight

(VolumeLightAPI_light:shaderId)=

light:shaderId

USD type: token

Fallback value: VolumeLight