@hology/webgpu-renderer 0.1.17 → 0.1.19

package/dist/index.d.ts

@@ -2,18 +2,12 @@ import * as three from 'three';
 import { Color, Vector2, Vector3, Vector4, Matrix3, Matrix4, Material, Texture, MaterialParameters, DirectionalLight, PointLight, SpotLight, Object3D, PerspectiveCamera, OrthographicCamera, BufferGeometry, Scene } from 'three';
 export { AmbientLight, BackSide, BatchedMesh, Bone, BoxGeometry, BufferAttribute, BufferGeometry, CanvasTexture, Color, CompressedArrayTexture, CompressedCubeTexture, CompressedTexture, CompressedArrayTexture as CompressedTextureArray, CubeTexture, Data3DTexture, DataArrayTexture, DataTexture, DepthTexture, DirectionalLight, DoubleSide, FrontSide, Group, HemisphereLight, InstancedMesh, MathUtils, Matrix4, Mesh, Object3D, OrthographicCamera, PerspectiveCamera, PlaneGeometry, PointLight, RepeatWrapping, Scene, Skeleton, SkinnedMesh, SphereGeometry, SpotLight, Texture, Vector2, Vector3, Vector4 } from 'three';
 
-interface ComputeKernelDescriptor {
-    label?: string;
-    code: string;
-    entryPoint?: string;
-    bindGroupLayoutEntries: GPUBindGroupLayoutEntry[];
-}
-declare class ComputeKernel {
-    readonly layout: GPUBindGroupLayout;
-    readonly pipeline: GPUComputePipeline;
-    constructor(device: GPUDevice, descriptor: ComputeKernelDescriptor);
-    createBindGroup(device: GPUDevice, entries: GPUBindGroupEntry[], label?: string): GPUBindGroup;
+interface PipelineDiagnosticOrigin {
+    key: string;
+    [detail: string]: unknown;
 }
+declare function setPipelineDiagnosticLoading(device: GPUDevice, loading: boolean, phase: string): void;
+declare function registerPipelineDiagnosticOrigin(device: GPUDevice, label: string, origin: PipelineDiagnosticOrigin): void;
 
 type ShaderDefineValue = string | number | boolean;
 type ShaderDefines = Record<string, ShaderDefineValue | null | undefined>;
@@ -151,6 +145,31 @@ declare class WGSLShaderMaterial extends Material {
     private invalidateBindingCache;
 }
 
+/**
+ * Lighting and post-processing stay in linear HDR until the present pass.
+ * The canvas format is intentionally kept separate because it is a display
+ * target, not an intermediate scene-color target.
+ */
+declare const SCENE_COLOR_FORMAT: GPUTextureFormat;
+
+declare function createRenderPipelineAsync(device: GPUDevice, descriptor: GPURenderPipelineDescriptor): Promise<GPURenderPipeline>;
+declare function createComputePipelineAsync(device: GPUDevice, descriptor: GPUComputePipelineDescriptor): Promise<GPUComputePipeline>;
+
+interface ComputeKernelDescriptor {
+    label?: string;
+    code: string;
+    entryPoint?: string;
+    bindGroupLayoutEntries: GPUBindGroupLayoutEntry[];
+}
+declare class ComputeKernel {
+    readonly layout: GPUBindGroupLayout;
+    readonly pipeline: GPUComputePipeline;
+    static createAsync(device: GPUDevice, descriptor: ComputeKernelDescriptor): Promise<ComputeKernel>;
+    /** The optional pipeline allows adopting an already compiled kernel. */
+    constructor(device: GPUDevice, descriptor: ComputeKernelDescriptor, pipeline?: GPUComputePipeline);
+    createBindGroup(device: GPUDevice, entries: GPUBindGroupEntry[], label?: string): GPUBindGroup;
+}
+
 interface RenderGraphContext {
     readonly device: GPUDevice;
     readonly encoder: GPUCommandEncoder;
@@ -450,6 +469,8 @@ interface RendererCustomPassContext {
     };
     /** Resolves the current renderer-owned vertex buffer for a geometry. */
     getGeometryVertexBuffer(geometry: BufferGeometry, attribute: "position" | "normal"): GPUBuffer;
+    /** Shared current bone-world * inverse-bind palette; renderer owns its lifetime. */
+    getSkeletonBoneBuffer(skeleton: three.Skeleton): GPUBuffer;
     getColorFormat(name: string): GPUTextureFormat;
     getShadowMapDebugInfo(): RendererShadowMapDebugInfo;
     /** Shared light uniforms and shadow arrays used by the forward renderer. */
@@ -494,6 +515,10 @@ interface RendererFrameProfile {
     triangleCount: number;
     cpuPhases: {
         extractSceneMs: number;
+        /** Included in extractSceneMs; covers key updates, ordering and result consumption. */
+        opaqueSortMs?: number;
+        /** Mean of the last 120 profiled frames, smoothing timer quantization. */
+        opaqueSortAverageMs?: number;
         uploadMs: number;
         renderGraphMs: number;
     };
@@ -545,6 +570,7 @@ interface CompiledNodeFullscreenShader {
     }>): void;
 }
 interface FrameGraphNodeFullscreenPassDescriptor {
+    readonly diagnosticOrigin?: PipelineDiagnosticOrigin;
     readonly name: string;
     readonly shader: CompiledNodeFullscreenShader;
     /** Overrides frame-graph resources for named compiled graph/scene texture bindings. */
@@ -813,6 +839,7 @@ type ToonOutlineParameters = {
     visible?: boolean;
 };
 declare class WebGpuRenderer {
+    private pipelineCompilationDiagnostics?;
     readonly canvas: HTMLCanvasElement;
     private readonly clearColor;
     private readonly powerPreference;
@@ -923,6 +950,7 @@ declare class WebGpuRenderer {
     private readonly vertexAttributeGroupCache;
     private readonly materialVertexAttributeCache;
     private readonly vertexBufferBindingPlanCache;
+    private readonly preparedVertexBufferCache;
     private readonly vertexAttributeGroupBufferKeyCache;
     private readonly compileDrawScratch;
     private readonly dynamicIndirectSubmissionCache;
@@ -1003,6 +1031,16 @@ declare class WebGpuRenderer {
     private createExtractedHemisphereLightScratch;
     private createExtractedPointLightScratch;
     private createExtractedSpotLightScratch;
+    private readonly skinnedDrawKeys;
+    private readonly skeletonPalettes;
+    private readonly getSkeletonBoneBufferForPass;
+    private readonly outlineResolvedFrameCache;
+    private opaqueSortMs;
+    private readonly opaqueSortSamples;
+    private opaqueSortSampleIndex;
+    private opaqueSortSampleCount;
+    private opaqueSortSampleTotal;
+    private sortOpaqueDraws;
     constructor(options: RendererOptions);
     private resolveMaterial;
     private resolveLineMaterial;
@@ -1197,6 +1235,7 @@ declare class WebGpuRenderer {
     private getSkinningPalette;
     private refreshSkinningPalette;
     private refreshSkinningBindMatrices;
+    private uploadSkinningPalette;
     private uploadSkinningResources;
     private createSkinningBoneBounds;
     private updateSkinnedBounds;
@@ -1217,6 +1256,7 @@ declare class WebGpuRenderer {
     private getInterleavedGeometryVertexBuffer;
     private ensureWireframeIndex;
     private bindGeometryVertexBuffers;
+    private prepareGeometryVertexBuffers;
     private getStandardVertexAttribute;
     private prepareDrawGeometryVertexBuffers;
     private getDefaultInstanceAttributeBuffer;
@@ -1725,4 +1765,4 @@ declare class OutlineEffect {
     dispose(): void;
 }
 
-export { type BloomCompositeOptions, BloomEffect, type BloomOptions, ColorGradingEffect, type ColorGradingOptions, type ColorGradingRange, type ColorGradingVector, type CompiledNodeFullscreenShader, ComputeKernel, type ComputeKernelDescriptor, DEFAULT_WGSL_VERTEX_ATTRIBUTES, DepthOfFieldEffect, type DepthOfFieldOptions, type FXAACompositeOptions, FXAAEffect, type FXAAOptions, FrameGraphBuilder, type FrameGraphFullscreenPassDescriptor, type FrameGraphMaterialPassDescriptor, type FrameGraphNodeFullscreenPassDescriptor, type FrameGraphPassDescriptor, type FrameGraphTextureHandle, type GTAOCompositeOptions, type GTAODenoiseOptions, GTAOEffect, type GTAOInputs, type GTAOOptions, type GTAOQuality, type GTAOTemporalOptions, GTAO_PRESETS, MOTION_BLUR_PRESETS, MotionBlurEffect, MotionBlurMode, type MotionBlurOptions, type MotionBlurOverride, type MotionBlurOverrideHandle, type MotionBlurQuality, OutlineEffect, type OutlineInputs, type OutlineInstanceSelection, type OutlineOptions, RenderGraph, type RenderGraphContext, type RenderGraphExecutionObserver, type RenderGraphPass, type RendererColorTargetDescriptor, type RendererCustomPassContext, type RendererCustomPassDescriptor, type RendererFrameProfile, type RendererGraphBuilder, type RendererGraphBuilderContext, type RendererMaterialPassDescriptor, type RendererMaterialResolver, type RendererOptions, type RendererPassProfile, type RendererShadowMapDebugInfo, type RendererShadowMapDebugTextureInfo, type RendererTextureTargetDescriptor, type RendererVisibilityProfile, type SMAACompositeOptions, type SMAAEdgeDetectionMode, SMAAEffect, type SMAAOptions, type SMAAQualityPreset, SSREffect, type SSRInputs, type SSROptions, type ShaderDefineValue, type ShaderDefines, type StaticDrawSet, type StaticDrawSetOptions, TemporalAAEffect, type TemporalAAOptions, type ToneMappingMode, type ToonOutlineParameters, type UniformDefinition, type UniformType, type UniformValue, VOLUMETRIC_FOG_MATERIAL_WGSL, VOLUMETRIC_FOG_PRESETS, type VolumetricFogBlurOptions, VolumetricFogEffect, type VolumetricFogInputs, type VolumetricFogOptions, type VolumetricFogQuality, type VolumetricFogScatteringMode, type VolumetricFogTemporalOptions, VolumetricFogVolumeObject, type VolumetricFogVolumeSettings, type WGSLGraphTextureDimension, type WGSLGraphTextureInput, type WGSLSceneTextureSemantic, WGSLShaderMaterial, type WGSLShaderMaterialParameters, type WGSLShaderMaterialUniform, type WGSLShaderMaterialUniformInput, type WGSLStorageBufferBinding, type WGSLStorageBufferVisibility, type WGSLSupportedVertexFormat, type WGSLVertexAttributeBinding, WebGpuPMREMGenerator, WebGpuRenderer, buildParticleLightingShaderHeader, configureVolumetricFogMaterial };
+export { type BloomCompositeOptions, BloomEffect, type BloomOptions, ColorGradingEffect, type ColorGradingOptions, type ColorGradingRange, type ColorGradingVector, type CompiledNodeFullscreenShader, ComputeKernel, type ComputeKernelDescriptor, DEFAULT_WGSL_VERTEX_ATTRIBUTES, DepthOfFieldEffect, type DepthOfFieldOptions, type FXAACompositeOptions, FXAAEffect, type FXAAOptions, FrameGraphBuilder, type FrameGraphFullscreenPassDescriptor, type FrameGraphMaterialPassDescriptor, type FrameGraphNodeFullscreenPassDescriptor, type FrameGraphPassDescriptor, type FrameGraphTextureHandle, type GTAOCompositeOptions, type GTAODenoiseOptions, GTAOEffect, type GTAOInputs, type GTAOOptions, type GTAOQuality, type GTAOTemporalOptions, GTAO_PRESETS, MOTION_BLUR_PRESETS, MotionBlurEffect, MotionBlurMode, type MotionBlurOptions, type MotionBlurOverride, type MotionBlurOverrideHandle, type MotionBlurQuality, OutlineEffect, type OutlineInputs, type OutlineInstanceSelection, type OutlineOptions, type PipelineDiagnosticOrigin, RenderGraph, type RenderGraphContext, type RenderGraphExecutionObserver, type RenderGraphPass, type RendererColorTargetDescriptor, type RendererCustomPassContext, type RendererCustomPassDescriptor, type RendererFrameProfile, type RendererGraphBuilder, type RendererGraphBuilderContext, type RendererMaterialPassDescriptor, type RendererMaterialResolver, type RendererOptions, type RendererPassProfile, type RendererShadowMapDebugInfo, type RendererShadowMapDebugTextureInfo, type RendererTextureTargetDescriptor, type RendererVisibilityProfile, SCENE_COLOR_FORMAT, type SMAACompositeOptions, type SMAAEdgeDetectionMode, SMAAEffect, type SMAAOptions, type SMAAQualityPreset, SSREffect, type SSRInputs, type SSROptions, type ShaderDefineValue, type ShaderDefines, type StaticDrawSet, type StaticDrawSetOptions, TemporalAAEffect, type TemporalAAOptions, type ToneMappingMode, type ToonOutlineParameters, type UniformDefinition, type UniformType, type UniformValue, VOLUMETRIC_FOG_MATERIAL_WGSL, VOLUMETRIC_FOG_PRESETS, type VolumetricFogBlurOptions, VolumetricFogEffect, type VolumetricFogInputs, type VolumetricFogOptions, type VolumetricFogQuality, type VolumetricFogScatteringMode, type VolumetricFogTemporalOptions, VolumetricFogVolumeObject, type VolumetricFogVolumeSettings, type WGSLGraphTextureDimension, type WGSLGraphTextureInput, type WGSLSceneTextureSemantic, WGSLShaderMaterial, type WGSLShaderMaterialParameters, type WGSLShaderMaterialUniform, type WGSLShaderMaterialUniformInput, type WGSLStorageBufferBinding, type WGSLStorageBufferVisibility, type WGSLSupportedVertexFormat, type WGSLVertexAttributeBinding, WebGpuPMREMGenerator, WebGpuRenderer, buildParticleLightingShaderHeader, configureVolumetricFogMaterial, createComputePipelineAsync, createRenderPipelineAsync, registerPipelineDiagnosticOrigin, setPipelineDiagnosticLoading };