@relu-interactives/spatial-ecs 0.5.3 → 0.9.0

package/dist/docs/api/index/classes/UIPanelSystem.md

@@ -0,0 +1,79 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UIPanelSystem
+
+# Class: UIPanelSystem
+
+Defined in: [systems/UIPanelSystem.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L70)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UIPanelSystem(options?): UIPanelSystem;
+```
+
+Defined in: [systems/UIPanelSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L74)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `createCanvas?`: () => [`UiCanvasLike`](../type-aliases/UiCanvasLike.md); \} |
+| `options.createCanvas?` | () => [`UiCanvasLike`](../type-aliases/UiCanvasLike.md) |
+
+#### Returns
+
+`UIPanelSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime?): void;
+```
+
+Defined in: [systems/UIPanelSystem.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L80)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `world` | [`World`](World.md) | `undefined` |
+| `deltaTime` | `number` | `0` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/UIPanelSystem.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L130)
+
+All GPU/canvas resources; call on world teardown.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

package/dist/docs/api/index/classes/VRTeleportAreaSystem.md

@@ -0,0 +1,49 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / VRTeleportAreaSystem
+
+# Class: VRTeleportAreaSystem
+
+Defined in: [systems/VRTeleportAreaSystem.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VRTeleportAreaSystem.ts#L38)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new VRTeleportAreaSystem(): VRTeleportAreaSystem;
+```
+
+#### Returns
+
+`VRTeleportAreaSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/VRTeleportAreaSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VRTeleportAreaSystem.ts#L41)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)

package/dist/docs/api/index/classes/VideoSystem.md

@@ -6,7 +6,7 @@
 
 # Class: VideoSystem
 
-Defined in: [systems/VideoSystem.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/VideoSystem.ts#L63)
+Defined in: [systems/VideoSystem.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L66)
 
 Reconciles `VideoComponent` state with the underlying HTML video element
 and THREE.js mesh/material each frame.
@@ -16,8 +16,10 @@ the HTML `<video>` element based on the `isPlaying` / `isPaused` flags set
 by `VideoComponent.play()`, `.pause()`, and `.stop()`.
 
 **Option sync** — detects changes to `loop`, `volume`, `width`, `height`,
-and green-screen shader uniforms (`backgroundColor`, `similarity`,
-`smoothness`, `spill`) and applies them live without a scene reload.
+and green-screen keying (`backgroundColor`, `similarity`, `smoothness`,
+`spill`) and applies them live without a scene reload. The keying material
+belongs to the world's render backend (GLSL on WebGL, TSL with
+`webgpuBackend`), which updates it.
 
 Only active in **preview** mode (`isEditor: true` makes every update a
 no-op so the editor is unaffected).
@@ -34,7 +36,7 @@ no-op so the editor is unaffected).
 new VideoSystem(__namedParameters?): VideoSystem;
 ```
 
-Defined in: [systems/VideoSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/VideoSystem.ts#L72)
+Defined in: [systems/VideoSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L75)
 
 #### Parameters
 
@@ -55,7 +57,7 @@ Defined in: [systems/VideoSystem.ts:72](https://github.com/Relu-Interactives/rel
 update(world, _deltaTime): void;
 ```
 
-Defined in: [systems/VideoSystem.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/VideoSystem.ts#L76)
+Defined in: [systems/VideoSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L79)
 
 #### Parameters
 
@@ -80,7 +82,7 @@ Defined in: [systems/VideoSystem.ts:76](https://github.com/Relu-Interactives/rel
 dispose(_world): void;
 ```
 
-Defined in: [systems/VideoSystem.ts:243](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/VideoSystem.ts#L243)
+Defined in: [systems/VideoSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L246)
 
 #### Parameters