Skip to content
YAGE Logo YAGE

LightingConfig

Defined in: lighting/src/types.ts:114

Plugin configuration shared by every scene.

Properties

Section titled “Properties”

ambient?

Section titled “ambient?”

optional ambient?: AmbientLightOptions

Defined in: lighting/src/types.ts:116

Ambient light configuration.

bounce?

Section titled “bounce?”

optional bounce?: BounceLightOptions

Defined in: lighting/src/types.ts:132

Bounced light for every scene that sets none of its own through Scene.lighting. Default off.

defaultRenderer?

Section titled “defaultRenderer?”

optional defaultRenderer?: string

Defined in: lighting/src/types.ts:127

Which entry of renderers draws a scene that names none. Default "overlay", and it must be a key of renderers.

renderers?

Section titled “renderers?”

optional renderers?: Readonly<Record<string, LightingRendererFactory | null>>

Defined in: lighting/src/types.ts:122

The renderers scenes pick from by name, through Scene.lighting. Omit for { overlay: overlayLighting() }. A null entry gives light-level queries without visual output.

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/lighting.md.