@simulatte/webgpu 0.2.4 → 0.3.0

package/src/doe.d.ts

@@ -2,15 +2,12 @@ export type DoeBufferUsage =
   | "upload"
   | "readback"
   | "uniform"
-  | "storage-read"
-  | "storage-readwrite";
+  | "storageRead"
+  | "storageReadWrite";
 
-export type DoeWorkgroups = number | [number, number, number];
+export type DoeWorkgroups = number | [number, number] | [number, number, number];
 
-export type DoeBindingAccess =
-  | "uniform"
-  | "storage-read"
-  | "storage-readwrite";
+export type DoeBindingAccess = "uniform" | "storageRead" | "storageReadWrite";
 
 export interface DoeCreateBufferOptions {
   size: number;
@@ -30,11 +27,51 @@ export interface DoeReadBufferOptions {
   label?: string;
 }
 
+export interface DoeCreateBufferLikeOptions extends Omit<
+  DoeCreateBufferOptions,
+  "size"
+> {
+  size?: number;
+}
+
 export interface DoeBindingBuffer<TBuffer> {
   buffer: TBuffer;
   access?: DoeBindingAccess;
 }
 
+export interface DoeComputeInputDataOptions {
+  data: ArrayBufferView | ArrayBuffer;
+  usage?: DoeBufferUsage | DoeBufferUsage[];
+  access?: DoeBindingAccess;
+  label?: string;
+}
+
+export type DoeComputeInput<TBuffer> =
+  | ArrayBufferView
+  | ArrayBuffer
+  | TBuffer
+  | DoeBindingBuffer<TBuffer>
+  | DoeComputeInputDataOptions;
+
+export interface DoeComputeOnceOutputOptions<T extends ArrayBufferView> {
+  type: { new (buffer: ArrayBuffer): T };
+  size?: number;
+  likeInput?: number;
+  usage?: DoeBufferUsage | DoeBufferUsage[];
+  access?: DoeBindingAccess;
+  label?: string;
+  read?: DoeReadBufferOptions;
+}
+
+export interface DoeComputeOnceOptions<TBuffer, T extends ArrayBufferView> {
+  code: string;
+  entryPoint?: string;
+  inputs?: Array<DoeComputeInput<TBuffer>>;
+  output: DoeComputeOnceOutputOptions<T>;
+  workgroups: DoeWorkgroups;
+  label?: string;
+}
+
 export interface DoeRunComputeOptions<TBuffer> {
   code: string;
   entryPoint?: string;
@@ -49,36 +86,99 @@ export interface DoeKernelDispatchOptions<TBuffer> {
   label?: string;
 }
 
-export interface BoundDoeNamespace<TDevice, TBuffer, TKernel, TRunComputeOptions> {
-  readonly device: TDevice;
-  createBuffer(options: DoeCreateBufferOptions): TBuffer;
-  createBufferFromData<T extends ArrayBufferView>(
+export interface BoundDoeBuffersNamespace<TBuffer> {
+  create(options: DoeCreateBufferOptions): TBuffer;
+  fromData<T extends ArrayBufferView>(
     data: T | ArrayBuffer,
-    options?: DoeCreateBufferFromDataOptions
+    options?: DoeCreateBufferFromDataOptions,
+  ): TBuffer;
+  like(
+    source: TBuffer | ArrayBufferView | ArrayBuffer,
+    options?: DoeCreateBufferLikeOptions,
   ): TBuffer;
-  readBuffer<T extends ArrayBufferView>(
+  read<T extends ArrayBufferView>(
     buffer: TBuffer,
-    type: { new(buffer: ArrayBuffer): T },
-    options?: DoeReadBufferOptions
+    type: { new (buffer: ArrayBuffer): T },
+    options?: DoeReadBufferOptions,
   ): Promise<T>;
-  runCompute(options: TRunComputeOptions): Promise<void>;
-  compileCompute(options: TRunComputeOptions): TKernel;
 }
 
-export interface DoeNamespace<TDevice, TBuffer, TKernel, TBoundDoe, TRunComputeOptions> {
-  bind(device: TDevice): TBoundDoe;
-  createBuffer(device: TDevice, options: DoeCreateBufferOptions): TBuffer;
-  createBufferFromData<T extends ArrayBufferView>(
+export interface DoeBuffersNamespace<TDevice, TBuffer> {
+  create(device: TDevice, options: DoeCreateBufferOptions): TBuffer;
+  fromData<T extends ArrayBufferView>(
     device: TDevice,
     data: T | ArrayBuffer,
-    options?: DoeCreateBufferFromDataOptions
+    options?: DoeCreateBufferFromDataOptions,
+  ): TBuffer;
+  like(
+    device: TDevice,
+    source: TBuffer | ArrayBufferView | ArrayBuffer,
+    options?: DoeCreateBufferLikeOptions,
   ): TBuffer;
-  readBuffer<T extends ArrayBufferView>(
+  read<T extends ArrayBufferView>(
     device: TDevice,
     buffer: TBuffer,
-    type: { new(buffer: ArrayBuffer): T },
-    options?: DoeReadBufferOptions
+    type: { new (buffer: ArrayBuffer): T },
+    options?: DoeReadBufferOptions,
   ): Promise<T>;
-  runCompute(device: TDevice, options: TRunComputeOptions): Promise<void>;
-  compileCompute(device: TDevice, options: TRunComputeOptions): TKernel;
+}
+
+export interface BoundDoeComputeNamespace<
+  TBuffer,
+  TKernel,
+  TRunComputeOptions,
+> {
+  run(options: TRunComputeOptions): Promise<void>;
+  compile(options: TRunComputeOptions): TKernel;
+  once<T extends ArrayBufferView>(
+    options: DoeComputeOnceOptions<TBuffer, T>,
+  ): Promise<T>;
+}
+
+export interface DoeComputeNamespace<
+  TDevice,
+  TBuffer,
+  TKernel,
+  TRunComputeOptions,
+> {
+  run(device: TDevice, options: TRunComputeOptions): Promise<void>;
+  compile(device: TDevice, options: TRunComputeOptions): TKernel;
+  once<T extends ArrayBufferView>(
+    device: TDevice,
+    options: DoeComputeOnceOptions<TBuffer, T>,
+  ): Promise<T>;
+}
+
+export interface BoundDoeNamespace<
+  TDevice,
+  TBuffer,
+  TKernel,
+  TRunComputeOptions,
+> {
+  readonly device: TDevice;
+  readonly buffers: BoundDoeBuffersNamespace<TBuffer>;
+  readonly compute: BoundDoeComputeNamespace<
+    TBuffer,
+    TKernel,
+    TRunComputeOptions
+  >;
+}
+
+export interface DoeNamespace<
+  TDevice,
+  TBuffer,
+  TKernel,
+  TBoundDoe,
+  TRunComputeOptions,
+  TRequestDeviceOptions = unknown,
+> {
+  requestDevice(options?: TRequestDeviceOptions): Promise<TBoundDoe>;
+  bind(device: TDevice): TBoundDoe;
+  readonly buffers: DoeBuffersNamespace<TDevice, TBuffer>;
+  readonly compute: DoeComputeNamespace<
+    TDevice,
+    TBuffer,
+    TKernel,
+    TRunComputeOptions
+  >;
 }