@driftengine/script 4.12.0 → 4.13.0

package/capabilities.json

@@ -6887,7 +6887,7 @@
         "scene.write"
       ],
       "deterministic": false,
-      "doc": "The same, multiplied by a colour. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.",
+      "doc": "The same, multiplied by a colour picked for the screen: sRGB, 0 to 1, decoded to linear as a tint on a node is, with alpha kept as given. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.",
       "implementation": "drift/2d.tinted"
     },
     {
@@ -7421,7 +7421,7 @@
         "scene.write"
       ],
       "deterministic": false,
-      "doc": "Change a node's background colour. A node with no background gets one.",
+      "doc": "Change a node's background colour, given as picked for the screen: sRGB, 0 to 1, decoded here to the linear light the renderer draws, as a theme's hex token is. Alpha is coverage and is kept as given. A node with no background gets one.",
       "implementation": "drift/ui.tint"
     },
     {

package/dist/bindings/interface.js

@@ -1,3 +1,4 @@
+import { srgbToLinear } from '@driftengine/core';
 import { createUiInput, drawUiTree, layoutUiTree, routeUiKey, routeUiPointer, setUiFocus, uiNodeNamed, } from '@driftengine/ui2d';
 import { defineCapability } from 'driftscript';
 export const INTERFACE_MODULE = 'drift/ui';
@@ -89,7 +90,7 @@ export const INTERFACE_CAPABILITIES = [
         { name: 'g', type: 'f32' },
         { name: 'b', type: 'f32' },
         { name: 'a', type: 'f32' },
-    ], 'void', ['scene.write'], "Change a node's background colour. A node with no background gets one."),
+    ], 'void', ['scene.write'], "Change a node's background colour, given as picked for the screen: sRGB, 0 to 1, decoded here to the linear light the renderer draws, as a theme's hex token is. Alpha is coverage and is kept as given. A node with no background gets one."),
     define('hovered', NAMED, 'bool', ['input.read'], 'Whether the pointer is over a node.'),
     define('pressed', NAMED, 'bool', ['input.read'], 'Whether the pointer went down on a node and has not come up.'),
     define('focused', NAMED, 'bool', ['input.read'], 'Whether a node has the keyboard.'),
@@ -168,9 +169,10 @@ export function interfaceImplementation() {
                happens once per node rather than per frame. */
             if (node.background === null)
                 node.background = new Float32Array(4);
-            node.background[0] = r;
-            node.background[1] = g;
-            node.background[2] = b;
+            /* A colour a script picks is a display value, and the node's is linear: see `unpackRgba`. */
+            node.background[0] = srgbToLinear(r);
+            node.background[1] = srgbToLinear(g);
+            node.background[2] = srgbToLinear(b);
             node.background[3] = a;
         },
         hovered: (tree, name) => nodeOf(tree, name)?.hovered === true,

package/dist/bindings/sprites.js

@@ -1,3 +1,4 @@
+import { srgbToLinear } from '@driftengine/core';
 import { createSpriteFrame, drawSprite, drawTilemap, frameOf, setTile, sheetFrame, tileAt, } from '@driftengine/ui2d';
 import { defineCapability } from 'driftscript';
 export const SPRITES_MODULE = 'drift/2d';
@@ -92,7 +93,7 @@ export const SPRITES_CAPABILITIES = [
         { name: 'g', type: 'f32' },
         { name: 'b', type: 'f32' },
         { name: 'a', type: 'f32' },
-    ], 'void', ['scene.write'], 'The same, multiplied by a colour. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.'),
+    ], 'void', ['scene.write'], 'The same, multiplied by a colour picked for the screen: sRGB, 0 to 1, decoded to linear as a tint on a node is, with alpha kept as given. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.'),
     define('frame', [
         { name: 'batch', type: 'SpriteBatch' },
         { name: 'sheet', type: 'SpriteSheet' },
@@ -156,9 +157,10 @@ export function spritesImplementation() {
             drawSprite(batch, texture, at(x, y, w, h), null, null);
         },
         tinted: (batch, texture, x, y, w, h, r, g, b, a) => {
-            tint[0] = r;
-            tint[1] = g;
-            tint[2] = b;
+            /* Picked for the screen and decoded, so a white texture draws exactly this colour. */
+            tint[0] = srgbToLinear(r);
+            tint[1] = srgbToLinear(g);
+            tint[2] = srgbToLinear(b);
             tint[3] = a;
             drawSprite(batch, texture, at(x, y, w, h), null, tint);
         },

package/package.json

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

package/src/bindings/interface.ts

@@ -1,3 +1,4 @@
+import { srgbToLinear } from '@driftengine/core';
 import type { SpriteBatch, UiInput, UiNode } from '@driftengine/ui2d';
 import {
   createUiInput,
@@ -158,7 +159,7 @@ export const INTERFACE_CAPABILITIES: readonly CapabilityDefinition[] = [
     ],
     'void',
     ['scene.write'],
-    "Change a node's background colour. A node with no background gets one.",
+    "Change a node's background colour, given as picked for the screen: sRGB, 0 to 1, decoded here to the linear light the renderer draws, as a theme's hex token is. Alpha is coverage and is kept as given. A node with no background gets one.",
   ),
   define('hovered', NAMED, 'bool', ['input.read'], 'Whether the pointer is over a node.'),
   define(
@@ -268,9 +269,10 @@ export function interfaceImplementation(): Record<string, unknown> {
       /* A node with no background gets one, which is the only allocation in this module and
          happens once per node rather than per frame. */
       if (node.background === null) node.background = new Float32Array(4);
-      node.background[0] = r;
-      node.background[1] = g;
-      node.background[2] = b;
+      /* A colour a script picks is a display value, and the node's is linear: see `unpackRgba`. */
+      node.background[0] = srgbToLinear(r);
+      node.background[1] = srgbToLinear(g);
+      node.background[2] = srgbToLinear(b);
       node.background[3] = a;
     },
     hovered: (tree: UiNode, name: string) => nodeOf(tree, name)?.hovered === true,

package/src/bindings/sprites.ts

@@ -1,3 +1,4 @@
+import { srgbToLinear } from '@driftengine/core';
 import type { SpriteBatch, SpriteSheet, Tilemap } from '@driftengine/ui2d';
 import {
   createSpriteFrame,
@@ -125,7 +126,7 @@ export const SPRITES_CAPABILITIES: readonly CapabilityDefinition[] = [
     ],
     'void',
     ['scene.write'],
-    'The same, multiplied by a colour. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.',
+    'The same, multiplied by a colour picked for the screen: sRGB, 0 to 1, decoded to linear as a tint on a node is, with alpha kept as given. White is the identity, so a white texture draws exactly this colour — which is how a solid rectangle is drawn.',
   ),
   define(
     'frame',
@@ -264,9 +265,10 @@ export function spritesImplementation(): Record<string, unknown> {
       b: number,
       a: number,
     ) => {
-      tint[0] = r;
-      tint[1] = g;
-      tint[2] = b;
+      /* Picked for the screen and decoded, so a white texture draws exactly this colour. */
+      tint[0] = srgbToLinear(r);
+      tint[1] = srgbToLinear(g);
+      tint[2] = srgbToLinear(b);
       tint[3] = a;
       drawSprite(batch, texture, at(x, y, w, h), null, tint);
     },