@agpu/bindings 0.2.4 → 0.2.6

package/dist/classes/sub/pipeline/computePipeline.d.ts

@@ -1 +1,33 @@
-import{BRAND,RAW}from"@agpu/helpers/decorators";import DC_MEMBER from"../../../helpers/types/DCMember";import PipelineLayoutCreator from"./pipelineLayout";import ShaderModuleCreator from"../data/shaderModule";export interface ComputePipelineCreator extends RAW<Promise<GPUComputePipeline>>,BRAND<"ComputePipelineCreator">{label():Promise<string>;label<T extends string>(label:T):Promise<T>}export declare class ComputePipelineCreator{#private;computePipeline:Promise<GPUComputePipeline>;constructor(device:GPUDevice,sm:COMPUTE_PIPELINE_OPTION|GPUComputePipeline);init():Promise<boolean>;clone():ComputePipelineCreator}export default ComputePipelineCreator;export interface COMPUTE_PIPELINE_OPTION extends GPUObjectDescriptorBase{module:ShaderModuleCreator|DC_MEMBER<"ShaderModule">;async?:boolean;layout:PipelineLayoutCreator}
+import { BRAND, RAW } from "@agpu/helpers/decorators";
+import DC_MEMBER from "../../../helpers/types/DCMember";
+import PipelineLayoutCreator from "./pipelineLayout";
+import ShaderModuleCreator from "../data/shaderModule";
+export interface ComputePipelineCreator extends RAW<Promise<GPUComputePipeline>>, BRAND<"ComputePipelineCreator"> {
+    label(): Promise<string>;
+    label<T extends string>(label: T): Promise<T>;
+}
+/**
+ * Wrapper around {@link GPUComputePipeline}.
+ */
+export declare class ComputePipelineCreator {
+    #private;
+    computePipeline: Promise<GPUComputePipeline>;
+    constructor(device: GPUDevice, sm: COMPUTE_PIPELINE_OPTION | GPUComputePipeline);
+    /**
+     * Resolves once the underlying pipeline has been created.
+     */
+    init(): Promise<boolean>;
+    /**
+     * Recreates the compute pipeline from its original module/layout when available.
+     */
+    clone(): ComputePipelineCreator;
+}
+export default ComputePipelineCreator;
+/**
+ * Options used to create a compute pipeline wrapper.
+ */
+export interface COMPUTE_PIPELINE_OPTION extends GPUObjectDescriptorBase {
+    module: ShaderModuleCreator | DC_MEMBER<"ShaderModule">;
+    async?: boolean;
+    layout: PipelineLayoutCreator;
+}

package/dist/classes/sub/pipeline/pipelineLayout.d.ts

@@ -1 +1,24 @@
-import DeviceControls from"../../main/device";import{BRAND,LABEL,RAW}from"@agpu/helpers/decorators";import BindGroupLayoutCreator from"../data/bindGroupLayout";export interface PipelineLayoutCreator extends RAW<GPUPipelineLayout>,BRAND<"PipelineLayoutCreator">,LABEL{}export declare class PipelineLayoutCreator{#private;pipelineLayout:GPUPipelineLayout;constructor(device:GPUDevice,pipelineLayoutOrOptions:GPUPipelineLayout|PIPELINE_LAYOUT_OPTIONS);clone():PipelineLayoutCreator}export default PipelineLayoutCreator;export interface PIPELINE_LAYOUT_OPTIONS extends GPUObjectDescriptorBase{bindGroupLayouts?:(InstanceType<DeviceControls["BindGroupLayout"]>|BindGroupLayoutCreator)[]}
+import DeviceControls from "../../main/device";
+import { BRAND, LABEL, RAW } from "@agpu/helpers/decorators";
+import BindGroupLayoutCreator from "../data/bindGroupLayout";
+export interface PipelineLayoutCreator extends RAW<GPUPipelineLayout>, BRAND<"PipelineLayoutCreator">, LABEL {
+}
+/**
+ * Wrapper around {@link GPUPipelineLayout}.
+ */
+export declare class PipelineLayoutCreator {
+    #private;
+    pipelineLayout: GPUPipelineLayout;
+    constructor(device: GPUDevice, pipelineLayoutOrOptions: GPUPipelineLayout | PIPELINE_LAYOUT_OPTIONS);
+    /**
+     * Recreates the pipeline layout from its original bind group layouts when available.
+     */
+    clone(): PipelineLayoutCreator;
+}
+export default PipelineLayoutCreator;
+/**
+ * Options used to create a pipeline layout wrapper.
+ */
+export interface PIPELINE_LAYOUT_OPTIONS extends GPUObjectDescriptorBase {
+    bindGroupLayouts?: (InstanceType<DeviceControls["BindGroupLayout"]> | BindGroupLayoutCreator)[];
+}

package/dist/classes/sub/pipeline/querySet.d.ts

@@ -1 +1,24 @@
-import{BRAND,RAW}from"@agpu/helpers/decorators";export interface QuerySetCreator extends RAW<GPUQuerySet>,BRAND<"QuerySetCreator">{label():string;label<T extends string>(label:T):T}export declare class QuerySetCreator{#private;querySet:GPUQuerySet;queryDescriptor:GPUQuerySetDescriptor;constructor(device:GPUDevice,options:GPUQuerySetDescriptor|GPUQuerySet);clone():QuerySetCreator;destroy():boolean;destroy<T extends boolean>(destroy:T):T}export default QuerySetCreator;
+import { BRAND, RAW } from "@agpu/helpers/decorators";
+export interface QuerySetCreator extends RAW<GPUQuerySet>, BRAND<"QuerySetCreator"> {
+    label(): string;
+    label<T extends string>(label: T): T;
+}
+/**
+ * Wrapper around {@link GPUQuerySet}.
+ */
+export declare class QuerySetCreator {
+    #private;
+    querySet: GPUQuerySet;
+    queryDescriptor: GPUQuerySetDescriptor;
+    constructor(device: GPUDevice, options: GPUQuerySetDescriptor | GPUQuerySet);
+    /**
+     * Creates a new query set wrapper from the cached descriptor.
+     */
+    clone(): QuerySetCreator;
+    /**
+     * Getter / Setter for destroying the QuerySet
+     */
+    destroy(): boolean;
+    destroy<T extends boolean>(destroy: T): T;
+}
+export default QuerySetCreator;

package/dist/classes/sub/pipeline/renderBundleEncoder/renderBundle.d.ts

@@ -1 +1,11 @@
-import{BRAND,LABEL,RAW}from"@agpu/helpers/decorators";export interface RenderBundleCreator extends RAW<GPURenderBundle>,BRAND<"RenderBundleCreator">,LABEL{}export declare class RenderBundleCreator{renderBundle:GPURenderBundle;constructor(renbun:GPURenderBundle)}export default RenderBundleCreator;
+import { BRAND, LABEL, RAW } from "@agpu/helpers/decorators";
+export interface RenderBundleCreator extends RAW<GPURenderBundle>, BRAND<"RenderBundleCreator">, LABEL {
+}
+/**
+ * Wrapper around a finished {@link GPURenderBundle}.
+ */
+export declare class RenderBundleCreator {
+    renderBundle: GPURenderBundle;
+    constructor(renbun: GPURenderBundle);
+}
+export default RenderBundleCreator;

package/dist/classes/sub/pipeline/renderBundleEncoder.d.ts

@@ -1 +1,17 @@
-import{BRAND,LABEL,RAW}from"@agpu/helpers/decorators";import RenderEncoderBase from"./commandEncoder/renderEncoderBase";export interface RenderBundleEncoderCreator extends RAW<GPURenderBundleEncoder>,BRAND<"RenderBundleEncoderCreator">,LABEL{}export declare class RenderBundleEncoderCreator extends RenderEncoderBase<GPURenderBundleEncoder>{constructor(device:GPUDevice,renBun:GPURenderBundleEncoder);finish({label}?:{label?:string}):void}export default RenderBundleEncoderCreator;
+import { BRAND, LABEL, RAW } from "@agpu/helpers/decorators";
+import RenderEncoderBase from "./commandEncoder/renderEncoderBase";
+export interface RenderBundleEncoderCreator extends RAW<GPURenderBundleEncoder>, BRAND<"RenderBundleEncoderCreator">, LABEL {
+}
+/**
+ * Wrapper around {@link GPURenderBundleEncoder}.
+ */
+export declare class RenderBundleEncoderCreator extends RenderEncoderBase<GPURenderBundleEncoder> {
+    constructor(device: GPUDevice, renBun: GPURenderBundleEncoder);
+    /**
+     * Finishes recording and returns a wrapped render bundle.
+     */
+    finish({ label }?: {
+        label?: string;
+    }): void;
+}
+export default RenderBundleEncoderCreator;

package/dist/classes/sub/pipeline/renderPipeline.d.ts

@@ -1 +1,112 @@
-import{BRAND,RAW}from"@agpu/helpers/decorators";import UNSURE from"@agpu/helpers/unsure";import DeviceControls from"../../main/device";import BindGroupLayoutCreator from"../data/bindGroupLayout";import ShaderModuleCreator from"../data/shaderModule";import PipelineLayoutCreator from"./pipelineLayout";export interface RenderPipelineCreator extends RAW<Promise<GPURenderPipeline>>,BRAND<"RenderPipelineCreator">{label():Promise<UNSURE<string>>;label<T extends string>(label:T):Promise<T>}export declare class RenderPipelineCreator{#private;pipeline:Promise<GPURenderPipeline>;constructor(device:GPUDevice,optionsOrPipeline:RENDER_PIPELINE_OPTIONS|GPURenderPipeline);init():Promise<unknown>;bindGroupLayout:(index:number)=>Promise<{"__#private@#device"?:GPUDevice;"__#private@#descriptor"?:GPUBindGroupLayoutDescriptor;readonly bindGroupLayout:GPUBindGroupLayout;clone():BindGroupLayoutCreator;raw():GPUBindGroupLayout;readonly __brand:"BindGroupLayoutCreator";[Symbol.hasInstance](instance:any):boolean;label():string;label<T extends string>(val:T):T}>;clone():RenderPipelineCreator}export interface RENDER_PIPELINE_OPTIONS extends GPUObjectDescriptorBase{vertex:VERTEX_STATE;primitive?:GPUPrimitiveState;depthStencil?:DEPTH_STENCIL;multisample?:GPUMultisampleState;fragment?:FRAGMENT_STATE;layout:InstanceType<DeviceControls["PipelineLayout"]>|PipelineLayoutCreator|GPUAutoLayoutMode;async?:boolean}export interface DEPTH_STENCIL{format:GPUTextureFormat;depth?:{write?:boolean;compare?:GPUCompareFunction};stencil?:{front?:STENCIL_FACE_STATE;back?:STENCIL_FACE_STATE;mask?:{read?:GPUStencilValue;write?:GPUStencilValue}};depthBias?:{value?:GPUDepthBias;slopeScale?:number;clamp?:number}}export interface STENCIL_FACE_STATE{compare?:GPUCompareFunction;operation?:{fail?:GPUStencilOperation;depthFail?:GPUStencilOperation;pass?:GPUStencilOperation}}export interface VERTEX_STATE extends PROGRAMMABLE_STAGE{buffers?:Iterable<UNSURE<GPUVertexBufferLayout>>}export interface PROGRAMMABLE_STAGE{module:InstanceType<DeviceControls["ShaderModule"]>|ShaderModuleCreator}export interface FRAGMENT_STATE extends PROGRAMMABLE_STAGE{targets:Iterable<GPUColorTargetState>}export default RenderPipelineCreator;
+import { BRAND, RAW } from "@agpu/helpers/decorators";
+import UNSURE from "@agpu/helpers/unsure";
+import DeviceControls from "../../main/device";
+import BindGroupLayoutCreator from "../data/bindGroupLayout";
+import ShaderModuleCreator from "../data/shaderModule";
+import PipelineLayoutCreator from "./pipelineLayout";
+export interface RenderPipelineCreator extends RAW<Promise<GPURenderPipeline>>, BRAND<"RenderPipelineCreator"> {
+    label(): Promise<UNSURE<string>>;
+    label<T extends string>(label: T): Promise<T>;
+}
+/**
+ * Wrapper around {@link GPURenderPipeline}.
+ */
+export declare class RenderPipelineCreator {
+    #private;
+    pipeline: Promise<GPURenderPipeline>;
+    constructor(device: GPUDevice, optionsOrPipeline: RENDER_PIPELINE_OPTIONS | GPURenderPipeline);
+    /**
+     * Wait for the pipeline to resolve/reject
+     */
+    init(): Promise<unknown>;
+    /**
+     * Represents {@link GPUPipelineBase.getBindGroupLayout}
+     */
+    bindGroupLayout: (index: number) => Promise<{
+        "__#private@#device"?: GPUDevice;
+        "__#private@#descriptor"?: GPUBindGroupLayoutDescriptor;
+        readonly bindGroupLayout: GPUBindGroupLayout;
+        clone(): BindGroupLayoutCreator;
+        raw(): GPUBindGroupLayout;
+        readonly __brand: "BindGroupLayoutCreator";
+        [Symbol.hasInstance](instance: any): boolean;
+        label(): string;
+        label<T extends string>(val: T): T;
+    }>;
+    /**
+     * Recreates the render pipeline from its original descriptor when available.
+     */
+    clone(): RenderPipelineCreator;
+}
+export interface RENDER_PIPELINE_OPTIONS extends GPUObjectDescriptorBase {
+    /** {@link GPURenderPipelineDescriptor.vertex} */
+    vertex: VERTEX_STATE;
+    /** {@link GPURenderPipelineDescriptor.primitive} */
+    primitive?: GPUPrimitiveState;
+    /** {@link GPURenderPipelineDescriptor.depthStencil} */
+    depthStencil?: DEPTH_STENCIL;
+    /** {@link GPURenderPipelineDescriptor.multisample} */
+    multisample?: GPUMultisampleState;
+    /** {@link GPURenderPipelineDescriptor.fragment} */
+    fragment?: FRAGMENT_STATE;
+    /**{@link GPUPipelineDescriptorBase.layout} */
+    layout: InstanceType<DeviceControls["PipelineLayout"]> | PipelineLayoutCreator | GPUAutoLayoutMode;
+    /**Whether to create the pipeline async */
+    async?: boolean;
+}
+/**
+ * Depth/stencil configuration used when creating render pipelines.
+ */
+export interface DEPTH_STENCIL {
+    format: GPUTextureFormat;
+    depth?: {
+        write?: boolean;
+        compare?: GPUCompareFunction;
+    };
+    stencil?: {
+        front?: STENCIL_FACE_STATE;
+        back?: STENCIL_FACE_STATE;
+        mask?: {
+            read?: GPUStencilValue;
+            write?: GPUStencilValue;
+        };
+    };
+    depthBias?: {
+        value?: GPUDepthBias;
+        slopeScale?: number;
+        clamp?: number;
+    };
+}
+/**
+ * Stencil-face state used by {@link DEPTH_STENCIL}.
+ */
+export interface STENCIL_FACE_STATE {
+    compare?: GPUCompareFunction;
+    operation?: {
+        fail?: GPUStencilOperation;
+        depthFail?: GPUStencilOperation;
+        pass?: GPUStencilOperation;
+    };
+}
+/**
+ * Vertex stage configuration used by {@link RENDER_PIPELINE_OPTIONS}.
+ */
+export interface VERTEX_STATE extends PROGRAMMABLE_STAGE {
+    /**{@link GPUVertexState.buffers} */
+    buffers?: Iterable<UNSURE<GPUVertexBufferLayout>>;
+}
+/**
+ * Shared programmable stage configuration.
+ */
+export interface PROGRAMMABLE_STAGE {
+    /**{@link DeviceControls.ShaderModule} */
+    module: InstanceType<DeviceControls["ShaderModule"]> | ShaderModuleCreator;
+}
+/**
+ * Fragment stage configuration used by {@link RENDER_PIPELINE_OPTIONS}.
+ */
+export interface FRAGMENT_STATE extends PROGRAMMABLE_STAGE {
+    /**{@link GPUFragmentState.targets} */
+    targets: Iterable<GPUColorTargetState>;
+}
+export default RenderPipelineCreator;

package/dist/classes/sub/pipeline/sampler.d.ts

@@ -1 +1,16 @@
-import{BRAND,LABEL,RAW}from"@agpu/helpers/decorators";export interface SamplerCreator extends RAW<GPUSampler>,BRAND<"SamplerCreator">,LABEL{}export declare class SamplerCreator{#private;sampler:GPUSampler;constructor(device:GPUDevice,optionsOrSampler:GPUSamplerDescriptor|GPUSampler);clone():SamplerCreator}export default SamplerCreator;
+import { BRAND, LABEL, RAW } from "@agpu/helpers/decorators";
+export interface SamplerCreator extends RAW<GPUSampler>, BRAND<"SamplerCreator">, LABEL {
+}
+/**
+ * Wrapper around {@link GPUSampler}.
+ */
+export declare class SamplerCreator {
+    #private;
+    sampler: GPUSampler;
+    constructor(device: GPUDevice, optionsOrSampler: GPUSamplerDescriptor | GPUSampler);
+    /**
+     * Recreates the sampler from its original descriptor when available.
+     */
+    clone(): SamplerCreator;
+}
+export default SamplerCreator;

package/dist/constants/bufferusage.d.ts

@@ -1 +1,5 @@
-declare const BufferUsage:GPUBufferUsage;export default BufferUsage;
+/**
+ * Re-export of the native `GPUBufferUsage` enum-like object.
+ */
+declare const BufferUsage: GPUBufferUsage;
+export default BufferUsage;

package/dist/constants/textureusage.d.ts

@@ -1 +1,5 @@
-declare const TextureUsage:GPUTextureUsage;export default TextureUsage;
+/**
+ * Re-export of the native `GPUTextureUsage` enum-like object.
+ */
+declare const TextureUsage: GPUTextureUsage;
+export default TextureUsage;

package/dist/helpers/align.d.ts

@@ -1 +1,5 @@
-export declare const align:(n:number,alignment:number)=>number;export default align;
+/**
+ * Rounds `n` up to the next multiple of `alignment`.
+ */
+export declare const align: (n: number, alignment: number) => number;
+export default align;

package/dist/helpers/defaults.d.ts

@@ -1 +1,8 @@
-declare const defaults:{bufferUsage:number;textureUsage:number};export default defaults;
+/**
+ * Default usage flags used when explicit options are omitted.
+ */
+declare const defaults: {
+    bufferUsage: number;
+    textureUsage: number;
+};
+export default defaults;

package/dist/helpers/errors.d.ts

@@ -1 +1,5 @@
-import{AndromedaError}from"@agpu/helpers/errors";export default function error(code:number,message:string,hint?:string):AndromedaError;
+import { AndromedaError } from "@agpu/helpers/errors";
+/**
+ * Creates an {@link AndromedaError} with a standardized message format.
+ */
+export default function error(code: number, message: string, hint?: string): AndromedaError;

package/dist/helpers/shaderRegex.d.ts

@@ -1 +1,4 @@
-export default function getBindGroups(code:string):Set<Readonly<number>>;
+/**
+ * Extracts bind-group indices referenced by WGSL source.
+ */
+export default function getBindGroups(code: string): Set<Readonly<number>>;

package/dist/helpers/types/DCMember.d.ts

@@ -1 +1,9 @@
-import DeviceControls from"../../classes/main/device";type CLASS_KEYS<T>={[K in keyof T]:T[K]extends abstract new(...args:any)=>any?K:never}[keyof T];type DC_MEMBER<K extends CLASS_KEYS<DeviceControls>>=DeviceControls[K]extends abstract new(...args:any)=>infer R?R:never;export default DC_MEMBER;
+import DeviceControls from "../../classes/main/device";
+type CLASS_KEYS<T> = {
+    [K in keyof T]: T[K] extends abstract new (...args: any) => any ? K : never;
+}[keyof T];
+/**
+ * Resolves a `DeviceControls` constructor key to the corresponding instance type.
+ */
+type DC_MEMBER<K extends CLASS_KEYS<DeviceControls>> = DeviceControls[K] extends abstract new (...args: any) => infer R ? R : never;
+export default DC_MEMBER;

package/dist/index.d.ts

@@ -1 +1,9 @@
-import BufferUsage from"./constants/bufferusage";import TextureUsage from"./constants/textureusage";import WebGPUControls from"./classes/main/webgpucontrols";export{WebGPUControls,BufferUsage,TextureUsage};
+/**
+ * **@andromeda-gpu/bindings**
+ * @packageDocumentation
+ * The main bindings package for andromeda-3d's webgpu support
+ */
+import BufferUsage from "./constants/bufferusage";
+import TextureUsage from "./constants/textureusage";
+import WebGPUControls from "./classes/main/webgpucontrols";
+export { WebGPUControls, BufferUsage, TextureUsage };

package/package.json

@@ -16,7 +16,7 @@
     "@webgpu/types": "^0.1.69"
   },
   "name": "@agpu/bindings",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "author": {
     "name": "Kryft Studios",
     "email": "AfriaStudios@outlook.in",