@plasius/gpu-renderer 0.1.14 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasius/gpu-renderer",
-  "version": "0.1.14",
+  "version": "0.2.0",
   "description": "Framework-agnostic WebGPU renderer runtime for Plasius projects.",
   "type": "module",
   "sideEffects": false,

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 {
@@ -209,6 +272,42 @@ export interface WavefrontEmissiveTriangleIndexSource {
   readonly recordBytes: 4;
 }
 
+export type WavefrontEnvironmentPortalMode =
+  | 0
+  | 1
+  | 2
+  | "disabled"
+  | "guide"
+  | "guide-and-gate"
+  | "gate";
+
+export interface WavefrontEnvironmentPortalInput {
+  readonly kind?: "rectangle";
+  readonly shape?: "rectangle";
+  readonly position?: readonly [number, number, number] | readonly number[];
+  readonly center?: readonly [number, number, number] | readonly number[];
+  readonly normal?: readonly [number, number, number] | readonly number[];
+  readonly tangent?: readonly [number, number, number] | readonly number[];
+  readonly width?: number;
+  readonly height?: number;
+  readonly halfWidth?: number;
+  readonly halfHeight?: number;
+  readonly radianceScale?: number;
+  readonly intensity?: number;
+  readonly color?: readonly [number, number, number, number?] | readonly number[];
+  readonly twoSided?: boolean;
+}
+
+export interface WavefrontEnvironmentPortalRecord {
+  readonly kind: 1;
+  readonly flags: number;
+  readonly position: readonly [number, number, number, number] | readonly number[];
+  readonly normal: readonly [number, number, number, number] | readonly number[];
+  readonly tangent: readonly [number, number, number, number] | readonly number[];
+  readonly bitangent: readonly [number, number, number, number] | readonly number[];
+  readonly color: readonly [number, number, number, number] | readonly number[];
+}
+
 export interface WavefrontPathTracingComputeConfig {
   readonly width: number;
   readonly height: number;
@@ -226,6 +325,10 @@ export interface WavefrontPathTracingComputeConfig {
   readonly emissiveTriangleIndices: WavefrontEmissiveTriangleIndexSource;
   readonly emissiveTriangleCount: number;
   readonly emissiveTriangleCapacity: number;
+  readonly environmentPortals: readonly WavefrontEnvironmentPortalRecord[];
+  readonly environmentPortalCount: number;
+  readonly environmentPortalCapacity: number;
+  readonly environmentPortalMode: 0 | 1 | 2;
   readonly triangleCount: number;
   readonly triangleCapacity: number;
   readonly bvhNodeCount: number;
@@ -262,6 +365,8 @@ export interface WavefrontEnvironmentLightingInput {
   readonly intensity?: number;
   readonly mode?: number;
   readonly exposure?: number;
+  readonly environmentPortals?: readonly WavefrontEnvironmentPortalInput[];
+  readonly environmentPortalMode?: WavefrontEnvironmentPortalMode;
 }
 
 export interface WavefrontEnvironmentLightingConfig {
@@ -286,6 +391,7 @@ export interface WavefrontPathTracingMemoryEstimate {
   readonly bvhNodeBytes: number;
   readonly bvhLeafReferenceBytes: number;
   readonly emissiveTriangleMetadataBytes: number;
+  readonly environmentPortalBytes: number;
   readonly configBytes: number;
   readonly counterBytes: number;
   readonly totalHotBufferBytes: number;
@@ -295,6 +401,8 @@ export interface CreateWavefrontPathTracingComputeRendererOptions {
   readonly canvas?: HTMLCanvasElement | string;
   readonly navigator?: Navigator | { gpu?: GPU };
   readonly document?: Document;
+  readonly deviceDescriptor?: GPUDeviceDescriptor;
+  readonly requiredLimits?: Partial<Record<string, number>>;
   readonly powerPreference?: GPUPowerPreference;
   readonly alpha?: boolean;
   readonly format?: GPUTextureFormat;
@@ -312,6 +420,11 @@ export interface CreateWavefrontPathTracingComputeRendererOptions {
   readonly bvhNodeCapacity?: number;
   readonly bvhLeafSortCapacity?: number;
   readonly emissiveTriangleCapacity?: number;
+  readonly environmentPortalCapacity?: number;
+  readonly environmentPortals?: readonly WavefrontEnvironmentPortalInput[];
+  readonly environmentLightPortals?: readonly WavefrontEnvironmentPortalInput[];
+  readonly environmentPortalMode?: WavefrontEnvironmentPortalMode;
+  readonly portalMode?: WavefrontEnvironmentPortalMode;
   readonly accelerationBuildMode?: WavefrontAccelerationBuildMode;
   readonly camera?: WavefrontCameraOptions;
   readonly environmentColor?: readonly [number, number, number, number?] | readonly number[];
@@ -341,10 +454,17 @@ export interface WavefrontPathTracingComputeRenderer {
     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;
   }>;
   readOutputProbe(options?: { x?: number; y?: number }): Promise<
@@ -367,10 +487,15 @@ export interface WavefrontPathTracingComputeRenderer {
     sceneObjectCount: number;
     triangleCount: number;
     emissiveTriangleCount: number;
+    environmentPortalCount: number;
+    environmentPortalMode: 0 | 1 | 2;
     bvhNodeCount: number;
     displayQuality: boolean;
     accelerationBuildMode: WavefrontAccelerationBuildMode;
     gpuAccelerationBuildRequired: boolean;
+    accelerationBuilt: boolean;
+    accelerationBuildCount: number;
+    frameConfigSlots: number;
     memory: WavefrontPathTracingMemoryEstimate;
   }>;
   destroy(): void;
@@ -428,6 +553,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
@@ -465,13 +605,16 @@ export function createWavefrontPathTracingComputeRenderer(
 export const wavefrontPathTracingComputeLimits: Readonly<{
   workgroupSize: 64;
   rayRecordBytes: 80;
-  hitRecordBytes: 192;
+  hitRecordBytes: 208;
   sceneObjectRecordBytes: 96;
   meshVertexRecordBytes: 48;
   meshRangeRecordBytes: 96;
   triangleRecordBytes: 208;
   bvhNodeRecordBytes: 48;
   bvhLeafReferenceRecordBytes: 16;
+  emissiveTriangleIndexBytes: 4;
+  emissiveTriangleMetadataRecordBytes: 48;
+  environmentPortalRecordBytes: 96;
   accumulationRecordBytes: 16;
 }>;
 export const wavefrontSceneObjectKinds: Readonly<{

package/src/index.js

@@ -9,13 +9,16 @@ export {
   createWavefrontMeshAcceleration,
   createWavefrontPathTracingComputeConfig,
   createWavefrontPathTracingComputeRenderer,
+  createWavefrontReferenceRay,
   estimateWavefrontPathTracingMemory,
+  intersectWavefrontReferenceTriangle,
   normalizeWavefrontMesh,
   normalizeWavefrontSceneObject,
   packWavefrontBvhNodes,
   packWavefrontSceneObjects,
   packWavefrontTriangles,
   supportsWavefrontPathTracingCompute,
+  traceWavefrontReferenceTriangles,
   wavefrontMaterialKinds,
   wavefrontPathTracingComputeLimits,
   wavefrontSceneObjectKinds,