typegpu 0.10.0 → 0.10.2

package/index.d.ts

@@ -1,245 +1,43 @@
-import { $o as TgpuLayoutComparisonSampler, $r as comptime, Ac as TgpuComputePipeline, Al as Storage, Ao as UniformFlag, Bc as isSlot, Bo as ValidateStorageSchema, Cc as TgpuFragmentFnShell, Co as fn, Dc as AutoFragmentOut, Do as IndexFlag, Ec as AutoFragmentIn, Eo as declare, Fc as TgpuMutableAccessor, Fo as isUsableAsVertex, Gc as workgroupVar, Go as WithVertex, Gr as rawCodeSnippet, Hc as VariableScope, Ho as WithBinding, Ic as TgpuSlot, Io as Configurable, Jc as computeFn, Jo as BindLayoutEntry, Jr as init, Kc as TgpuComputeFn, Ko as Withable, Kr as InitFromDeviceOptions, Lc as isAccessor, Ll as $internal, Lo as TgpuGuardedComputePipeline, Mc as Eventual, Ml as isUsableAsStorage, Mo as Vertex, Nc as TgpuAccessor, No as VertexFlag, Oc as AutoVertexIn, Oo as TgpuBuffer, Pc as TgpuLazy, Po as isBuffer, Qo as TgpuBindGroupLayout, Qr as TgpuComptime, Rc as isLazy, Rl as INTERNAL_GlobalExt, Ro as TgpuRoot, Sc as TgpuFragmentFn, So as TgpuGenericFn, Tc as isTgpuFragmentFn, To as TgpuDeclare, Uc as isVariable, Uo as WithCompute, Ur as RawCodeSnippetOrigin, Vc as TgpuVar, Vo as ValidateUniformSchema, Wc as privateVar, Wo as WithFragment, Wr as TgpuRawCodeSnippet, Xo as LayoutEntryToInput, Xr as Namespace, Yc as isTgpuComputeFn, Yo as ExtractBindGroupInputFromLayout, Yr as initFromDevice, Zo as TgpuBindGroup, Zr as namespace, _c as TextureProps, _i as isTexture, _o as ResolvableObject, _s as TgpuVertexLayout, a as MissingVertexBuffersError, al as LogResources, as as TgpuLayoutUniform, bc as isTgpuVertexFn, bo as TgpuFn, cl as TgpuUniform, cs as TgpuComparisonSampler, dl as TgpuBufferReadonly, ds as TgpuSampler, ei as TgpuConst, es as TgpuLayoutEntry, fl as TgpuBufferUniform, fs as isComparisonSampler, gc as isUsableAsSampled, gi as TgpuTextureView, go as GPUCallable, gs as TgpuRenderPipeline, hc as isUsableAsRender, hi as TgpuTexture, hs as TgpuPrimitiveState, i as MissingSlotValueError, is as TgpuLayoutTexture, jl as StorageFlag, jo as ValidUsagesFor, kc as AutoVertexOut, ko as Uniform, ll as isBufferShorthand, ls as TgpuFixedComparisonSampler, mc as SampledFlag, ml as TgpuQuerySet, ms as ColorAttachment, n as MissingBindGroupsError, ni as AnyData, ns as TgpuLayoutSampler, o as NotUniformError, oa as BaseData, ol as TgpuMutable, os as UnwrapRuntimeConstructor, pc as RenderFlag, pl as isUsableAsUniform, ps as isSampler, qc as TgpuComputeFnShell, qo as ShaderGenerator, qr as InitOptions, r as MissingLinksError, rs as TgpuLayoutStorage, s as ResolutionError, sl as TgpuReadonly, ss as bindGroupLayout, t as TgpuRenderPipelineDescriptor, ti as constant, ts as TgpuLayoutExternalTexture, ul as TgpuBufferMutable, us as TgpuFixedSampler, vc as TgpuVertexFn, vo as Wgsl, vs as vertexLayout, wc as fragmentFn, wo as isTgpuFn, xc as vertexFn, xo as TgpuFnShell, yc as TgpuVertexFnShell, yo as WgslExtension, zc as isMutableAccessor, zo as ValidateBufferSchema } from "./indexNamedExports-Cdy7USiY.js";
-import { t as index_d_exports$1 } from "./data/index.js";
-import { t as index_d_exports$2 } from "./std/index.js";
-import { t as index_d_exports } from "./common/index.js";
+import { INTERNAL_GlobalExt } from "./shared/meta.js";
+import { Storage, StorageFlag, isUsableAsStorage } from "./extension.js";
+import { TgpuQuerySet } from "./core/querySet/querySet.js";
+import { TgpuBufferMutable, TgpuBufferReadonly, TgpuBufferUniform, isUsableAsUniform } from "./core/buffer/bufferUsage.js";
+import { TgpuMutable, TgpuReadonly, TgpuUniform, isBufferShorthand } from "./core/buffer/bufferShorthand.js";
+import { TgpuComputeFn, TgpuComputeFnShell, computeFn, isTgpuComputeFn } from "./core/function/tgpuComputeFn.js";
+import { TgpuVar, VariableScope, isVariable, privateVar, workgroupVar } from "./core/variable/tgpuVariable.js";
+import { Eventual, TgpuAccessor, TgpuLazy, TgpuMutableAccessor, TgpuSlot, isAccessor, isLazy, isMutableAccessor, isSlot } from "./core/slot/slotTypes.js";
+import { TgpuComputePipeline } from "./core/pipeline/computePipeline.js";
+import { AutoFragmentIn, AutoFragmentOut, AutoVertexIn, AutoVertexOut } from "./core/function/autoIO.js";
+import { TgpuFragmentFn, TgpuFragmentFnShell, fragmentFn, isTgpuFragmentFn } from "./core/function/tgpuFragmentFn.js";
+import { TgpuVertexFn, TgpuVertexFnShell, isTgpuVertexFn, vertexFn } from "./core/function/tgpuVertexFn.js";
+import { TextureProps } from "./core/texture/textureProps.js";
+import { RenderFlag, SampledFlag, isUsableAsRender, isUsableAsSampled } from "./core/texture/usageExtension.js";
+import { TgpuVertexLayout, vertexLayout } from "./core/vertexLayout/vertexLayout.js";
+import { ColorAttachment, TgpuPrimitiveState, TgpuRenderPipeline } from "./core/pipeline/renderPipeline.js";
+import { TgpuComparisonSampler, TgpuFixedComparisonSampler, TgpuFixedSampler, TgpuSampler, isComparisonSampler, isSampler } from "./core/sampler/sampler.js";
+import { BindLayoutEntry, ExtractBindGroupInputFromLayout, LayoutEntryToInput, TgpuBindGroup, TgpuBindGroupLayout, TgpuLayoutComparisonSampler, TgpuLayoutEntry, TgpuLayoutExternalTexture, TgpuLayoutSampler, TgpuLayoutStorage, TgpuLayoutTexture, TgpuLayoutUniform, bindGroupLayout } from "./tgpuBindGroupLayout.js";
+import { Configurable, TgpuGuardedComputePipeline, TgpuRoot, ValidateBufferSchema, ValidateStorageSchema, ValidateUniformSchema, WithBinding, WithCompute, WithFragment, WithVertex, Withable } from "./core/root/rootTypes.js";
+import { IndexFlag, TgpuBuffer, Uniform, UniformFlag, ValidUsagesFor, Vertex, VertexFlag, isBuffer, isUsableAsVertex } from "./core/buffer/buffer.js";
+import { TgpuDeclare } from "./core/declare/tgpuDeclare.js";
+import { TgpuFn, TgpuFnShell, TgpuGenericFn, fn, isTgpuFn } from "./core/function/tgpuFn.js";
+import { TgpuTexture, TgpuTextureView, isTexture } from "./core/texture/texture.js";
+import { TgpuConst, constant } from "./core/constant/tgpuConstant.js";
+import { TgpuComptime, comptime } from "./core/function/comptime.js";
+import { Namespace } from "./core/resolve/namespace.js";
+import { resolve, resolveWithContext } from "./core/resolve/tgpuResolve.js";
+import { InitFromDeviceOptions, InitOptions, init, initFromDevice } from "./core/root/init.js";
+import { slot } from "./core/slot/slot.js";
+import { lazy } from "./core/slot/lazy.js";
+import { accessor, mutableAccessor } from "./core/slot/accessor.js";
+import { unroll } from "./core/unroll/tgpuUnroll.js";
+import { RawCodeSnippetOrigin, TgpuRawCodeSnippet } from "./core/rawCodeSnippet/tgpuRawCodeSnippet.js";
+import { tgpuUnstable_d_exports } from "./tgpuUnstable.js";
+import { index_d_exports as index_d_exports$1 } from "./data/index.js";
+import { index_d_exports as index_d_exports$2 } from "./std/index.js";
+import { index_d_exports } from "./common/index.js";
+import { MissingBindGroupsError, MissingLinksError, MissingSlotValueError, MissingVertexBuffersError, NotUniformError, ResolutionError } from "./errors.js";
+import { TgpuRenderPipelineDescriptor } from "./indexNamedExports.js";
 
-//#region src/resolutionCtx.d.ts
-/**
- * The results of a WGSL resolution.
- *
- * @param code - The resolved code.
- * @param usedBindGroupLayouts - List of used `tgpu.bindGroupLayout`s.
- * @param catchall - Automatically constructed bind group for buffer usages and buffer shorthands, preceded by its index.
- * @param logResources - Buffers and information about used console.logs needed to decode the raw data.
- */
-interface ResolutionResult {
-  code: string;
-  usedBindGroupLayouts: TgpuBindGroupLayout[];
-  catchall: [number, TgpuBindGroup] | undefined;
-  logResources: LogResources | undefined;
-}
-//#endregion
-//#region src/core/resolve/tgpuResolve.d.ts
-interface TgpuResolveOptions {
-  /**
-   * The naming strategy used for generating identifiers for resolved externals and their dependencies.
-   *
-   * ## Namespaces
-   * Each call to `tgpu.resolve` uses it's own namespace by default, but a
-   * custom namespace can be created with `tgpu.namespace` and passed in.
-   *
-   * This allows tracking the behavior of the resolution process, as well as
-   * sharing state between calls to `tgpu.resolve`.
-   *
-   * @default 'random'
-   */
-  names?: 'strict' | 'random' | Namespace | undefined;
-  /**
-   * A function to configure the resolution context.
-   */
-  config?: ((cfg: Configurable) => Configurable) | undefined;
-  /**
-   * List of WGSL shader extensions to enable.
-   */
-  enableExtensions?: WgslExtension[] | undefined;
-  /**
-   * A custom shader code generator, used when resolving TypeGPU functions.
-   * If not provided, the default WGSL generator will be used.
-   */
-  shaderGenerator?: ShaderGenerator | undefined;
-}
-interface TgpuExtendedResolveOptions extends TgpuResolveOptions {
-  /**
-   * Map of external names to their resolvable values.
-   */
-  externals: Record<string, Wgsl | object>;
-  /**
-   * The code template to use for the resolution. All external names will be replaced with their resolved values.
-   * @default ''
-   */
-  template?: string | undefined;
-}
-/**
- * Resolves a template with external values. Each external that is used will get resolved to a code string and replaced in the template.
- * Any dependencies of the externals will also be resolved and included in the output.
- * @param options - The options for the resolution.
- *
- * @returns {ResolutionResult}
- *
- * @example
- * ```ts
- * const Gradient = d.struct({ from: d.vec3f, to: d.vec3f });
- *
- * const { code, usedBindGroupLayouts, catchall } = tgpu.resolveWithContext({
- *   template: `
- *     fn getGradientAngle(gradient: Gradient) -> f32 {
- *       return atan(gradient.to.y - gradient.from.y, gradient.to.x - gradient.from.x);
- *     }
- *   `,
- *   externals: {
- *     Gradient,
- *   },
- * });
- *
- * console.log(code);
- * // struct Gradient_0 {
- * //   from: vec3f,
- * //   to: vec3f,
- * // }
- * // fn getGradientAngle(gradient: Gradient_0) -> f32 {
- * //   return atan(gradient.to.y - gradient.from.y, gradient.to.x - gradient.from.x);
- * // }
- * ```
- */
-declare function resolveWithContext(options: TgpuExtendedResolveOptions): ResolutionResult;
-/**
- * Resolves given TypeGPU resources.
- * Any dependencies of the externals will also be resolved and included in the output.
- * @param items - An array of items to resolve.
- * @param options - The options for the resolution.
- *
- * @returns {ResolutionResult}
- *
- * @example
- * ```ts
- * const Gradient = d.struct({
- *   from: d.vec3f,
- *   to: d.vec3f,
- * });
- *
- * const { code, usedBindGroupLayouts, catchall } =
- *   tgpu.resolveWithContext([Gradient]);
- *
- * console.log(code);
- * // struct Gradient_0 {
- * //   from: vec3f,
- * //   to: vec3f,
- * // }
- * ```
- */
-declare function resolveWithContext(items: ResolvableObject[], options?: TgpuResolveOptions): ResolutionResult;
-/**
- * A shorthand for calling `tgpu.resolveWithContext(...).code`.
- *
- * @example
- * ```ts
- * const Gradient = d.struct({ from: d.vec3f, to: d.vec3f });
- *
- * const resolved = tgpu.resolve([Gradient]);
- *
- * console.log(resolved);
- * // struct Gradient_0 {
- * //   from: vec3f,
- * //   to: vec3f,
- * // }
- * ```
- *
- * @example
- * ```ts
- * const Gradient = d.struct({ from: d.vec3f, to: d.vec3f });
- *
- * const code = tgpu.resolve({
- *   template: `
- *     fn getGradientAngle(gradient: Gradient) -> f32 {
- *       return atan(gradient.to.y - gradient.from.y, gradient.to.x - gradient.from.x);
- *     }
- *   `,
- *   externals: {
- *     Gradient,
- *   },
- * });
- *
- * console.log(code);
- * // struct Gradient_0 {
- * //   from: vec3f,
- * //   to: vec3f,
- * // }
- * // fn getGradientAngle(gradient: Gradient_0) -> f32 {
- * //   return atan(gradient.to.y - gradient.from.y, gradient.to.x - gradient.from.x);
- * // }
- * ```
- */
-declare function resolve(options: TgpuExtendedResolveOptions): string;
-declare function resolve(items: ResolvableObject[], options?: TgpuResolveOptions): string;
-//#endregion
-//#region src/core/slot/slot.d.ts
-declare function slot<T>(defaultValue?: T): TgpuSlot<T>;
-//#endregion
-//#region src/core/slot/lazy.d.ts
-declare function lazy<T>(compute: () => T): TgpuLazy<T>;
-//#endregion
-//#region src/core/slot/accessor.d.ts
-declare function accessor<T extends AnyData | ((count: number) => AnyData)>(schemaOrConstructor: T, defaultValue?: TgpuAccessor.In<NoInfer<T>>): TgpuAccessor<UnwrapRuntimeConstructor<T>>;
-declare function mutableAccessor<T extends AnyData | ((count: number) => AnyData)>(schemaOrConstructor: T, defaultValue?: TgpuMutableAccessor.In<NoInfer<T>>): TgpuMutableAccessor<UnwrapRuntimeConstructor<T>>;
-//#endregion
-//#region src/core/unroll/tgpuUnroll.d.ts
-/**
- * Marks an iterable to be unrolled by the wgslGenerator.
- */
-declare const unroll: (<T extends Iterable<unknown>>(value: T) => T) & GPUCallable<[value: Iterable<unknown>]> & {
-  [$internal]: true;
-};
-//#endregion
-//#region src/core/simulate/tgpuSimulate.d.ts
-interface SimulationResult<T> {
-  value: T;
-  buffers: Map<TgpuBuffer<BaseData>, unknown>;
-  privateVars: Map<TgpuVar<'private'>, unknown>[][][];
-  workgroupVars: Map<TgpuVar<'workgroup'>, unknown>[][][];
-}
-/**
- * Runs the provided callback in a simulated environment, giving
- * it access to buffers and variables as if it were running on the GPU.
- *
- * The result of the simulation is returned, and does not affect the actual GPU state,
- * nor does it carry over to other simulations.
- *
- * @param callback The callback to run in the simulated environment.
- * @returns An object containing the result of the simulation, and
- *          the final state of the environment.
- *
- * @example
- * const counter = tgpu.privateVar(d.u32);
- *
- * const result = tgpu.simulate(() => {
- *  counter.$ += 1;
- *  counter.$ += 2;
- *  return counter.$;
- * });
- *
- * console.log(result.value); // 3
- */
-declare function simulate<T>(callback: () => T): SimulationResult<T>;
-declare namespace tgpuUnstable_d_exports {
-  export { _accessor as accessor, _comptime as comptime, _computeFn as computeFn, _constant as const, declare, _lazy as derived, _fn as fn, _fragmentFn as fragmentFn, _mutableAccessor as mutableAccessor, namespace, _privateVar as privateVar, rawCodeSnippet, simulate, _slot as slot, _vertexFn as vertexFn, _vertexLayout as vertexLayout, _workgroupVar as workgroupVar };
-}
-/** @deprecated This feature is now stable, use tgpu.const. */
-declare const _constant: typeof constant;
-/** @deprecated This feature is now stable, use tgpu.comptime. */
-declare const _comptime: typeof comptime;
-/** @deprecated This feature is now stable, use tgpu.computeFn. */
-declare const _computeFn: typeof computeFn;
-/** @deprecated This feature is now stable, use tgpu.fn. */
-declare const _fn: typeof fn;
-/** @deprecated This feature is now stable, use tgpu.fragmentFn. */
-declare const _fragmentFn: typeof fragmentFn;
-/** @deprecated This feature is now stable, use tgpu.vertexFn. */
-declare const _vertexFn: typeof vertexFn;
-/** @deprecated This feature is now stable, use tgpu.accessor. */
-declare const _accessor: typeof accessor;
-/** @deprecated This feature is now stable, use tgpu.mutableAccessor. */
-declare const _mutableAccessor: typeof mutableAccessor;
-/** @deprecated This feature is now stable, use tgpu.lazy. */
-declare const _lazy: typeof lazy;
-/** @deprecated This feature is now stable, use tgpu.slot. */
-declare const _slot: typeof slot;
-/** @deprecated This feature is now stable, use tgpu.privateVar. */
-declare const _privateVar: typeof privateVar;
-/** @deprecated This feature is now stable, use tgpu.workgroupVar. */
-declare const _workgroupVar: typeof workgroupVar;
-/** @deprecated This feature is now stable, use tgpu.vertexLayout. */
-declare const _vertexLayout: typeof vertexLayout;
-//#endregion
 //#region src/index.d.ts
 /**
  * @module typegpu
@@ -268,5 +66,4 @@ declare const tgpu: {
   '~unstable': typeof tgpuUnstable_d_exports;
 };
 //#endregion
-export { AutoFragmentIn, AutoFragmentOut, AutoVertexIn, AutoVertexOut, BindLayoutEntry, ColorAttachment, Configurable, Eventual, ExtractBindGroupInputFromLayout, INTERNAL_GlobalExt, IndexFlag, InitFromDeviceOptions, InitOptions, LayoutEntryToInput, MissingBindGroupsError, MissingLinksError, MissingSlotValueError, MissingVertexBuffersError, Namespace, NotUniformError, RawCodeSnippetOrigin, RenderFlag, ResolutionError, SampledFlag, Storage, StorageFlag, TextureProps, TgpuAccessor, TgpuBindGroup, TgpuBindGroupLayout, TgpuBuffer, TgpuBufferMutable, TgpuBufferReadonly, TgpuBufferUniform, TgpuComparisonSampler, TgpuComptime, TgpuComputeFn, TgpuComputeFnShell, TgpuComputePipeline, TgpuConst, TgpuDeclare, TgpuFixedComparisonSampler, TgpuFixedSampler, TgpuFn, TgpuFnShell, TgpuFragmentFn, TgpuFragmentFnShell, TgpuGenericFn, TgpuGuardedComputePipeline, TgpuLayoutComparisonSampler, TgpuLayoutEntry, TgpuLayoutExternalTexture, TgpuLayoutSampler, TgpuLayoutStorage, TgpuLayoutTexture, TgpuLayoutUniform, TgpuLazy, TgpuMutable, TgpuMutableAccessor, TgpuPrimitiveState, TgpuQuerySet, TgpuRawCodeSnippet, TgpuReadonly, TgpuRenderPipeline, TgpuRenderPipelineDescriptor, TgpuRoot, TgpuSampler, TgpuSlot, TgpuTexture, TgpuTextureView, TgpuUniform, TgpuVar, TgpuVertexFn, TgpuVertexFnShell, TgpuVertexLayout, Uniform, UniformFlag, ValidUsagesFor, ValidateBufferSchema, ValidateStorageSchema, ValidateUniformSchema, VariableScope, Vertex, VertexFlag, WithBinding, WithCompute, WithFragment, WithVertex, Withable, index_d_exports as common, index_d_exports$1 as d, tgpu as default, tgpu, isAccessor, isBuffer, isBufferShorthand, isComparisonSampler, isLazy, isMutableAccessor, isSampler, isSlot, isTexture, isTgpuComputeFn, isTgpuFn, isTgpuFragmentFn, isTgpuVertexFn, isUsableAsRender, isUsableAsSampled, isUsableAsStorage, isUsableAsUniform, isUsableAsVertex, isVariable, index_d_exports$2 as std };
-//# sourceMappingURL=index.d.ts.map
+export { AutoFragmentIn, AutoFragmentOut, AutoVertexIn, AutoVertexOut, BindLayoutEntry, ColorAttachment, Configurable, Eventual, ExtractBindGroupInputFromLayout, INTERNAL_GlobalExt, IndexFlag, InitFromDeviceOptions, InitOptions, LayoutEntryToInput, MissingBindGroupsError, MissingLinksError, MissingSlotValueError, MissingVertexBuffersError, Namespace, NotUniformError, RawCodeSnippetOrigin, RenderFlag, ResolutionError, SampledFlag, Storage, StorageFlag, TextureProps, TgpuAccessor, TgpuBindGroup, TgpuBindGroupLayout, TgpuBuffer, TgpuBufferMutable, TgpuBufferReadonly, TgpuBufferUniform, TgpuComparisonSampler, TgpuComptime, TgpuComputeFn, TgpuComputeFnShell, TgpuComputePipeline, TgpuConst, TgpuDeclare, TgpuFixedComparisonSampler, TgpuFixedSampler, TgpuFn, TgpuFnShell, TgpuFragmentFn, TgpuFragmentFnShell, TgpuGenericFn, TgpuGuardedComputePipeline, TgpuLayoutComparisonSampler, TgpuLayoutEntry, TgpuLayoutExternalTexture, TgpuLayoutSampler, TgpuLayoutStorage, TgpuLayoutTexture, TgpuLayoutUniform, TgpuLazy, TgpuMutable, TgpuMutableAccessor, TgpuPrimitiveState, TgpuQuerySet, TgpuRawCodeSnippet, TgpuReadonly, TgpuRenderPipeline, TgpuRenderPipelineDescriptor, TgpuRoot, TgpuSampler, TgpuSlot, TgpuTexture, TgpuTextureView, TgpuUniform, TgpuVar, TgpuVertexFn, TgpuVertexFnShell, TgpuVertexLayout, Uniform, UniformFlag, ValidUsagesFor, ValidateBufferSchema, ValidateStorageSchema, ValidateUniformSchema, VariableScope, Vertex, VertexFlag, WithBinding, WithCompute, WithFragment, WithVertex, Withable, index_d_exports as common, index_d_exports$1 as d, tgpu as default, tgpu, isAccessor, isBuffer, isBufferShorthand, isComparisonSampler, isLazy, isMutableAccessor, isSampler, isSlot, isTexture, isTgpuComputeFn, isTgpuFn, isTgpuFragmentFn, isTgpuVertexFn, isUsableAsRender, isUsableAsSampled, isUsableAsStorage, isUsableAsUniform, isUsableAsVertex, isVariable, index_d_exports$2 as std };