@driftengine/script 4.11.0 → 4.12.0

package/capabilities.json

@@ -6259,6 +6259,32 @@
       "doc": "Where this frame's lens is focused and how deep the sharp zone is, in metres, and how much of the depth-of-field ceiling to take, 0 to 1. Held until changed. `scale` is required here though the engine defaults it to 1, because taking the whole ceiling is the expensive answer and a script author is further from that cost than a TypeScript caller.",
       "implementation": "drift/render.focus"
     },
+    {
+      "module": "drift/render",
+      "name": "occlusionFade",
+      "signature": "fn(renderer: Renderer, distance: f32, radius: f32) -> void",
+      "params": [
+        {
+          "name": "renderer",
+          "type": "Renderer"
+        },
+        {
+          "name": "distance",
+          "type": "f32"
+        },
+        {
+          "name": "radius",
+          "type": "f32"
+        }
+      ],
+      "returns": "void",
+      "effects": [
+        "scene.write"
+      ],
+      "deterministic": false,
+      "doc": "Where ambient occlusion fades out with distance: whole up to `distance` metres from the eye and gone `radius` metres past it, so far scenery and a distant sky are not shaded in rings that follow the depth buffer. A negative distance is no fade, the default. Held until changed. Does nothing when the quality profile's `ambientOcclusion` is 0.",
+      "implementation": "drift/render.occlusionFade"
+    },
     {
       "module": "drift/render",
       "name": "medium",

package/dist/bindings/render.js

@@ -107,6 +107,10 @@ export const RENDER_CAPABILITIES = [
         'of the depth-of-field ceiling to take, 0 to 1. Held until changed. `scale` is required ' +
         'here though the engine defaults it to 1, because taking the whole ceiling is the expensive ' +
         'answer and a script author is further from that cost than a TypeScript caller.'),
+    define('occlusionFade', [R, { name: 'distance', type: 'f32' }, { name: 'radius', type: 'f32' }], 'Where ambient occlusion fades out with distance: whole up to `distance` metres from the eye ' +
+        'and gone `radius` metres past it, so far scenery and a distant sky are not shaded in rings ' +
+        'that follow the depth buffer. A negative distance is no fade, the default. Held until ' +
+        "changed. Does nothing when the quality profile's `ambientOcclusion` is 0."),
     define('medium', [
         R,
         { name: 'density', type: 'f32' },
@@ -156,6 +160,7 @@ export function renderImplementation() {
         motionBlur: (renderer, scale) => renderer.setCameraMotionBlur(scale),
         speedBlur: (renderer, strength) => renderer.setSpeedRush(strength),
         focus: (renderer, distance, range, scale) => renderer.setDepthOfField(distance, range, scale),
+        occlusionFade: (renderer, distance, radius) => renderer.setAmbientOcclusionFade(distance, radius),
         medium: (renderer, density, albedo, anisotropy, maxDistance) => renderer.setGlobalMedium(density, albedo, anisotropy, maxDistance),
         veil: (renderer, red, green, blue, alpha) => renderer.setFrameVeil(red, green, blue, alpha),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driftengine/script",
-  "version": "4.11.0",
+  "version": "4.12.0",
   "description": "The drift/* capability bindings: what this engine provides to DriftScript, and the only place the two are coupled",
   "license": "Apache-2.0",
   "type": "module",
@@ -31,17 +31,17 @@
     "driftscript": "1.17.0"
   },
   "peerDependencies": {
-    "@driftengine/ai": "4.11.0",
-    "@driftengine/animation": "4.11.0",
-    "@driftengine/audio": "4.11.0",
-    "@driftengine/chemistry": "4.11.0",
-    "@driftengine/core": "4.11.0",
-    "@driftengine/editor": "4.11.0",
-    "@driftengine/entities": "4.11.0",
-    "@driftengine/network": "4.11.0",
-    "@driftengine/terrain": "4.11.0",
-    "@driftengine/ui2d": "4.11.0",
-    "@driftengine/xr": "4.11.0"
+    "@driftengine/ai": "4.12.0",
+    "@driftengine/animation": "4.12.0",
+    "@driftengine/audio": "4.12.0",
+    "@driftengine/chemistry": "4.12.0",
+    "@driftengine/core": "4.12.0",
+    "@driftengine/editor": "4.12.0",
+    "@driftengine/entities": "4.12.0",
+    "@driftengine/network": "4.12.0",
+    "@driftengine/terrain": "4.12.0",
+    "@driftengine/ui2d": "4.12.0",
+    "@driftengine/xr": "4.12.0"
   },
   "author": "Drift Technologies",
   "repository": {

package/src/bindings/render.ts

@@ -146,6 +146,14 @@ export const RENDER_CAPABILITIES: readonly CapabilityDefinition[] = [
       'here though the engine defaults it to 1, because taking the whole ceiling is the expensive ' +
       'answer and a script author is further from that cost than a TypeScript caller.',
   ),
+  define(
+    'occlusionFade',
+    [R, { name: 'distance', type: 'f32' }, { name: 'radius', type: 'f32' }],
+    'Where ambient occlusion fades out with distance: whole up to `distance` metres from the eye ' +
+      'and gone `radius` metres past it, so far scenery and a distant sky are not shaded in rings ' +
+      'that follow the depth buffer. A negative distance is no fade, the default. Held until ' +
+      "changed. Does nothing when the quality profile's `ambientOcclusion` is 0.",
+  ),
   define(
     'medium',
     [
@@ -213,6 +221,8 @@ export function renderImplementation(): Record<string, unknown> {
     speedBlur: (renderer: RendererApi, strength: number) => renderer.setSpeedRush(strength),
     focus: (renderer: RendererApi, distance: number, range: number, scale: number) =>
       renderer.setDepthOfField(distance, range, scale),
+    occlusionFade: (renderer: RendererApi, distance: number, radius: number) =>
+      renderer.setAmbientOcclusionFade(distance, radius),
     medium: (
       renderer: RendererApi,
       density: number,