@driftengine/core 4.8.4 → 4.8.6

package/src/render/surfaceModel.ts

@@ -18,6 +18,8 @@
  * the draw's model matrix and the eye's joint each draw, with `eyeAxisInWorld`.
  */
 import type { Vec3 } from '../math/color.ts';
+import { lightmapRegionOf } from './lightmap.ts';
+import type { LightmapRegion } from './lightmap.ts';
 
 /** Strands of brushed metal, satin or hair-like fibre: a highlight stretched across them. */
 export interface AnisotropicModel {
@@ -77,8 +79,19 @@ export interface EyeModel {
   readonly joint: number;
 }
 
+/**
+ * A surface whose static light was baked: the standard model, plus a lightmap page's light read at
+ * the mesh's second coordinates (`MeshData.lightmapUvs`). The material's `modelMap` is the page,
+ * from `createLightmap`; see `lightmap.ts` for what it adds and what it gives up.
+ */
+export interface LightmapModel {
+  readonly kind: 'lightmap';
+  /** Where this material's surfaces are on the page: `uv2 * scale + bias`. See `LightmapRegion`. */
+  readonly region: LightmapRegion;
+}
+
 /** Every model a material can name, by its `kind`: see `SurfaceMaterial.model`. */
-export type SurfaceModel = AnisotropicModel | HairModel | SkinModel | EyeModel;
+export type SurfaceModel = AnisotropicModel | HairModel | SkinModel | EyeModel | LightmapModel;
 /** A model's name, which also picks its pipeline switch: `SURFACE_MODEL_SWITCH`. */
 export type SurfaceModelKind = SurfaceModel['kind'];
 
@@ -88,6 +101,7 @@ export const SURFACE_MODEL_KINDS: readonly SurfaceModelKind[] = [
   'hair',
   'skin',
   'eye',
+  'lightmap',
 ];
 
 /** The lit stage's switch for each kind. */
@@ -96,6 +110,7 @@ export const SURFACE_MODEL_SWITCH: Readonly<Record<SurfaceModelKind, string>> =
   hair: 'MODEL_HAIR',
   skin: 'MODEL_SKIN',
   eye: 'MODEL_EYE',
+  lightmap: 'MODEL_LIGHTMAP',
 };
 
 /** Floats a material's model takes: `uModelParams[2]`. */
@@ -188,6 +203,19 @@ export function eyeModel(
   });
 }
 
+/**
+ * A baked surface, reading its region of a lightmap page: the whole page where none is named. An
+ * instanced batch's regions compose with this one, each instance's applied first: see
+ * `MeshInstances.lightmapRegions`.
+ */
+export function lightmapModel(options: { region?: LightmapRegion } = {}): LightmapModel {
+  const region = lightmapRegionOf(options.region);
+  return Object.freeze({
+    kind: 'lightmap',
+    region: Object.freeze([region[0], region[1], region[2], region[3]]) as LightmapRegion,
+  });
+}
+
 /**
  * A model's numbers into `out` — eight floats, `uModelParams[0]` then `[1]` — and whether a model
  * map is bound into the last. Zeros for the standard model. An eye's axis goes in with the
@@ -197,6 +225,7 @@ export function eyeModel(
  * - hair: shift, scatter, backlit, − · −, −, −, map
  * - skin: the scatter colour, radius · transmission, profile, −, map
  * - eye: iris radius, iris depth, ior, cornea roughness · the axis, map
+ * - lightmap: the region's scale and bias · −, −, −, map
  */
 export function packModel(model: SurfaceModel | null, mapped: boolean, out: Float32Array): void {
   out.fill(0);
@@ -230,6 +259,12 @@ export function packModel(model: SurfaceModel | null, mapped: boolean, out: Floa
       out[5] = model.axis[1];
       out[6] = model.axis[2];
       return;
+    case 'lightmap':
+      out[0] = model.region[0];
+      out[1] = model.region[1];
+      out[2] = model.region[2];
+      out[3] = model.region[3];
+      return;
   }
 }
 

package/src/render/surfaceTexture.ts

@@ -21,6 +21,8 @@ import { uploadCompressedArray } from './glCompressed.ts';
 import { SURFACE_EFFECT_TEXELS, packSurfaceEffects } from './surfaceEffects.ts';
 import type { SurfaceLayerEffect } from './surfaceEffects.ts';
 import type { CutoutMode } from './cutoutDither.ts';
+import { isLightmapTexels } from './lightmap.ts';
+import type { LightmapTexels } from './lightmap.ts';
 
 /**
  * How a texture behaves past its edges and between its texels.
@@ -110,6 +112,18 @@ export interface SurfaceMaterial<Texture = SurfaceTexture> {
    * without culling, and a back face is lit as its front, with the normal turned to the viewer.
    */
   doubleSided?: boolean;
+  /**
+   * The lighting channels this surface takes light from, a mask: 1, 2, 3 … 255. **1 by default**,
+   * which is every light's default too, so a scene that names no channel is lit as it always was.
+   *
+   * A point or spot light shades this surface only where its `PointLightSet.lightChannels` and this
+   * share a bit — Unreal's lighting channels. A character's own key and rim lights on channel 2,
+   * and the character's materials on 3, light the character and leave the floor around it as the
+   * stage's lights alone have it. **What it does not reach**: the sun, the sky and the probes, area
+   * lights, DriftLight's volume and the GPU-driven pipeline light every surface whatever its mask.
+   * A number that is not a whole mask from 1 to 255 is channel 1.
+   */
+  lightChannels?: number;
   /**
    * How hard the normal map turns the shading normal.
    *
@@ -267,11 +281,15 @@ export class SurfaceTexture {
    */
   constructor(
     gl: WebGL2RenderingContext,
-    source: SurfaceSource | readonly SurfaceSource[],
+    source: SurfaceSource | readonly SurfaceSource[] | LightmapTexels,
     options: SurfaceTextureOptions = {},
     compressed: readonly CompressedTextureFormat[] = [],
   ) {
-    const listed = (Array.isArray(source) ? source : [source]) as readonly SurfaceSource[];
+    /* A lightmap's page: half floats, uploaded as they are. See `lightmap.ts`. */
+    const baked = isLightmapTexels(source) ? source : null;
+    const listed = (
+      baked !== null ? [] : Array.isArray(source) ? source : [source]
+    ) as readonly SurfaceSource[];
     const blocks = compressedLayers(listed);
     this.srgb = (options.colorSpace ?? 'linear') === 'srgb';
     /* Refused before anything is allocated, so a refusal leaves no texture behind. */
@@ -282,7 +300,27 @@ export class SurfaceTexture {
     const wrap = (options.wrap ?? 'repeat') === 'repeat' ? gl.REPEAT : gl.CLAMP_TO_EDGE;
     gl.bindTexture(gl.TEXTURE_2D_ARRAY, texture);
 
-    if (blocks !== null && plan !== null) {
+    if (baked !== null) {
+      /* No chain: a page is read at its own resolution, and a level of it would blend regions. */
+      this.layers = baked.layers;
+      this.blockFormat = null;
+      this.mipmapped = false;
+      /* A typed array refuses either flag set, so both are put down here rather than assumed. */
+      gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, false);
+      gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, false);
+      gl.texImage3D(
+        gl.TEXTURE_2D_ARRAY,
+        0,
+        gl.RGBA16F,
+        baked.width,
+        baked.height,
+        baked.layers,
+        0,
+        gl.RGBA,
+        gl.HALF_FLOAT,
+        baked.texels,
+      );
+    } else if (blocks !== null && plan !== null) {
       /* The stored chain, or level 0 alone where no chain was asked for. Nothing is generated:
          `generateMipmap` cannot write a compressed format. */
       this.layers = blocks.length;