@plasius/gpu-renderer 0.1.15 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasius/gpu-renderer",
-  "version": "0.1.15",
+  "version": "0.2.1",
   "description": "Framework-agnostic WebGPU renderer runtime for Plasius projects.",
   "type": "module",
   "sideEffects": false,
@@ -49,6 +49,7 @@
   "author": "Plasius LTD <development@plasius.co.uk>",
   "license": "Apache-2.0",
   "dependencies": {
+    "@plasius/gpu-shared": "^0.1.11",
     "@plasius/gpu-xr": "^0.1.11"
   },
   "devDependencies": {

package/src/index.d.ts

@@ -162,6 +162,69 @@ export interface WavefrontMeshAcceleration {
   readonly triangles: readonly WavefrontTriangleRecord[];
 }
 
+export interface WavefrontReferenceRay {
+  readonly rayId: number;
+  readonly parentRayId: number;
+  readonly sourcePixelId: number;
+  readonly sampleId: number;
+  readonly bounce: number;
+  readonly mediumRefId: number;
+  readonly flags: number;
+  readonly origin: readonly [number, number, number] | readonly number[];
+  readonly direction: readonly [number, number, number] | readonly number[];
+  readonly throughput: readonly [number, number, number, number] | readonly number[];
+  readonly pixelX: number;
+  readonly pixelY: number;
+}
+
+export interface WavefrontReferenceTile {
+  readonly x?: number;
+  readonly y?: number;
+  readonly width?: number;
+  readonly height?: number;
+}
+
+export interface CreateWavefrontReferenceRayOptions {
+  readonly tile?: WavefrontReferenceTile;
+  readonly pixelIndex?: number;
+  readonly sampleIndex?: number;
+  readonly frameIndex?: number;
+  readonly jitterScale?: number;
+}
+
+export interface WavefrontReferenceHit {
+  readonly hitType: "surface" | "environment";
+  readonly rayId: number;
+  readonly sourcePixelId: number;
+  readonly distance: number;
+  readonly entityId: number;
+  readonly instanceId: number;
+  readonly primitiveId: number;
+  readonly materialId: number;
+  readonly materialRefId: number;
+  readonly mediumRefId: number;
+  readonly barycentrics: readonly [number, number, number] | readonly number[];
+  readonly uv: readonly [number, number] | readonly number[];
+  readonly geometricNormal: readonly [number, number, number] | readonly number[];
+  readonly shadingNormal: readonly [number, number, number] | readonly number[];
+  readonly frontFace: boolean;
+  readonly triangleIndex: number;
+  readonly triangleId: number;
+  readonly position: readonly [number, number, number] | readonly number[];
+  readonly color: readonly number[];
+  readonly emission: readonly number[];
+  readonly material: readonly number[];
+}
+
+export interface IntersectWavefrontReferenceTriangleOptions {
+  readonly maxDistance?: number;
+  readonly triangleIndex?: number;
+}
+
+export interface TraceWavefrontReferenceTrianglesOptions {
+  readonly maxDistance?: number;
+}
+
 export type WavefrontAccelerationBuildMode = "gpu" | "cpu-debug";
 
 export interface WavefrontGpuMeshSource {
@@ -246,6 +309,7 @@ export interface WavefrontEnvironmentPortalRecord {
 }
 
 export interface WavefrontPathTracingComputeConfig {
+  readonly mode: typeof rendererWavefrontComputeMode;
   readonly width: number;
   readonly height: number;
   readonly maxDepth: number;
@@ -331,6 +395,7 @@ export interface WavefrontPathTracingMemoryEstimate {
   readonly environmentPortalBytes: number;
   readonly configBytes: number;
   readonly counterBytes: number;
+  readonly indirectDispatchBytes: number;
   readonly totalHotBufferBytes: number;
 }
 
@@ -378,32 +443,12 @@ export interface WavefrontPathTracingComputeRenderer {
   readonly device: GPUDevice;
   readonly format: GPUTextureFormat | string;
   readonly config: WavefrontPathTracingComputeConfig;
-  renderOnce(): Readonly<{
-    frame: number;
-    width: number;
-    height: number;
-    maxDepth: number;
-    tiles: number;
-    tileSize: number;
-    samplesPerPixel: number;
-    screenRays: number;
-    primaryRays: number;
-    sceneObjectCount: number;
-    triangleCount: number;
-    emissiveTriangleCount: number;
-    environmentPortalCount: number;
-    environmentPortalMode: 0 | 1 | 2;
-    bvhNodeCount: number;
-    displayQuality: boolean;
-    accelerationBuildMode: WavefrontAccelerationBuildMode;
-    gpuAccelerationBuildRequired: boolean;
-    accelerationBuildSubmitted: boolean;
-    accelerationBuilt: boolean;
-    accelerationBuildCount: number;
-    commandSubmissions: number;
-    frameConfigSlots: number;
-    memory: WavefrontPathTracingMemoryEstimate;
-  }>;
+  renderOnce(): WavefrontPathTracingComputeFrameStats;
+  renderFrame(options?: {
+    readStats?: boolean;
+    readOutputProbe?: boolean;
+    probe?: { x?: number; y?: number };
+  }): Promise<WavefrontPathTracingComputeFrameStats>;
   readOutputProbe(options?: { x?: number; y?: number }): Promise<
     Readonly<{
       x: number;
@@ -438,6 +483,50 @@ export interface WavefrontPathTracingComputeRenderer {
   destroy(): void;
 }
 
+export interface WavefrontPathTracingComputeFrameStats {
+  readonly frame: number;
+  readonly width: number;
+  readonly height: number;
+  readonly maxDepth: number;
+  readonly tiles: number;
+  readonly tileSize: number;
+  readonly samplesPerPixel: number;
+  readonly screenRays: number;
+  readonly primaryRays: number;
+  readonly sceneObjectCount: number;
+  readonly triangleCount: number;
+  readonly emissiveTriangleCount: number;
+  readonly environmentPortalCount: number;
+  readonly environmentPortalMode: 0 | 1 | 2;
+  readonly bvhNodeCount: number;
+  readonly displayQuality: boolean;
+  readonly accelerationBuildMode: WavefrontAccelerationBuildMode;
+  readonly gpuAccelerationBuildRequired: boolean;
+  readonly accelerationBuildSubmitted: boolean;
+  readonly accelerationBuilt: boolean;
+  readonly accelerationBuildCount: number;
+  readonly commandSubmissions: number;
+  readonly frameConfigSlots: number;
+  readonly memory: WavefrontPathTracingMemoryEstimate;
+  readonly outputProbe?: Readonly<{
+    x: number;
+    y: number;
+    rgba: readonly number[];
+    luminance: number;
+    sampledPixels: number;
+    nonZeroSamples: number;
+    maxChannel: number;
+  }> | null;
+  readonly bounces?: readonly unknown[];
+  readonly termination?: Readonly<{
+    emissive: number;
+    environment: number;
+    ambientFallback: number;
+    maxDepth: number;
+  }>;
+  readonly queueOverflow?: number;
+}
+
 export function normalizeWavefrontSceneObject(
   input?: WavefrontSceneObjectInput,
   index?: number
@@ -490,6 +579,21 @@ export function createWavefrontBvhSortStages(
 export function createWavefrontPathTracingComputeConfig(
   options?: CreateWavefrontPathTracingComputeRendererOptions
 ): WavefrontPathTracingComputeConfig;
+export function createWavefrontReferenceRay(
+  config: WavefrontPathTracingComputeConfig,
+  options?: CreateWavefrontReferenceRayOptions
+): WavefrontReferenceRay;
+export function intersectWavefrontReferenceTriangle(
+  ray: WavefrontReferenceRay,
+  triangle: WavefrontTriangleRecord,
+  options?: IntersectWavefrontReferenceTriangleOptions
+): WavefrontReferenceHit | null;
+export function traceWavefrontReferenceTriangles(
+  config: WavefrontPathTracingComputeConfig,
+  ray: WavefrontReferenceRay,
+  triangles: readonly WavefrontTriangleRecord[],
+  options?: TraceWavefrontReferenceTrianglesOptions
+): WavefrontReferenceHit;
 export function packWavefrontSceneObjects(
   sceneObjects: readonly WavefrontSceneObjectInput[],
   capacity?: number
@@ -523,6 +627,20 @@ export function supportsWavefrontPathTracingCompute(options?: {
 export function createWavefrontPathTracingComputeRenderer(
   options?: CreateWavefrontPathTracingComputeRendererOptions
 ): Promise<WavefrontPathTracingComputeRenderer>;
+export function renderWavefrontPathTracingComputeFrame(
+  options?: CreateWavefrontPathTracingComputeRendererOptions & {
+    readStats?: boolean;
+    readOutputProbe?: boolean;
+  }
+): Promise<WavefrontPathTracingComputeFrameStats>;
+export function createWavefrontPathTracingComputeShaderSource(options?: {
+  workgroupSize?: number;
+  outputTextureFormat?: GPUTextureFormat | "rgba8unorm";
+}): string;
+
+export const rendererWavefrontComputeMode: "webgpu-compute";
+export const rendererWavefrontComputeWorkgroupSize: 64;
+export const rendererWavefrontComputeStatsStride: 8;
 
 export const wavefrontPathTracingComputeLimits: Readonly<{
   workgroupSize: 64;
@@ -538,6 +656,8 @@ export const wavefrontPathTracingComputeLimits: Readonly<{
   emissiveTriangleMetadataRecordBytes: 48;
   environmentPortalRecordBytes: 96;
   accumulationRecordBytes: 16;
+  counterRecordBytes: 32;
+  indirectDispatchRecordBytes: 12;
 }>;
 export const wavefrontSceneObjectKinds: Readonly<{
   sphere: 1;

package/src/index.js

@@ -9,13 +9,21 @@ export {
   createWavefrontMeshAcceleration,
   createWavefrontPathTracingComputeConfig,
   createWavefrontPathTracingComputeRenderer,
+  createWavefrontPathTracingComputeShaderSource,
+  createWavefrontReferenceRay,
   estimateWavefrontPathTracingMemory,
+  intersectWavefrontReferenceTriangle,
   normalizeWavefrontMesh,
   normalizeWavefrontSceneObject,
   packWavefrontBvhNodes,
   packWavefrontSceneObjects,
   packWavefrontTriangles,
+  renderWavefrontPathTracingComputeFrame,
+  rendererWavefrontComputeMode,
+  rendererWavefrontComputeStatsStride,
+  rendererWavefrontComputeWorkgroupSize,
   supportsWavefrontPathTracingCompute,
+  traceWavefrontReferenceTriangles,
   wavefrontMaterialKinds,
   wavefrontPathTracingComputeLimits,
   wavefrontSceneObjectKinds,