lecodes-sdk 2.2.14 → 2.3.0

package/dist/types/gl/Scene.d.ts

@@ -129,17 +129,6 @@ export type SceneOptions = {
      *  loses its top mip levels on load, a glTF image is downsampled. Applied before this scene's
      *  assets load; like `anisotropy` it does not touch textures already loaded. */
     maxTextureSize?: number;
-    /** The look on an HDR display (a screen with headroom above SDR white — Apple XDR panels, the
-     *  macOS host today); ignored on SDR. `strength` 0..1 is how much of the picture reaches for the
-     *  display's headroom (0 only what SDR clipped, 1 nearly everything; default 0.35). `paperWhite`
-     *  1..8 is where white lands as a multiple of SDR white — the "HDR brightness" of a console
-     *  calibration screen, where 1.5–2 is the norm; default 1 keeps a white wall at the UI's white,
-     *  faithful but dim next to what "HDR on" is expected to look like. Engine-wide like `anisotropy`;
-     *  `device.hdr` is the runtime form and tells you whether the display has any headroom at all. */
-    hdr?: {
-        strength?: number;
-        paperWhite?: number;
-    };
 };
 export declare class Scene implements Presentable {
     readonly camera: Camera;

package/dist/types/gl/postProcessing.d.ts

@@ -95,6 +95,25 @@ export type ColorCurves = {
     midPoint?: Rgb;
     highlightScale?: Rgb;
 };
+/** The look on an HDR display — a screen with headroom above SDR white (Apple's XDR panels, an
+ *  external display in HDR mode), where the operator is stretched past SDR white toward the peak.
+ *  Ignored on SDR: stored, read back, nothing changes on screen (`device.hdr.available` says which
+ *  display this is). Part of the grading band — a change is a bake — and quantised to 0.05 steps. */
+export type HdrLook = {
+    /** How much of the picture reaches for the display's headroom, 0..1 (default 0.35). 0 touches only
+     *  what SDR clipped — the SDR grade kept exactly, but a mostly-mid-tone frame then looks flat next
+     *  to its one bright spot; 1 lifts nearly everything above black toward the peak. A sunlit
+     *  exterior takes 1, a dim interior wants less. */
+    strength?: number;
+    /** Where white lands, as a multiple of SDR white, 1..8 (default 1) — the "HDR brightness" of a
+     *  console game's calibration screen, where 1.5–2 is the norm. It scales the WHOLE picture: at 1
+     *  a white wall is as bright as the UI's white (faithful, and dim next to what "HDR on" is
+     *  expected to look like), at 2 twice that, and highlights still climb above it (the engine keeps
+     *  `headroom / paperWhite` for them, clamped at the peak). `strength` decides how much of the
+     *  picture reaches for the peak; this decides where the picture starts — a game that wants to read
+     *  as "HDR on" rather than "SDR with a brighter sun" wants this over `strength`. */
+    paperWhite?: number;
+};
 export type PostProcessingOptions = {
     /** The operator that folds the scene's HDR light into the display's range (default 'aces').
      *  `'aces'` (filament's ACES legacy) desaturates bright colours towards white — HDR fire reads
@@ -128,6 +147,11 @@ export type PostProcessingOptions = {
      *  the operator, in display-referred sRGB — a `.cube` file: `asset('./look.cube')`, or a bare
      *  staged filename. `null` removes it. */
     lut?: string | null;
+    /** The look on an HDR display: `strength` 0..1 (how much of the picture reaches for the peak:
+     *  0 only what SDR clipped … 1 nearly everything; default 0.35), `paperWhite` 1..8 (where white
+     *  lands × SDR white — the console "HDR brightness", 1.5–2 the norm; default 1). Ignored on SDR.
+     *  An overlay takes its parent's, like the rest of the grading. */
+    hdr?: HdrLook;
     /** `true` = defaults (intensity 0.2), an object = its knobs, `false` = off. */
     bloom?: boolean | BloomOptions;
     /** `true` = defaults (a soft black edge), an object = its knobs, `false` = off. */
@@ -140,7 +164,8 @@ export type PostProcessingOptions = {
     depthOfField?: boolean | DepthOfFieldOptions;
 };
 /** The float layout of `_creator.setColorGrading` — creator.h's ColorGradingParam. Indices never
- *  move; a new field goes at the end and COUNT grows. */
+ *  move; a new field goes at the end and COUNT grows (the engine takes an older bundle's shorter
+ *  array, down to the 39 before HDR_*, with the tail at its defaults). */
 export declare const CG: {
     readonly TONE_MAPPING: 0;
     readonly EXPOSURE: 1;
@@ -160,7 +185,9 @@ export declare const CG: {
     readonly MID_POINT: 32;
     readonly HIGHLIGHT_SCALE: 35;
     readonly LUT: 38;
-    readonly COUNT: 39;
+    readonly HDR_STRENGTH: 39;
+    readonly HDR_PAPER_WHITE: 40;
+    readonly COUNT: 41;
 };
 /** The scene's post-processing (`scene.postProcessing`). Read a field for the current value, write
  *  one to change it; `apply(options)` writes the named ones; `reset()` is the defaults. */
@@ -212,6 +239,8 @@ export declare class PostProcessing {
     set curves(v: ColorCurves);
     get lut(): string | null;
     set lut(v: string | null);
+    get hdr(): Required<HdrLook>;
+    set hdr(v: HdrLook);
     get bloom(): Required<BloomOptions> | false;
     set bloom(v: boolean | BloomOptions);
     get vignette(): Required<VignetteOptions> | false;

package/dist/types/runtime/device.d.ts

@@ -88,11 +88,13 @@ export declare const device: {
          *  `(0,0,0)` when not running. */
         readonly gravity: Vec3;
     };
-    /** The display's extended dynamic range — HDR. On a screen with headroom above SDR white (Apple's
-     *  XDR panels; the macOS host today) the 3D surface is float and the engine renders past 1.0:
-     *  1.0 is the white of the UI and of a diffuse white surface, and the sun, emissives and speculars
-     *  climb up to `headroom` times that. Everywhere else it is SDR: `available` false, `headroom` 1,
-     *  the look setters remembered but invisible.
+    /** The display's extended dynamic range — HDR: the FACTS about the display. On the macOS desktop
+     *  host, in a visible window on a screen with headroom above SDR white (Apple's XDR panels, an HDR
+     *  external display), the 3D surface is float and the engine renders past 1.0: 1.0 is the white of
+     *  the UI and of a diffuse white surface, and the sun, emissives and speculars climb up to
+     *  `headroom` times that. Everywhere else it is SDR (the other hosts, a hidden window, a render to
+     *  PNG): `available` false, `headroom` 1. The LOOK on such a display — how much of the picture
+     *  reaches for the peak, where white lands — is the scene's: `scene.postProcessing.hdr`.
      *
      *  Branch content on `available`, not on `headroom` — the live value ramps up from 1 over the
      *  first seconds after launch and follows the brightness keys. Particle `emissive` is the thing
@@ -108,20 +110,6 @@ export declare const device: {
          *  white, quantised to half-stops. Moves with brightness and the screen under the window
          *  (`hdrchange` event); never below 1. */
         readonly headroom: number;
-        /** How much of the picture reaches for the headroom, 0..1 (default 0.35). 0 touches only what
-         *  SDR clipped — faithful to the SDR grade, but a mostly-mid-tone frame then looks flat next to
-         *  the one bright spot; 1 lifts nearly everything above black toward the peak. A sunlit exterior
-         *  takes 1, a dim interior wants less. A host may pin it (`LECODES_HDR_STRENGTH`). */
-        strength: number;
-        /** Where white lands, as a multiple of SDR white, 1..8 (default 1) — the "HDR brightness" of a
-         *  console game's calibration screen, where paper white sits at ~200 nits against SDR's ~100.
-         *  It scales the WHOLE picture: at 1 a white wall is as bright as the UI's white, at 2 it is
-         *  twice that, and highlights still climb above it (the engine keeps `headroom / paperWhite` for
-         *  them, clamped at the peak). `strength` decides how much of the picture reaches for the
-         *  peak; this decides where the picture starts. 1.5–2 is the console norm; a game that wants to
-         *  read as "HDR on" rather than "SDR with a brighter sun" wants this over `strength`. A host may
-         *  pin it (`LECODES_HDR_PAPER_WHITE`). */
-        paperWhite: number;
     };
     /** Current connectivity — best-effort navigator.onLine semantics: `false` only when the platform
      *  is sure there's no network. `true` on hosts that don't track it. Change events: `"online"` /

package/dist/types/version.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "2.2.14";
+export declare const SDK_VERSION = "2.3.0";
 /** The major of a semver string, or null when it is not one. */
 export declare const sdkMajor: (version: string | null | undefined) => number | null;
 /** The `// sdk: <version>` line of a compiled bundle's header (sdk/src/compile/header.ts), read from