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

(MeshLightAPI)=

MeshLightAPI

Use this schema to apply light behavior to a Mesh prim. This schema is preferred over applying a LightAPI to a Mesh, as MeshLightAPI applies commonly needed built-in behavior, such as overriding the default light:materialSyncMode to "materialGlowTintsLight" to use the Mesh's bound material, and defaults light:shaderId to "MeshLight", to facilitate adding hooks for plugins to attach additional mesh light properties. See {ref}usdLux_mesh_lights for more details and example of mesh lights.

{contents}

:depth: 2
:local:
:backlinks: none

(MeshLightAPI_properties)=

Properties

(MeshLightAPI_light:materialSyncMode)=

light:materialSyncMode

USD type: token

Fallback value: materialGlowTintsLight

(MeshLightAPI_light:shaderId)=

light:shaderId

USD type: token

Fallback value: MeshLight