Interface: IWSDKEnvironmentOptions
Defined in: packages/iwsdk-environment/src/index.ts:28
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
audio? | readonly | AudioDirectorOptions & IWSDKAudioPortOptions | Audio director + port options. Omit to set up the environment only. | - | packages/iwsdk-environment/src/index.ts:32 |
defaultTransition? | readonly | TransitionOptions | Used by transition when the call site gives no options. | EnvironmentDirectorOptions.defaultTransition | packages/webxr-environment/src/environment-director.ts:95 |
initial? | readonly | EnvironmentSpec | Applied at construction, over an empty environment. | EnvironmentDirectorOptions.initial | packages/webxr-environment/src/environment-director.ts:60 |
occludables? | readonly | () => Iterable<Entity> | Which entities the real world is allowed to hide, for scope: "all". IWSDK opts entities INTO occlusion one at a time, by patching the materials under each one, so somebody has to say which entities those are. It cannot be this port: the entities are content, content is the app's, and walking a scene graph looking for meshes would be this package guessing at the app's structure. With no list, scope: "all" reports unavailable and says why. An app that would rather tag its own entities uses scope: "tagged" and adds DepthOccludable itself; then this port only configures the system. | IWSDKEnvironmentPortOptions.occludables | packages/iwsdk-environment/src/environment-port.ts:84 |
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. | EnvironmentDirectorOptions.occlusionSuppresses | packages/webxr-environment/src/environment-director.ts:93 |
parent? | readonly | Entity | Where the light entities are parented. Defaults to the active level root, which is also where the dome lives, so the whole environment is torn down with the level. | IWSDKEnvironmentPortOptions.parent | packages/iwsdk-environment/src/environment-port.ts:68 |
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". | EnvironmentDirectorOptions.passthrough | packages/webxr-environment/src/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. | EnvironmentDirectorOptions.passthroughSuppresses | packages/webxr-environment/src/environment-director.ts:79 |
presets? | readonly | Readonly<Record<string, EnvironmentSpec>> | Named presets, available to apply and transition by name. | EnvironmentDirectorOptions.presets | packages/webxr-environment/src/environment-director.ts:62 |
skyIntensity? | readonly | number | Dome brightness multiplier, used when a sky does not name its own. Default 1. | IWSDKEnvironmentPortOptions.skyIntensity | packages/iwsdk-environment/src/environment-port.ts:70 |