@driftengine/script 4.8.7 → 4.10.0

package/README.md

@@ -3,7 +3,7 @@
 The `drift/*` capability bindings: what this engine provides to DriftScript, and **the only place the
 two are coupled**.
 
-**Cost: 39.9 KB gzipped on top of core.** Measured by `scripts/size-gate.test.mjs`, which fails if it
+**Cost: 40.4 KB gzipped on top of core.** Measured by `scripts/size-gate.test.mjs`, which fails if it
 drifts more than 3% — the number is derived from the same floors that gate asserts, so a README
 quoting a stale one is a red suite rather than a thing somebody notices.
 

package/capabilities.json

@@ -6144,9 +6144,47 @@
         "scene.write"
       ],
       "deterministic": false,
-      "doc": "How far this frame is scaled into the tone curve, above 0. Replaces the profile's `outputExposure` for this frame onward. Adaptation is yours: a game knows it walked into a cave, and the renderer could only find out a frame late. Ignored unless the output transform is `aces`, since otherwise there is no curve to be exposed into.",
+      "doc": "How far this frame is scaled into the tone curve, above 0. Replaces the profile's `outputExposure` for this frame onward. Adaptation is yours: a game knows it walked into a cave, and the renderer could only find out a frame late. Ignored where the output transform is `none` or `srgb`, since there is then no curve to be exposed into.",
       "implementation": "drift/render.exposure"
     },
+    {
+      "module": "drift/render",
+      "name": "filmic",
+      "signature": "fn(renderer: Renderer, slope: f32, toe: f32, shoulder: f32, blackClip: f32, whiteClip: f32) -> void",
+      "params": [
+        {
+          "name": "renderer",
+          "type": "Renderer"
+        },
+        {
+          "name": "slope",
+          "type": "f32"
+        },
+        {
+          "name": "toe",
+          "type": "f32"
+        },
+        {
+          "name": "shoulder",
+          "type": "f32"
+        },
+        {
+          "name": "blackClip",
+          "type": "f32"
+        },
+        {
+          "name": "whiteClip",
+          "type": "f32"
+        }
+      ],
+      "returns": "void",
+      "effects": [
+        "scene.write"
+      ],
+      "deterministic": false,
+      "doc": "The `filmic` output transform's curve, held until changed: the straight segment's slope through mid grey, how much of the curve the toe and the shoulder take (0 to 1), and how far black and white clip past their ends (0 to 1). The engine defaults are 0.88, 0.55, 0.26, 0 and 0.04. Mid grey stays mid grey whatever they are. A number out of range is clamped into it. Ignored unless the quality profile's output transform is `filmic`.",
+      "implementation": "drift/render.filmic"
+    },
     {
       "module": "drift/render",
       "name": "motionBlur",

package/dist/bindings/render.js

@@ -79,8 +79,20 @@ export const RENDER_CAPABILITIES = [
         'never do at night.'),
     define('exposure', [R, { name: 'stops', type: 'f32' }], "How far this frame is scaled into the tone curve, above 0. Replaces the profile's " +
         '`outputExposure` for this frame onward. Adaptation is yours: a game knows it walked into a ' +
-        'cave, and the renderer could only find out a frame late. Ignored unless the output ' +
-        'transform is `aces`, since otherwise there is no curve to be exposed into.'),
+        'cave, and the renderer could only find out a frame late. Ignored where the output ' +
+        'transform is `none` or `srgb`, since there is then no curve to be exposed into.'),
+    define('filmic', [
+        R,
+        { name: 'slope', type: 'f32' },
+        { name: 'toe', type: 'f32' },
+        { name: 'shoulder', type: 'f32' },
+        { name: 'blackClip', type: 'f32' },
+        { name: 'whiteClip', type: 'f32' },
+    ], "The `filmic` output transform's curve, held until changed: the straight segment's slope " +
+        'through mid grey, how much of the curve the toe and the shoulder take (0 to 1), and how ' +
+        'far black and white clip past their ends (0 to 1). The engine defaults are 0.88, 0.55, ' +
+        '0.26, 0 and 0.04. Mid grey stays mid grey whatever they are. A number out of range is ' +
+        "clamped into it. Ignored unless the quality profile's output transform is `filmic`."),
     define('motionBlur', [R, { name: 'scale', type: 'f32' }], 'How much of the camera motion blur ceiling this frame takes, 0 to 1. Held until changed. ' +
         'Ramp it with whatever "fast" means here: blur that is always on stops being a speed cue ' +
         'within seconds and costs eight taps a moving pixel while doing so.'),
@@ -140,6 +152,7 @@ export function renderImplementation() {
         bloom: (renderer, scale) => renderer.setBloom(scale),
         bloomAbove: (renderer, scale, threshold) => renderer.setBloom(scale, threshold),
         exposure: (renderer, stops) => renderer.setOutputExposure(stops),
+        filmic: (renderer, slope, toe, shoulder, blackClip, whiteClip) => renderer.setFilmicCurve({ slope, toe, shoulder, blackClip, whiteClip }),
         motionBlur: (renderer, scale) => renderer.setCameraMotionBlur(scale),
         speedBlur: (renderer, strength) => renderer.setSpeedRush(strength),
         focus: (renderer, distance, range, scale) => renderer.setDepthOfField(distance, range, scale),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driftengine/script",
-  "version": "4.8.7",
+  "version": "4.10.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.8.7",
-    "@driftengine/animation": "4.8.7",
-    "@driftengine/audio": "4.8.7",
-    "@driftengine/chemistry": "4.8.7",
-    "@driftengine/core": "4.8.7",
-    "@driftengine/editor": "4.8.7",
-    "@driftengine/entities": "4.8.7",
-    "@driftengine/network": "4.8.7",
-    "@driftengine/terrain": "4.8.7",
-    "@driftengine/ui2d": "4.8.7",
-    "@driftengine/xr": "4.8.7"
+    "@driftengine/ai": "4.10.0",
+    "@driftengine/animation": "4.10.0",
+    "@driftengine/audio": "4.10.0",
+    "@driftengine/chemistry": "4.10.0",
+    "@driftengine/core": "4.10.0",
+    "@driftengine/editor": "4.10.0",
+    "@driftengine/entities": "4.10.0",
+    "@driftengine/network": "4.10.0",
+    "@driftengine/terrain": "4.10.0",
+    "@driftengine/ui2d": "4.10.0",
+    "@driftengine/xr": "4.10.0"
   },
   "author": "Drift Technologies",
   "repository": {

package/src/bindings/render.ts

@@ -101,8 +101,24 @@ export const RENDER_CAPABILITIES: readonly CapabilityDefinition[] = [
     [R, { name: 'stops', type: 'f32' }],
     "How far this frame is scaled into the tone curve, above 0. Replaces the profile's " +
       '`outputExposure` for this frame onward. Adaptation is yours: a game knows it walked into a ' +
-      'cave, and the renderer could only find out a frame late. Ignored unless the output ' +
-      'transform is `aces`, since otherwise there is no curve to be exposed into.',
+      'cave, and the renderer could only find out a frame late. Ignored where the output ' +
+      'transform is `none` or `srgb`, since there is then no curve to be exposed into.',
+  ),
+  define(
+    'filmic',
+    [
+      R,
+      { name: 'slope', type: 'f32' },
+      { name: 'toe', type: 'f32' },
+      { name: 'shoulder', type: 'f32' },
+      { name: 'blackClip', type: 'f32' },
+      { name: 'whiteClip', type: 'f32' },
+    ],
+    "The `filmic` output transform's curve, held until changed: the straight segment's slope " +
+      'through mid grey, how much of the curve the toe and the shoulder take (0 to 1), and how ' +
+      'far black and white clip past their ends (0 to 1). The engine defaults are 0.88, 0.55, ' +
+      '0.26, 0 and 0.04. Mid grey stays mid grey whatever they are. A number out of range is ' +
+      "clamped into it. Ignored unless the quality profile's output transform is `filmic`.",
   ),
   define(
     'motionBlur',
@@ -185,6 +201,14 @@ export function renderImplementation(): Record<string, unknown> {
     bloomAbove: (renderer: RendererApi, scale: number, threshold: number) =>
       renderer.setBloom(scale, threshold),
     exposure: (renderer: RendererApi, stops: number) => renderer.setOutputExposure(stops),
+    filmic: (
+      renderer: RendererApi,
+      slope: number,
+      toe: number,
+      shoulder: number,
+      blackClip: number,
+      whiteClip: number,
+    ) => renderer.setFilmicCurve({ slope, toe, shoulder, blackClip, whiteClip }),
     motionBlur: (renderer: RendererApi, scale: number) => renderer.setCameraMotionBlur(scale),
     speedBlur: (renderer: RendererApi, strength: number) => renderer.setSpeedRush(strength),
     focus: (renderer: RendererApi, distance: number, range: number, scale: number) =>