Interface: EnvironmentDirectorOptions
Defined in: environment-director.ts:58
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
defaultTransition? | readonly | TransitionOptions | Used by transition when the call site gives no options. | environment-director.ts:95 |
initial? | readonly | EnvironmentSpec | Applied at construction, over an empty environment. | environment-director.ts:60 |
occlusionSuppresses? | readonly | readonly ("sky" | "fog" | "ambient" | "key" | "ibl")[] | Which slots to hide while depth occlusion is ACTIVE. Default ["sky"]. This is not belt and braces on top of passthrough. three.js's built-in depth sensing stops the renderer drawing scene.background at all while it is running, so on that engine the sky is already gone whatever this package believes. Suppressing it here means applied still describes what is on screen, which is the one promise the director makes. In the default configuration passthrough has already hidden the sky and this changes nothing; it matters only for an app that deliberately kept the sky. | environment-director.ts:93 |
passthrough? | readonly | | boolean | EnvironmentBlendMode | Start in passthrough. A blend mode counts as passthrough unless it is "opaque", which is how the platform layer reports "no real world here". | environment-director.ts:67 |
passthroughSuppresses? | readonly | | readonly ("sky" | "fog" | "ambient" | "key" | "ibl")[] | Partial<Record<EnvironmentBlendMode, readonly ("sky" | "fog" | "ambient" | "key" | "ibl")[]>> | Which slots passthrough hides. Default ["sky", "fog"] - the two that would paint over the real world. Lighting stays, because an AR scene still needs its virtual content lit. Pass a record instead of a list to differ per blend mode. That exists because the modes are not variations of each other: on additive the rendered image is ADDED to the world, so a dark fog is invisible rather than dimming, and an app may want to keep fog on alpha-blend and drop it on additive instead of choosing one compromise for both. | environment-director.ts:79 |
presets? | readonly | Readonly<Record<string, EnvironmentSpec>> | Named presets, available to apply and transition by name. | environment-director.ts:62 |