@relu-interactives/spatial-ecs 0.2.3 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/dist/{System-BTyYvKVH.d.cts → System-CIiWteft.d.cts} +2 -2
  2. package/dist/{System-BTyYvKVH.d.ts → System-CIiWteft.d.ts} +2 -2
  3. package/dist/{Video-D2H5H-K3.d.cts → Video-ChVFs9Tl.d.cts} +139 -75
  4. package/dist/{Video-BWhbvVPg.d.ts → Video-DCMCLInA.d.ts} +139 -75
  5. package/dist/{chunk-XWIEEJ7Z.js → chunk-4A66FSFT.js} +128 -82
  6. package/dist/chunk-4A66FSFT.js.map +1 -0
  7. package/dist/{chunk-AYEF3X2P.js → chunk-CRP3W2GK.js} +3 -3
  8. package/dist/chunk-CRP3W2GK.js.map +1 -0
  9. package/dist/{chunk-MAWBTMCG.js → chunk-KRZLEPRI.js} +156 -88
  10. package/dist/chunk-KRZLEPRI.js.map +1 -0
  11. package/dist/{chunk-NFDTIYR4.js → chunk-NB6I5JJN.js} +17 -2
  12. package/dist/chunk-NB6I5JJN.js.map +1 -0
  13. package/dist/{chunk-P2YDX5DB.js → chunk-RXCUHGRB.js} +124 -5
  14. package/dist/chunk-RXCUHGRB.js.map +1 -0
  15. package/dist/components/index.cjs +161 -93
  16. package/dist/components/index.cjs.map +1 -1
  17. package/dist/components/index.d.cts +2 -2
  18. package/dist/components/index.d.ts +2 -2
  19. package/dist/components/index.js +1 -1
  20. package/dist/docs/api/Behaviour/classes/Behaviour.md +29 -29
  21. package/dist/docs/api/Component/classes/Component.md +1 -1
  22. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  23. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  24. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  25. package/dist/docs/api/components/classes/EntityType.md +3 -3
  26. package/dist/docs/api/components/classes/Environment.md +3 -3
  27. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  28. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  29. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  30. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  31. package/dist/docs/api/components/classes/MaterialComponent.md +11 -11
  32. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  33. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  34. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  35. package/dist/docs/api/components/classes/Name.md +3 -3
  36. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  37. package/dist/docs/api/components/classes/ParentId.md +3 -3
  38. package/dist/docs/api/components/classes/PhysicsComponent.md +6 -6
  39. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  40. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  41. package/dist/docs/api/components/classes/Selectable.md +3 -3
  42. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  43. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  44. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  45. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  46. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  47. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
  48. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
  49. package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
  50. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
  51. package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
  52. package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
  53. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
  54. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
  55. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
  56. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
  57. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
  58. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
  59. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
  60. package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
  61. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
  62. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
  63. package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
  64. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  65. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  66. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  67. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  68. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  69. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  70. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  71. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  72. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  73. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  74. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  75. package/dist/docs/api/components/type-aliases/ScriptEntry.md +9 -9
  76. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  77. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  78. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  79. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  80. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  81. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  82. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  83. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  84. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  85. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  86. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  87. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  88. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  89. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  90. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  91. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  92. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  93. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  94. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  95. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  96. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  97. package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
  98. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  99. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  100. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  101. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  102. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  103. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  104. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  105. package/dist/docs/api/index/classes/World.md +95 -81
  106. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  107. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  108. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  109. package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
  110. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  111. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  112. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  113. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  114. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  115. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  116. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  117. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  118. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  119. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  120. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  121. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  122. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  123. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  124. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  125. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  126. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  127. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  128. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  129. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  130. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  131. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  132. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  133. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  134. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  135. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  136. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  137. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  138. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +1 -1
  139. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  140. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  141. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +3 -3
  142. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  143. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  144. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  145. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  146. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  147. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  148. package/dist/docs/api/types/type-aliases/CheckboxInput.md +1 -1
  149. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  150. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  151. package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
  152. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  153. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  154. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  155. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
  156. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  157. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  158. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  159. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  160. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  161. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  162. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  163. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  164. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  165. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  166. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  167. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  168. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  169. package/dist/docs/guide/spawning/ambient-light.md +2 -2
  170. package/dist/docs/guide/spawning/area-light.md +2 -2
  171. package/dist/docs/guide/spawning/audio.md +27 -16
  172. package/dist/docs/guide/spawning/camera.md +2 -2
  173. package/dist/docs/guide/spawning/capsule.md +2 -2
  174. package/dist/docs/guide/spawning/cube.md +2 -2
  175. package/dist/docs/guide/spawning/cylinder.md +2 -2
  176. package/dist/docs/guide/spawning/directional-light.md +2 -2
  177. package/dist/docs/guide/spawning/empty.md +2 -2
  178. package/dist/docs/guide/spawning/image-target.md +2 -2
  179. package/dist/docs/guide/spawning/image.md +2 -2
  180. package/dist/docs/guide/spawning/index.md +2 -2
  181. package/dist/docs/guide/spawning/model.md +2 -2
  182. package/dist/docs/guide/spawning/plane.md +2 -2
  183. package/dist/docs/guide/spawning/point-light.md +2 -2
  184. package/dist/docs/guide/spawning/sphere.md +2 -2
  185. package/dist/docs/guide/spawning/spot-light.md +2 -2
  186. package/dist/docs/guide/spawning/sprite.md +2 -2
  187. package/dist/docs/guide/spawning/video.md +2 -2
  188. package/dist/docs/guide/world-api.md +3 -5
  189. package/dist/factories/index.cjs +217 -105
  190. package/dist/factories/index.cjs.map +1 -1
  191. package/dist/factories/index.d.cts +9 -3
  192. package/dist/factories/index.d.ts +9 -3
  193. package/dist/factories/index.js +3 -3
  194. package/dist/{index-KdEzEZox.d.cts → index-D1I5L7bA.d.cts} +8 -3
  195. package/dist/{index-Dm6zF1MY.d.ts → index-DGZDgt3p.d.ts} +8 -3
  196. package/dist/index.cjs +468 -179
  197. package/dist/index.cjs.map +1 -1
  198. package/dist/index.d.cts +7 -7
  199. package/dist/index.d.ts +7 -7
  200. package/dist/index.js +51 -12
  201. package/dist/index.js.map +1 -1
  202. package/dist/systems/index.cjs +248 -63
  203. package/dist/systems/index.cjs.map +1 -1
  204. package/dist/systems/index.d.cts +15 -3
  205. package/dist/systems/index.d.ts +15 -3
  206. package/dist/systems/index.js +3 -3
  207. package/dist/types.d.cts +1 -1
  208. package/dist/types.d.ts +1 -1
  209. package/dist/worldSnapshotUtils.cjs +15 -0
  210. package/dist/worldSnapshotUtils.cjs.map +1 -1
  211. package/dist/worldSnapshotUtils.d.cts +1 -1
  212. package/dist/worldSnapshotUtils.d.ts +1 -1
  213. package/dist/worldSnapshotUtils.js +1 -1
  214. package/package.json +1 -1
  215. package/dist/chunk-AYEF3X2P.js.map +0 -1
  216. package/dist/chunk-MAWBTMCG.js.map +0 -1
  217. package/dist/chunk-NFDTIYR4.js.map +0 -1
  218. package/dist/chunk-P2YDX5DB.js.map +0 -1
  219. package/dist/chunk-XWIEEJ7Z.js.map +0 -1
package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md CHANGED
@@ -18,7 +18,7 @@ type EnvironmentSkyboxState = {
18
18
  };
19
19
  ```
20
20
 
21
- Defined in: [components/Environment.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L11)
21
+ Defined in: [components/Environment.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L11)
22
22
 
23
23
  Skybox configuration. Only the fields relevant to [type](#type) are read at render time.
24
24
 
@@ -26,9 +26,9 @@ Skybox configuration. Only the fields relevant to [type](#type) are read at rend
26
26
 
27
27
  | Property | Type | Description | Defined in |
28
28
  | ------ | ------ | ------ | ------ |
29
- | <a id="type"></a> `type` | [`EnvironmentSkyboxType`](EnvironmentSkyboxType.md) | Active skybox mode. | [components/Environment.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L13) |
30
- | <a id="color"></a> `color` | `string` | Solid color used when [type](#type) is `"color"`. `#rrggbb`. | [components/Environment.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L15) |
31
- | <a id="imageurl"></a> `imageUrl?` | `string` | URL or `localasset://` path of the equirectangular image used when [type](#type) is `"image"`. | [components/Environment.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L17) |
32
- | <a id="gradient"></a> `gradient` | \{ `colors`: `string`[]; `effect`: [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md); \} | Gradient parameters used when [type](#type) is `"gradient"`. | [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L19) |
33
- | `gradient.colors` | `string`[] | Ordered list of color stops as `#rrggbb` strings. | [components/Environment.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L21) |
34
- | `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L23) |
29
+ | <a id="type"></a> `type` | [`EnvironmentSkyboxType`](EnvironmentSkyboxType.md) | Active skybox mode. | [components/Environment.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L13) |
30
+ | <a id="color"></a> `color` | `string` | Solid color used when [type](#type) is `"color"`. `#rrggbb`. | [components/Environment.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L15) |
31
+ | <a id="imageurl"></a> `imageUrl?` | `string` | URL or `localasset://` path of the equirectangular image used when [type](#type) is `"image"`. | [components/Environment.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L17) |
32
+ | <a id="gradient"></a> `gradient` | \{ `colors`: `string`[]; `effect`: [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md); \} | Gradient parameters used when [type](#type) is `"gradient"`. | [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L19) |
33
+ | `gradient.colors` | `string`[] | Ordered list of color stops as `#rrggbb` strings. | [components/Environment.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L21) |
34
+ | `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L23) |
package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md CHANGED
@@ -10,6 +10,6 @@
10
10
  type EnvironmentSkyboxType = "gradient" | "color" | "image" | "none";
11
11
  ```
12
12
 
13
- Defined in: [components/Environment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L4)
13
+ Defined in: [components/Environment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L4)
14
14
 
15
15
  Skybox rendering modes. `none` disables skybox rendering entirely.
package/dist/docs/api/components/type-aliases/EnvironmentState.md CHANGED
@@ -15,7 +15,7 @@ type EnvironmentState = {
15
15
  };
16
16
  ```
17
17
 
18
- Defined in: [components/Environment.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L58)
18
+ Defined in: [components/Environment.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L58)
19
19
 
20
20
  Aggregated authoring state owned by [Environment](../classes/Environment.md).
21
21
 
@@ -23,7 +23,7 @@ Aggregated authoring state owned by [Environment](../classes/Environment.md).
23
23
 
24
24
  | Property | Type | Description | Defined in |
25
25
  | ------ | ------ | ------ | ------ |
26
- | <a id="skybox"></a> `skybox` | [`EnvironmentSkyboxState`](EnvironmentSkyboxState.md) | Skybox configuration. | [components/Environment.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L60) |
27
- | <a id="fog"></a> `fog` | [`EnvironmentFogState`](EnvironmentFogState.md) | Fog configuration. | [components/Environment.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L62) |
28
- | <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L64) |
29
- | <a id="fixedtimestep"></a> `fixedTimeStep` | `number` | Fixed timestep (seconds) used by the physics accumulator loop. Physics is stepped in fixed increments of this size each frame. Default is `0.02` (50 Hz). | [components/Environment.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L70) |
26
+ | <a id="skybox"></a> `skybox` | [`EnvironmentSkyboxState`](EnvironmentSkyboxState.md) | Skybox configuration. | [components/Environment.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L60) |
27
+ | <a id="fog"></a> `fog` | [`EnvironmentFogState`](EnvironmentFogState.md) | Fog configuration. | [components/Environment.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L62) |
28
+ | <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L64) |
29
+ | <a id="fixedtimestep"></a> `fixedTimeStep` | `number` | Fixed timestep (seconds) used by the physics accumulator loop. Physics is stepped in fixed increments of this size each frame. Default is `0.02` (50 Hz). | [components/Environment.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L70) |
package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md CHANGED
@@ -13,7 +13,7 @@ type ImageTargetAnchorOptions = {
13
13
  };
14
14
  ```
15
15
 
16
- Defined in: [components/ImageTargetAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L4)
16
+ Defined in: [components/ImageTargetAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L4)
17
17
 
18
18
  Optional initializer for [ImageTargetAnchor](../classes/ImageTargetAnchor.md).
19
19
 
@@ -21,5 +21,5 @@ Optional initializer for [ImageTargetAnchor](../classes/ImageTargetAnchor.md).
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ------ | ------ | ------ | ------ |
24
- | <a id="targetid"></a> `targetId?` | `number` \| `null` | Id of the tracked target this anchor follows (matches `ImageTargetReference.id`). | [components/ImageTargetAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L6) |
25
- | <a id="targeturl"></a> `targetUrl?` | `string` | Optional canonical URL of the target image, used as a fallback identifier. | [components/ImageTargetAnchor.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L8) |
24
+ | <a id="targetid"></a> `targetId?` | `number` \| `null` | Id of the tracked target this anchor follows (matches `ImageTargetReference.id`). | [components/ImageTargetAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L6) |
25
+ | <a id="targeturl"></a> `targetUrl?` | `string` | Optional canonical URL of the target image, used as a fallback identifier. | [components/ImageTargetAnchor.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L8) |
package/dist/docs/api/components/type-aliases/ImageTargetReference.md CHANGED
@@ -17,7 +17,7 @@ type ImageTargetReference = {
17
17
  };
18
18
  ```
19
19
 
20
- Defined in: [components/ImageTarget.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L6)
20
+ Defined in: [components/ImageTarget.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L6)
21
21
 
22
22
  Single uploaded image used as input to the image-target compiler.
23
23
 
@@ -25,9 +25,9 @@ Single uploaded image used as input to the image-target compiler.
25
25
 
26
26
  | Property | Type | Description | Defined in |
27
27
  | ------ | ------ | ------ | ------ |
28
- | <a id="id"></a> `id` | `number` | Stable target id assigned at compile time. Referenced by [ImageTargetAnchor.targetId](../classes/ImageTargetAnchor.md#targetid). | [components/ImageTarget.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L8) |
29
- | <a id="url"></a> `url` | `string` | Source image URL or `localasset://` path. | [components/ImageTarget.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L10) |
30
- | <a id="width"></a> `width` | `number` | Image width in pixels. | [components/ImageTarget.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L12) |
31
- | <a id="height"></a> `height` | `number` | Image height in pixels. | [components/ImageTarget.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L14) |
32
- | <a id="storagedir"></a> `storageDir?` | `string` | Local directory the source image is stored in (desktop projects). | [components/ImageTarget.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L16) |
33
- | <a id="filename"></a> `fileName?` | `string` | Local file name for the source image (desktop projects). | [components/ImageTarget.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L18) |
28
+ | <a id="id"></a> `id` | `number` | Stable target id assigned at compile time. Referenced by [ImageTargetAnchor.targetId](../classes/ImageTargetAnchor.md#targetid). | [components/ImageTarget.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L8) |
29
+ | <a id="url"></a> `url` | `string` | Source image URL or `localasset://` path. | [components/ImageTarget.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L10) |
30
+ | <a id="width"></a> `width` | `number` | Image width in pixels. | [components/ImageTarget.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L12) |
31
+ | <a id="height"></a> `height` | `number` | Image height in pixels. | [components/ImageTarget.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L14) |
32
+ | <a id="storagedir"></a> `storageDir?` | `string` | Local directory the source image is stored in (desktop projects). | [components/ImageTarget.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L16) |
33
+ | <a id="filename"></a> `fileName?` | `string` | Local file name for the source image (desktop projects). | [components/ImageTarget.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L18) |
package/dist/docs/api/components/type-aliases/LightValueState.md CHANGED
@@ -21,7 +21,7 @@ type LightValueState = {
21
21
  };
22
22
  ```
23
23
 
24
- Defined in: [components/Light.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L6)
24
+ Defined in: [components/Light.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L6)
25
25
 
26
26
  Authoring state for [LightComponent](../classes/LightComponent.md). Common fields apply to every light kind; the optional fields are only meaningful for specific kinds.
27
27
 
@@ -29,13 +29,13 @@ Authoring state for [LightComponent](../classes/LightComponent.md). Common field
29
29
 
30
30
  | Property | Type | Description | Defined in |
31
31
  | ------ | ------ | ------ | ------ |
32
- | <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L8) |
33
- | <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L10) |
34
- | <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L12) |
35
- | <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L14) |
36
- | <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L16) |
37
- | <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L18) |
38
- | <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L20) |
39
- | <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L22) |
40
- | <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L24) |
41
- | <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L26) |
32
+ | <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L8) |
33
+ | <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L10) |
34
+ | <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L12) |
35
+ | <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L14) |
36
+ | <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L16) |
37
+ | <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L18) |
38
+ | <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L20) |
39
+ | <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L22) |
40
+ | <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L24) |
41
+ | <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L26) |
package/dist/docs/api/components/type-aliases/MaterialTypeValue.md CHANGED
@@ -10,6 +10,6 @@
10
10
  type MaterialTypeValue = "standard" | "basic" | "phong" | "physical";
11
11
  ```
12
12
 
13
- Defined in: [components/Material.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L6)
13
+ Defined in: [components/Material.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L6)
14
14
 
15
15
  Supported material classes. Each maps to a three.js `Mesh*Material` type.
package/dist/docs/api/components/type-aliases/MaterialValueState.md CHANGED
@@ -38,7 +38,7 @@ type MaterialValueState = {
38
38
  };
39
39
  ```
40
40
 
41
- Defined in: [components/Material.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L11)
41
+ Defined in: [components/Material.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L11)
42
42
 
43
43
  Authoring state for a single slot in [MaterialComponent.values](../classes/MaterialComponent.md#values). Mirrors the live three.js material so it can be re-applied when the project loads.
44
44
 
@@ -46,30 +46,30 @@ Authoring state for a single slot in [MaterialComponent.values](../classes/Mater
46
46
 
47
47
  | Property | Type | Description | Defined in |
48
48
  | ------ | ------ | ------ | ------ |
49
- | <a id="type"></a> `type` | [`MaterialTypeValue`](MaterialTypeValue.md) | Underlying material class. | [components/Material.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L13) |
50
- | <a id="color"></a> `color` | `string` | Base color as `#rrggbb` hex string. | [components/Material.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L15) |
51
- | <a id="roughness"></a> `roughness` | `number` | PBR roughness in `[0, 1]`. | [components/Material.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L17) |
52
- | <a id="metalness"></a> `metalness` | `number` | PBR metalness in `[0, 1]`. | [components/Material.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L19) |
53
- | <a id="normalscale"></a> `normalScale` | `number` | Multiplier applied to the normal map (uniform on both axes). | [components/Material.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L21) |
54
- | <a id="opacity"></a> `opacity` | `number` | Surface opacity in `[0, 1]`. Combine with [transparent](#transparent) to enable alpha. | [components/Material.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L23) |
55
- | <a id="emissive"></a> `emissive` | `string` | Emissive color as `#rrggbb` hex string. | [components/Material.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L25) |
56
- | <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | Emissive intensity multiplier. | [components/Material.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L27) |
57
- | <a id="side"></a> `side` | `number` | Three.js `Side` enum value (`FrontSide`, `BackSide`, or `DoubleSide`). | [components/Material.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L29) |
58
- | <a id="blending"></a> `blending` | `number` | Three.js `Blending` enum value. | [components/Material.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L31) |
59
- | <a id="depthtest"></a> `depthTest` | `boolean` | Whether depth testing is enabled. | [components/Material.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L33) |
60
- | <a id="depthwrite"></a> `depthWrite` | `boolean` | Whether depth writes are enabled. | [components/Material.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L35) |
61
- | <a id="wireframe"></a> `wireframe` | `boolean` | Render as wireframe. | [components/Material.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L37) |
62
- | <a id="transparent"></a> `transparent` | `boolean` | Enable transparency (must be `true` for [opacity](#opacity) < 1 to render correctly). | [components/Material.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L39) |
63
- | <a id="texturemap"></a> `textureMap?` | `string` | Color/diffuse texture URL. | [components/Material.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L41) |
64
- | <a id="alphatexturemap"></a> `alphaTextureMap?` | `string` | Alpha (transparency) texture URL. | [components/Material.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L43) |
65
- | <a id="normalmap"></a> `normalMap?` | `string` | Tangent-space normal map URL. | [components/Material.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L45) |
66
- | <a id="roughnessmap"></a> `roughnessMap?` | `string` | Roughness map URL (red channel). | [components/Material.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L47) |
67
- | <a id="metalnessmap"></a> `metalnessMap?` | `string` | Metalness map URL (red channel). | [components/Material.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L49) |
68
- | <a id="aomap"></a> `aoMap?` | `string` | Ambient occlusion map URL. | [components/Material.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L51) |
69
- | <a id="emissivemap"></a> `emissiveMap?` | `string` | Emissive color map URL. | [components/Material.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L53) |
70
- | <a id="bumpmap"></a> `bumpMap?` | `string` | Bump map URL (height-based shading approximation). | [components/Material.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L55) |
71
- | <a id="displacementmap"></a> `displacementMap?` | `string` | Displacement map URL (geometric vertex offset). | [components/Material.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L57) |
72
- | <a id="lightmap"></a> `lightMap?` | `string` | Pre-baked light map URL. | [components/Material.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L59) |
73
- | <a id="envmap"></a> `envMap?` | `string` | Environment reflection map URL. | [components/Material.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L61) |
74
- | <a id="texturefiltering"></a> `textureFiltering` | [`TextureFilteringValue`](TextureFilteringValue.md) | Texture sampling mode applied to the color map. | [components/Material.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L63) |
75
- | <a id="usemipmaps"></a> `useMipmaps` | `boolean` | Whether mipmaps are generated for texture maps. | [components/Material.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L65) |
49
+ | <a id="type"></a> `type` | [`MaterialTypeValue`](MaterialTypeValue.md) | Underlying material class. | [components/Material.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L13) |
50
+ | <a id="color"></a> `color` | `string` | Base color as `#rrggbb` hex string. | [components/Material.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L15) |
51
+ | <a id="roughness"></a> `roughness` | `number` | PBR roughness in `[0, 1]`. | [components/Material.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L17) |
52
+ | <a id="metalness"></a> `metalness` | `number` | PBR metalness in `[0, 1]`. | [components/Material.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L19) |
53
+ | <a id="normalscale"></a> `normalScale` | `number` | Multiplier applied to the normal map (uniform on both axes). | [components/Material.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L21) |
54
+ | <a id="opacity"></a> `opacity` | `number` | Surface opacity in `[0, 1]`. Combine with [transparent](#transparent) to enable alpha. | [components/Material.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L23) |
55
+ | <a id="emissive"></a> `emissive` | `string` | Emissive color as `#rrggbb` hex string. | [components/Material.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L25) |
56
+ | <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | Emissive intensity multiplier. | [components/Material.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L27) |
57
+ | <a id="side"></a> `side` | `number` | Three.js `Side` enum value (`FrontSide`, `BackSide`, or `DoubleSide`). | [components/Material.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L29) |
58
+ | <a id="blending"></a> `blending` | `number` | Three.js `Blending` enum value. | [components/Material.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L31) |
59
+ | <a id="depthtest"></a> `depthTest` | `boolean` | Whether depth testing is enabled. | [components/Material.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L33) |
60
+ | <a id="depthwrite"></a> `depthWrite` | `boolean` | Whether depth writes are enabled. | [components/Material.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L35) |
61
+ | <a id="wireframe"></a> `wireframe` | `boolean` | Render as wireframe. | [components/Material.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L37) |
62
+ | <a id="transparent"></a> `transparent` | `boolean` | Enable transparency (must be `true` for [opacity](#opacity) < 1 to render correctly). | [components/Material.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L39) |
63
+ | <a id="texturemap"></a> `textureMap?` | `string` | Color/diffuse texture URL. | [components/Material.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L41) |
64
+ | <a id="alphatexturemap"></a> `alphaTextureMap?` | `string` | Alpha (transparency) texture URL. | [components/Material.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L43) |
65
+ | <a id="normalmap"></a> `normalMap?` | `string` | Tangent-space normal map URL. | [components/Material.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L45) |
66
+ | <a id="roughnessmap"></a> `roughnessMap?` | `string` | Roughness map URL (red channel). | [components/Material.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L47) |
67
+ | <a id="metalnessmap"></a> `metalnessMap?` | `string` | Metalness map URL (red channel). | [components/Material.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L49) |
68
+ | <a id="aomap"></a> `aoMap?` | `string` | Ambient occlusion map URL. | [components/Material.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L51) |
69
+ | <a id="emissivemap"></a> `emissiveMap?` | `string` | Emissive color map URL. | [components/Material.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L53) |
70
+ | <a id="bumpmap"></a> `bumpMap?` | `string` | Bump map URL (height-based shading approximation). | [components/Material.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L55) |
71
+ | <a id="displacementmap"></a> `displacementMap?` | `string` | Displacement map URL (geometric vertex offset). | [components/Material.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L57) |
72
+ | <a id="lightmap"></a> `lightMap?` | `string` | Pre-baked light map URL. | [components/Material.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L59) |
73
+ | <a id="envmap"></a> `envMap?` | `string` | Environment reflection map URL. | [components/Material.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L61) |
74
+ | <a id="texturefiltering"></a> `textureFiltering` | [`TextureFilteringValue`](TextureFilteringValue.md) | Texture sampling mode applied to the color map. | [components/Material.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L63) |
75
+ | <a id="usemipmaps"></a> `useMipmaps` | `boolean` | Whether mipmaps are generated for texture maps. | [components/Material.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L65) |
package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md CHANGED
@@ -10,4 +10,4 @@
10
10
  type MeshGeometryParameters = MeshGeometryParametersByKind[EditableMeshObjectKind];
11
11
  ```
12
12
 
13
- Defined in: [components/MeshGeometry.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L59)
13
+ Defined in: [components/MeshGeometry.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L59)
package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md CHANGED
@@ -17,7 +17,7 @@ type MeshGeometryParametersByKind = {
17
17
  };
18
18
  ```
19
19
 
20
- Defined in: [components/MeshGeometry.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L50)
20
+ Defined in: [components/MeshGeometry.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L50)
21
21
 
22
22
  Map from [EditableMeshObjectKind](EditableMeshObjectKind.md) to its parameter shape.
23
23
 
@@ -25,9 +25,9 @@ Map from [EditableMeshObjectKind](EditableMeshObjectKind.md) to its parameter sh
25
25
 
26
26
  | Property | Type | Defined in |
27
27
  | ------ | ------ | ------ |
28
- | <a id="capsule"></a> `capsule` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L51) |
29
- | <a id="cube"></a> `cube` | [`CubeMeshParameters`](CubeMeshParameters.md) | [components/MeshGeometry.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L52) |
30
- | <a id="cylinder"></a> `cylinder` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L53) |
31
- | <a id="model"></a> `model` | `ModelMeshParameters` | [components/MeshGeometry.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L54) |
32
- | <a id="plane"></a> `plane` | [`PlaneMeshParameters`](PlaneMeshParameters.md) | [components/MeshGeometry.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L55) |
33
- | <a id="sphere"></a> `sphere` | [`RadiusMeshParameters`](RadiusMeshParameters.md) | [components/MeshGeometry.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L56) |
28
+ | <a id="capsule"></a> `capsule` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L51) |
29
+ | <a id="cube"></a> `cube` | [`CubeMeshParameters`](CubeMeshParameters.md) | [components/MeshGeometry.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L52) |
30
+ | <a id="cylinder"></a> `cylinder` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L53) |
31
+ | <a id="model"></a> `model` | `ModelMeshParameters` | [components/MeshGeometry.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L54) |
32
+ | <a id="plane"></a> `plane` | [`PlaneMeshParameters`](PlaneMeshParameters.md) | [components/MeshGeometry.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L55) |
33
+ | <a id="sphere"></a> `sphere` | [`RadiusMeshParameters`](RadiusMeshParameters.md) | [components/MeshGeometry.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L56) |
package/dist/docs/api/components/type-aliases/PhysicsState.md CHANGED
@@ -13,7 +13,7 @@ type PhysicsState = {
13
13
  };
14
14
  ```
15
15
 
16
- Defined in: [components/Physics.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L165)
16
+ Defined in: [components/Physics.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L165)
17
17
 
18
18
  Combined authoring state for [PhysicsComponent](../classes/PhysicsComponent.md). Saved with the project.
19
19
 
@@ -21,5 +21,5 @@ Combined authoring state for [PhysicsComponent](../classes/PhysicsComponent.md).
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ------ | ------ | ------ | ------ |
24
- | <a id="rigidbody"></a> `rigidbody` | [`RigidbodyState`](RigidbodyState.md) | Rigid body settings. | [components/Physics.ts:167](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L167) |
25
- | <a id="collider"></a> `collider` | [`ColliderState`](ColliderState.md) | Collider settings. | [components/Physics.ts:169](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L169) |
24
+ | <a id="rigidbody"></a> `rigidbody` | [`RigidbodyState`](RigidbodyState.md) | Rigid body settings. | [components/Physics.ts:167](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L167) |
25
+ | <a id="collider"></a> `collider` | [`ColliderState`](ColliderState.md) | Collider settings. | [components/Physics.ts:169](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L169) |
package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md CHANGED
@@ -13,7 +13,7 @@ type PlaneMeshParameters = {
13
13
  };
14
14
  ```
15
15
 
16
- Defined in: [components/MeshGeometry.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L25)
16
+ Defined in: [components/MeshGeometry.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L25)
17
17
 
18
18
  Plane geometry parameters in world units.
19
19
 
@@ -21,5 +21,5 @@ Plane geometry parameters in world units.
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ------ | ------ | ------ | ------ |
24
- | <a id="width"></a> `width` | `number` | Plane width along X. | [components/MeshGeometry.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L27) |
25
- | <a id="height"></a> `height` | `number` | Plane height along Y. | [components/MeshGeometry.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L29) |
24
+ | <a id="width"></a> `width` | `number` | Plane width along X. | [components/MeshGeometry.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L27) |
25
+ | <a id="height"></a> `height` | `number` | Plane height along Y. | [components/MeshGeometry.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L29) |
package/dist/docs/api/components/type-aliases/PostprocessingState.md CHANGED
@@ -93,7 +93,7 @@ type PostprocessingState = {
93
93
  };
94
94
  ```
95
95
 
96
- Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L4)
96
+ Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L4)
97
97
 
98
98
  Aggregated post-processing effect chain authored on the scene environment. Each sub-effect has its own `enabled` flag plus per-effect parameters.
99
99
 
@@ -101,64 +101,64 @@ Aggregated post-processing effect chain authored on the scene environment. Each
101
101
 
102
102
  | Property | Type | Description | Defined in |
103
103
  | ------ | ------ | ------ | ------ |
104
- | <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L6) |
105
- | <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L8) |
106
- | `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L10) |
107
- | `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L12) |
108
- | `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L14) |
109
- | `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L16) |
110
- | <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L19) |
111
- | `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L21) |
112
- | `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L23) |
113
- | `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L25) |
114
- | `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L27) |
115
- | <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L30) |
116
- | `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L32) |
117
- | `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L34) |
118
- | `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L36) |
119
- | <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L39) |
120
- | `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L41) |
121
- | `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L43) |
122
- | `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L45) |
123
- | <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L48) |
124
- | `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L50) |
125
- | `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L52) |
126
- | <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L55) |
127
- | `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L57) |
128
- | `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L59) |
129
- | <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L62) |
130
- | `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L64) |
131
- | `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L66) |
132
- | <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L69) |
133
- | `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L71) |
134
- | `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L73) |
135
- | `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L75) |
136
- | <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L78) |
137
- | `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L80) |
138
- | `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L82) |
139
- | <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L85) |
140
- | `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L87) |
141
- | <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L90) |
142
- | `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L92) |
143
- | `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L94) |
144
- | `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L96) |
145
- | <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L99) |
146
- | `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L101) |
147
- | `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L103) |
148
- | `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L105) |
149
- | `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L107) |
150
- | `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L109) |
151
- | `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L111) |
152
- | `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L113) |
153
- | <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L116) |
154
- | `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L118) |
155
- | `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L120) |
156
- | `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L122) |
157
- | `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L124) |
158
- | `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L126) |
159
- | `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L128) |
160
- | `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L130) |
161
- | `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L132) |
162
- | `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L134) |
163
- | `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L136) |
164
- | `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L138) |
104
+ | <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L6) |
105
+ | <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L8) |
106
+ | `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L10) |
107
+ | `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L12) |
108
+ | `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L14) |
109
+ | `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L16) |
110
+ | <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L19) |
111
+ | `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L21) |
112
+ | `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L23) |
113
+ | `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L25) |
114
+ | `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L27) |
115
+ | <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L30) |
116
+ | `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L32) |
117
+ | `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L34) |
118
+ | `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L36) |
119
+ | <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L39) |
120
+ | `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L41) |
121
+ | `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L43) |
122
+ | `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L45) |
123
+ | <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L48) |
124
+ | `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L50) |
125
+ | `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L52) |
126
+ | <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L55) |
127
+ | `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L57) |
128
+ | `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L59) |
129
+ | <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L62) |
130
+ | `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L64) |
131
+ | `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L66) |
132
+ | <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L69) |
133
+ | `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L71) |
134
+ | `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L73) |
135
+ | `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L75) |
136
+ | <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L78) |
137
+ | `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L80) |
138
+ | `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L82) |
139
+ | <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L85) |
140
+ | `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L87) |
141
+ | <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L90) |
142
+ | `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L92) |
143
+ | `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L94) |
144
+ | `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L96) |
145
+ | <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L99) |
146
+ | `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L101) |
147
+ | `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L103) |
148
+ | `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L105) |
149
+ | `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L107) |
150
+ | `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L109) |
151
+ | `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L111) |
152
+ | `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L113) |
153
+ | <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L116) |
154
+ | `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L118) |
155
+ | `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L120) |
156
+ | `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L122) |
157
+ | `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L124) |
158
+ | `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L126) |
159
+ | `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L128) |
160
+ | `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L130) |
161
+ | `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L132) |
162
+ | `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L134) |
163
+ | `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L136) |
164
+ | `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L138) |
package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md CHANGED
@@ -13,7 +13,7 @@ type RadiusHeightMeshParameters = {
13
13
  };
14
14
  ```
15
15
 
16
- Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L39)
16
+ Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L39)
17
17
 
18
18
  Radius + height primitive parameters (capsule, cylinder).
19
19
 
@@ -21,5 +21,5 @@ Radius + height primitive parameters (capsule, cylinder).
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ------ | ------ | ------ | ------ |
24
- | <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L41) |
25
- | <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L43) |
24
+ | <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L41) |
25
+ | <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L43) |