@forgeax/engine-render 0.1.20 → 0.1.21

package/src/targets/physical.ts

@@ -0,0 +1,18 @@
+import type { Texture, TextureView } from '@forgeax/engine-rhi';
+import type { RenderTargetDescriptor } from './contracts';
+
+/** Renderer-private physical storage for one logical target generation. */
+export interface RenderTargetPhysical {
+  readonly generation: number;
+  readonly descriptor: RenderTargetDescriptor;
+  readonly texture: Texture;
+  readonly view: TextureView;
+  readonly mipViews: readonly TextureView[];
+  readonly colorTextures: readonly Texture[];
+  readonly faceViews: readonly TextureView[];
+  readonly depthTextures: readonly Texture[];
+  readonly depthViews: readonly TextureView[];
+  readonly resolveTexture?: Texture;
+  readonly resolveView: TextureView;
+  readonly resolveFaceViews: readonly TextureView[];
+}

package/src/targets/readback.ts

@@ -0,0 +1,153 @@
+import type { RenderError } from '../errors/render';
+import { RenderTargetOperationFailedError, RenderTargetStateInvalidError } from '../errors/render';
+import type { RenderResult } from '../render-contract';
+import type { RenderTarget } from './contracts';
+
+export interface RenderTargetReadbackReceipt {
+  readonly frameId: number;
+  readonly deviceGeneration: number;
+}
+
+export interface RenderTargetReadbackTicketInput {
+  readonly frameId?: number;
+  deviceGeneration: number;
+  readonly mipLevel: number;
+  readonly face?: number;
+  readonly width: number;
+  readonly height: number;
+  readonly bytesPerPixel: number;
+}
+
+export interface RenderTargetReadbackTicket {
+  readonly target: RenderTarget;
+  frameId: number | undefined;
+  deviceGeneration: number;
+  readonly mipLevel: number;
+  readonly face?: number;
+  readonly width: number;
+  readonly height: number;
+  readonly bytesPerRow: number;
+  readonly byteLength: number;
+  consumed: boolean;
+}
+
+export interface RenderTargetReadbackResult {
+  readonly bytes: Uint8Array;
+  readonly frameId: number;
+  readonly deviceGeneration: number;
+  readonly mipLevel: number;
+  readonly face?: number;
+}
+
+function invalidTicket(
+  ticket: RenderTargetReadbackTicket,
+  reason: 'uninitialized' | 'generation-mismatch' | 'destroyed',
+): RenderResult<never, RenderError> {
+  return {
+    ok: false,
+    error: new RenderTargetStateInvalidError({
+      operation: 'readback',
+      reason,
+      state: reason === 'destroyed' ? 'destroyed' : 'active',
+      generation: ticket.deviceGeneration,
+    }),
+  };
+}
+
+export function bindRenderTargetReadbackTicket(
+  ticket: RenderTargetReadbackTicket,
+  receipt: RenderTargetReadbackReceipt,
+): RenderResult<void, RenderError> {
+  if (ticket.consumed) return invalidTicket(ticket, 'destroyed');
+  if (ticket.frameId !== undefined) {
+    return invalidTicket(ticket, 'generation-mismatch');
+  }
+  ticket.frameId = receipt.frameId;
+  ticket.deviceGeneration = receipt.deviceGeneration;
+  return { ok: true, value: undefined };
+}
+
+export function createRenderTargetReadbackTicket(
+  target: RenderTarget,
+  input: RenderTargetReadbackTicketInput,
+): RenderResult<RenderTargetReadbackTicket, RenderError> {
+  if (
+    (input.frameId !== undefined && (!Number.isInteger(input.frameId) || input.frameId < 0)) ||
+    !Number.isInteger(input.deviceGeneration) ||
+    input.deviceGeneration < 0 ||
+    !Number.isInteger(input.mipLevel) ||
+    input.mipLevel < 0 ||
+    !Number.isInteger(input.width) ||
+    input.width < 1 ||
+    !Number.isInteger(input.height) ||
+    input.height < 1 ||
+    !Number.isInteger(input.bytesPerPixel) ||
+    input.bytesPerPixel < 1
+  ) {
+    return {
+      ok: false,
+      error: new RenderTargetOperationFailedError({
+        operation: 'readback',
+        stage: 'copy',
+        generation: input.deviceGeneration,
+        cause: new Error('readback dimensions and identity must be non-negative integers'),
+        recovery: 'retry',
+      }),
+    };
+  }
+  const unalignedRowBytes = input.width * input.bytesPerPixel;
+  const bytesPerRow = Math.ceil(unalignedRowBytes / 256) * 256;
+  return {
+    ok: true,
+    value: {
+      target,
+      frameId: input.frameId,
+      deviceGeneration: input.deviceGeneration,
+      mipLevel: input.mipLevel,
+      ...(input.face === undefined ? {} : { face: input.face }),
+      width: input.width,
+      height: input.height,
+      bytesPerRow,
+      byteLength: bytesPerRow * input.height,
+      consumed: false,
+    },
+  };
+}
+
+export function completeRenderTargetReadback(
+  ticket: RenderTargetReadbackTicket,
+  receipt: RenderTargetReadbackReceipt,
+  bytes: Uint8Array,
+): RenderResult<RenderTargetReadbackResult, RenderError> {
+  if (ticket.consumed) return invalidTicket(ticket, 'destroyed');
+  if (
+    ticket.frameId === undefined ||
+    receipt.frameId !== ticket.frameId ||
+    receipt.deviceGeneration !== ticket.deviceGeneration
+  ) {
+    return invalidTicket(ticket, 'generation-mismatch');
+  }
+  if (bytes.byteLength !== ticket.byteLength) {
+    return {
+      ok: false,
+      error: new RenderTargetOperationFailedError({
+        operation: 'readback',
+        stage: 'copy',
+        generation: ticket.deviceGeneration,
+        cause: new Error(`expected ${ticket.byteLength} bytes, received ${bytes.byteLength}`),
+        recovery: 'retry',
+      }),
+    };
+  }
+  ticket.consumed = true;
+  return {
+    ok: true,
+    value: {
+      bytes,
+      frameId: ticket.frameId,
+      deviceGeneration: ticket.deviceGeneration,
+      mipLevel: ticket.mipLevel,
+      ...(ticket.face === undefined ? {} : { face: ticket.face }),
+    },
+  };
+}

package/src/transmission/__tests__/standard-transmission.dawn.test.ts

@@ -14,6 +14,7 @@ import {
   DirectionalLight,
   MeshFilter,
   MeshRenderer,
+  PointLight,
   TONEMAP_LINEAR,
 } from '../../components';
 import { constructRendererHost, type RhiBackendPack } from '../../construct-renderer';
@@ -57,8 +58,10 @@ interface TransmissionCase {
   readonly thicknessTexture?: number;
   readonly masked?: boolean;
   readonly overlap?: boolean;
-  readonly lane?: 'direct' | 'clustered';
+  readonly renderPath?: 'forward' | 'deferred';
   readonly surfaceQuat?: readonly [number, number, number, number];
+  readonly directionalLight?: boolean;
+  readonly localLight?: boolean;
 }
 
 function textureAsset(value: number): TextureAsset {
@@ -106,6 +109,7 @@ async function renderCase(testCase: TransmissionCase): Promise<{
   readonly pixel: readonly [number, number, number, number];
   readonly passNames: readonly string[];
   readonly observation: boolean;
+  readonly errors: readonly string[];
 }> {
   let device: GPUDevice | undefined;
   let configuredDevice: GPUDevice | undefined;
@@ -157,7 +161,7 @@ async function renderCase(testCase: TransmissionCase): Promise<{
       {
         standardProfile: {
           ...DEFAULT_STANDARD_PROFILE,
-          lighting: testCase.lane ?? 'direct',
+          renderPath: testCase.renderPath ?? DEFAULT_STANDARD_PROFILE.renderPath,
         },
       },
       { shaderManifestUrl: ENGINE_MANIFEST_URL },
@@ -172,6 +176,10 @@ async function renderCase(testCase: TransmissionCase): Promise<{
   }
 
   const { renderer } = host.value;
+  const errors: string[] = [];
+  const unsubscribe = renderer.subscribe((event) => {
+    if (event.kind === 'error') errors.push(event.error.code);
+  });
   const world = new World();
   const lease = renderer.attach(world);
   if (!lease.ok) throw lease.error;
@@ -277,12 +285,22 @@ async function renderCase(testCase: TransmissionCase): Promise<{
   );
   expect(cameraEntity.ok, `${testCase.name}: camera spawn must succeed`).toBe(true);
   if (!cameraEntity.ok) throw cameraEntity.error;
-  const lightEntity = world.spawn({
-    component: DirectionalLight,
-    data: { direction: [0, 0, -1], color: [1, 1, 1], intensity: 1, castShadow: false },
-  });
-  expect(lightEntity.ok, `${testCase.name}: light spawn must succeed`).toBe(true);
-  if (!lightEntity.ok) throw lightEntity.error;
+  if (testCase.directionalLight !== false) {
+    const lightEntity = world.spawn({
+      component: DirectionalLight,
+      data: { direction: [0, 0, -1], color: [1, 1, 1], intensity: 1, castShadow: false },
+    });
+    expect(lightEntity.ok, `${testCase.name}: light spawn must succeed`).toBe(true);
+    if (!lightEntity.ok) throw lightEntity.error;
+  }
+  if (testCase.localLight === true) {
+    const localLightEntity = world.spawn(
+      { component: Transform, data: { pos: [0, 0, 1] } },
+      { component: PointLight, data: { intensity: 8, range: 10 } },
+    );
+    expect(localLightEntity.ok, `${testCase.name}: local light spawn must succeed`).toBe(true);
+    if (!localLightEntity.ok) throw localLightEntity.error;
+  }
   world.update().unwrap();
   const drawn = renderer.draw({
     leases: [lease.value],
@@ -299,10 +317,12 @@ async function renderCase(testCase: TransmissionCase): Promise<{
   const renderDevice = configuredDevice ?? device;
   const passNames = renderer.inspect().perFramePassNames;
   expect(renderer.inspect().renderScene.projectionRecords).toBeGreaterThanOrEqual(1);
+  unsubscribe();
   return {
     pixel: await readCenter(renderDevice, target),
     passNames,
     observation: observation.ok,
+    errors,
   };
 }
 
@@ -403,9 +423,9 @@ describe('Standard transmission Dawn ROI', () => {
     );
   }, 120_000);
 
-  it('exercises direct/clustered lanes and transmission-before-BLEND overlap order', async () => {
-    const direct = await renderCase({
-      name: 'direct',
+  it('exercises both Standard render paths and transmission-before-BLEND overlap order', async () => {
+    const forward = await renderCase({
+      name: 'forward',
       transmission: 1,
       ior: 1.5,
       thickness: 0.5,
@@ -413,10 +433,10 @@ describe('Standard transmission Dawn ROI', () => {
       attenuationColor: [0.7, 0.8, 0.9],
       attenuationDistance: 2,
       overlap: true,
-      lane: 'direct',
+      renderPath: 'forward',
     });
-    const clustered = await renderCase({
-      name: 'clustered',
+    const deferred = await renderCase({
+      name: 'deferred',
       transmission: 1,
       ior: 1.5,
       thickness: 0.5,
@@ -424,14 +444,33 @@ describe('Standard transmission Dawn ROI', () => {
       attenuationColor: [0.7, 0.8, 0.9],
       attenuationDistance: 2,
       overlap: true,
-      lane: 'clustered',
+      renderPath: 'deferred',
     });
-    const transmissionIndex = direct.passNames.indexOf('transmission-forward');
-    const transparentIndex = direct.passNames.indexOf('transparent');
+    const transmissionIndex = forward.passNames.indexOf('transmission-forward');
+    const transparentIndex = forward.passNames.indexOf('transparent');
     expect(transmissionIndex).toBeGreaterThanOrEqual(0);
     expect(transparentIndex).toBeGreaterThan(transmissionIndex);
-    expect(clustered.pixel).not.toEqual(direct.pixel);
-    expect(clustered.pixel.every(Number.isFinite)).toBe(true);
-    expect(direct.pixel.every(Number.isFinite)).toBe(true);
+    expect(deferred.pixel.every(Number.isFinite)).toBe(true);
+    expect(forward.pixel.every(Number.isFinite)).toBe(true);
+  }, 120_000);
+
+  it('submits a real clustered local-light frame through the Standard front door', async () => {
+    const clustered = await renderCase({
+      name: 'clustered-local-light',
+      transmission: 0,
+      ior: 1.5,
+      thickness: 0,
+      roughness: 0.4,
+      attenuationColor: [1, 1, 1],
+      directionalLight: false,
+      localLight: true,
+      renderPath: 'forward',
+    });
+
+    expect(clustered.passNames).toEqual(
+      expect.arrayContaining(['cluster-membership-producer', 'main', 'output-transform']),
+    );
+    expect(clustered.observation).toBe(true);
+    expect(clustered.errors).toEqual([]);
   }, 120_000);
 });

package/src/typed-render-graph-primitives.ts

@@ -222,6 +222,8 @@ export function addTypedScenePass(
           projectorSampler:
             internal.spotLightProjector?.sampler ?? internal.volumetricFog?.projectorSampler,
         },
+        true,
+        internal.standardLighting,
       );
       if (groups.viewBindGroup !== null) {
         options.gpuDriven?.encode(groups.viewBindGroup, pass, resources);
@@ -696,7 +698,7 @@ export function addTypedOutputTransformPass(
   graph: RenderGraphBuilder<RenderPipelineFrame>,
   input: RenderPipelineTarget,
   output: RenderPipelineTarget,
-  options: { readonly outputOnly?: boolean; readonly outputTransform?: boolean } = {},
+  options: { readonly outputOnly?: boolean; readonly dither?: boolean } = {},
 ): Result<void, RenderGraphError> {
   const outputOnly = options.outputOnly ?? false;
   return addTypedFullscreenPass(graph, {
@@ -706,7 +708,7 @@ export function addTypedOutputTransformPass(
     output,
     outputOnly,
     rawSwapchainOutput: outputOnly,
-    ...(options.outputTransform === true
+    ...(options.dither !== undefined
       ? {
           paramsTransform: (params: Uint8Array | undefined): Uint8Array | undefined => {
             if (params === undefined || params.byteLength !== 16) return params;
@@ -715,7 +717,7 @@ export function addTypedOutputTransformPass(
               transformed.buffer,
               transformed.byteOffset,
               transformed.byteLength,
-            ).setFloat32(12, 1, true);
+            ).setFloat32(12, options.dither === true ? 1 : 0, true);
             return transformed;
           },
         }

package/src/typed-shadow-passes.ts

@@ -13,7 +13,7 @@ import { createRenderPipelineTarget, type RenderPipelineTarget } from './render-
 import { resolveDirectionalShadowAtlasGrid } from './typed-shadow-atlas';
 
 export interface TypedShadowTargets {
-  readonly directional: RenderPipelineTarget;
+  readonly directional?: RenderPipelineTarget | undefined;
   readonly spot: RenderPipelineTarget;
   readonly point?: RenderPipelineTarget | undefined;
 }
@@ -44,44 +44,50 @@ export function addTypedShadowPasses(
   graph: RenderGraphBuilder<RenderPipelineFrame>,
   topology: RenderPipelineTopology,
 ): Result<TypedShadowTargets, RenderGraphError> {
-  const atlasGrid = resolveDirectionalShadowAtlasGrid(topology.shadow.cascadeCount);
-  const directional = createRenderPipelineTarget(graph, 'directional-shadow-depth', {
-    format: 'depth32float',
-    size: {
-      width: topology.shadow.mapSize * atlasGrid.columns,
-      height: topology.shadow.mapSize * atlasGrid.rows,
-    },
-  });
-  if (!directional.ok) return directional;
-  for (let cascade = 0; cascade < topology.shadow.cascadeCount; cascade += 1) {
-    const col = cascade % atlasGrid.columns;
-    const row = Math.floor(cascade / atlasGrid.columns);
-    const added = recordShadowPass(
-      graph,
-      `shadowCascade${cascade}`,
-      directional.value,
-      cascade === 0 ? 'clear' : 'load',
-      ({ pass, frame }) =>
-        encodeDirectionalShadowPass(frame as never, pass, cascade, {
-          x: col * topology.shadow.mapSize,
-          y: row * topology.shadow.mapSize,
-          w: topology.shadow.mapSize,
-          h: topology.shadow.mapSize,
-        }),
-      (frame) => !(frame as _InternalRenderPipelineContext).directionalShadowCacheReuse,
-    );
-    if (!added.ok) return added;
+  let directional: RenderPipelineTarget | undefined;
+  if (topology.shadow.directional !== 'disabled') {
+    const { mapSize, cascadeCount } = topology.shadow.directional;
+    const atlasGrid = resolveDirectionalShadowAtlasGrid(cascadeCount);
+    const target = createRenderPipelineTarget(graph, 'directional-shadow-depth', {
+      format: 'depth32float',
+      size: {
+        width: mapSize * atlasGrid.columns,
+        height: mapSize * atlasGrid.rows,
+      },
+    });
+    if (!target.ok) return target;
+    const directionalTarget = target.value;
+    directional = directionalTarget;
+    for (let cascade = 0; cascade < cascadeCount; cascade += 1) {
+      const col = cascade % atlasGrid.columns;
+      const row = Math.floor(cascade / atlasGrid.columns);
+      const added = recordShadowPass(
+        graph,
+        `shadowCascade${cascade}`,
+        directionalTarget,
+        cascade === 0 ? 'clear' : 'load',
+        ({ pass, frame }) =>
+          encodeDirectionalShadowPass(frame as never, pass, cascade, {
+            x: col * mapSize,
+            y: row * mapSize,
+            w: mapSize,
+            h: mapSize,
+          }),
+        (frame) => !(frame as _InternalRenderPipelineContext).directionalShadowCacheReuse,
+      );
+      if (!added.ok) return added;
+    }
+    const observation = graph.addCopyPass('directional-shadow-observation', {
+      accesses: [{ resource: directionalTarget.view, usage: 'copy-src' }],
+      encode: ({ frame, resources }) => {
+        const internal = frame as _InternalRenderPipelineContext;
+        const texture = resources.texture(directionalTarget.texture);
+        if (!texture.ok) throw texture.error;
+        internal.pipelineState.perPassResources.shadowTexture = texture.value;
+      },
+    });
+    if (!observation.ok) return observation;
   }
-  const observation = graph.addCopyPass('directional-shadow-observation', {
-    accesses: [{ resource: directional.value.view, usage: 'copy-src' }],
-    encode: ({ frame, resources }) => {
-      const internal = frame as _InternalRenderPipelineContext;
-      const texture = resources.texture(directional.value.texture);
-      if (!texture.ok) throw texture.error;
-      internal.pipelineState.perPassResources.shadowTexture = texture.value;
-    },
-  });
-  if (!observation.ok) return observation;
 
   let point: RenderPipelineTarget | undefined;
   if (topology.shadow.pointCount > 0) {
@@ -148,7 +154,7 @@ export function addTypedShadowPasses(
 
   const spot = createRenderPipelineTarget(graph, 'spot-shadow-depth', {
     format: 'depth32float',
-    size: { width: topology.shadow.mapSize * 2, height: topology.shadow.mapSize * 2 },
+    size: { width: topology.shadow.spotMapSize * 2, height: topology.shadow.spotMapSize * 2 },
   });
   if (!spot.ok) return spot;
   for (let spotIndex = 0; spotIndex < Math.max(1, topology.shadow.spotCount); spotIndex += 1) {
@@ -162,5 +168,5 @@ export function addTypedShadowPasses(
     if (!added.ok) return added;
   }
 
-  return ok({ directional: directional.value, spot: spot.value, point });
+  return ok({ directional, spot: spot.value, point });
 }

package/src/volume/passes.ts

@@ -89,7 +89,7 @@ export interface VolumetricFogPassInputs {
   readonly density: GraphTextureView;
   readonly params: GraphBuffer;
   readonly view: GraphBuffer;
-  readonly directionalShadow: GraphTextureView;
+  readonly directionalShadow?: GraphTextureView;
   readonly spotShadow: GraphTextureView;
   readonly pointLights: GraphBuffer;
   readonly spotLights: GraphBuffer;
@@ -166,7 +166,7 @@ function importVolumeInputs(
   topology: RenderPipelineTopology,
   linearHdr: RenderPipelineTarget,
   sceneDepth: GraphTextureView,
-  directionalShadow: GraphTextureView,
+  directionalShadow: GraphTextureView | undefined,
   spotShadow: GraphTextureView,
   selectedLightKind: 'directional' | 'point' | 'spot' | undefined,
 ): Result<ImportedVolumeInputs | undefined, RenderGraphError> {
@@ -268,7 +268,7 @@ function importVolumeInputs(
     density: density.value,
     params: params.value,
     view: view.value,
-    directionalShadow,
+    ...(directionalShadow === undefined ? {} : { directionalShadow }),
     spotShadow,
     pointLights: pointLights.value,
     spotLights: spotLights.value,
@@ -281,7 +281,7 @@ export function addAuthoredVolumetricFogPasses(
   topology: RenderPipelineTopology,
   linearHdr: RenderPipelineTarget,
   sceneDepth: GraphTextureView,
-  directionalShadow: GraphTextureView,
+  directionalShadow: GraphTextureView | undefined,
   spotShadow: GraphTextureView,
 ): Result<void, RenderGraphError> {
   // A paired Point+Spot volume stores the Spot shadow lane as well. The
@@ -320,6 +320,15 @@ export function addVolumetricFogPasses(
   const packedLayers = Math.ceil(inputs.resources.extent.depth / VOLUME_PACKING_Z);
   const resolvedDispatchX = Math.ceil(inputs.resources.resolvedExtent.width / 8);
   const resolvedDispatchY = Math.ceil(inputs.resources.resolvedExtent.height / 8);
+  // Point-light volume injection has no cube-array shadow sampler. It keeps
+  // the directional cascade count at zero and therefore needs only a valid
+  // 2D depth binding; use the always-present spot target as the inert binding
+  // when directional shadows are disabled. Directional selection still uses
+  // its own target whenever one exists, and spot selection uses spotShadow.
+  const shadowResource =
+    inputs.selectedLightKind === 'spot'
+      ? inputs.spotShadow
+      : (inputs.directionalShadow ?? inputs.spotShadow);
   let inject: ComputeState | undefined;
   let integrate: ComputeState | undefined;
   let temporal: ComputeState | undefined;
@@ -330,8 +339,7 @@ export function addVolumetricFogPasses(
       { resource: inputs.params, usage: 'uniform-read' },
       { resource: inputs.view, usage: 'uniform-read' },
       {
-        resource:
-          inputs.selectedLightKind === 'spot' ? inputs.spotShadow : inputs.directionalShadow,
+        resource: shadowResource,
         usage: 'sampled-read',
       },
       { resource: inputs.spotLights, usage: 'storage-read' },
@@ -359,9 +367,7 @@ export function addVolumetricFogPasses(
         { binding: 7, visibility: 4, buffer: { type: 'read-only-storage' } },
         { binding: 8, visibility: 4, buffer: { type: 'read-only-storage' } },
       ]);
-      const shadow = resources.textureView(
-        inputs.selectedLightKind === 'spot' ? inputs.spotShadow : inputs.directionalShadow,
-      );
+      const shadow = resources.textureView(shadowResource);
       const params = resources.buffer(inputs.params);
       const view = resources.buffer(inputs.view);
       const spotLights = resources.buffer(inputs.spotLights);