typegpu 0.11.8 → 0.12.0

package/core/slot/slotTypes.js

@@ -1,21 +1,16 @@
-import { $providing } from "../../shared/symbols.js";
-
-//#region src/core/slot/slotTypes.ts
-function isSlot(value) {
-	return value?.resourceType === "slot";
+import { $gpuValueOf, $internal, $providing, $soul } from "../../shared/symbols.js";
+export function isSlot(value) {
+    return value?.resourceType === 'slot';
 }
-function isLazy(value) {
-	return value?.resourceType === "lazy";
+export function isLazy(value) {
+    return value?.resourceType === 'lazy';
 }
-function isProviding(value) {
-	return value?.[$providing] !== void 0;
+export function isProviding(value) {
+    return value?.[$providing] !== undefined;
 }
-function isAccessor(value) {
-	return value?.resourceType === "accessor";
+export function isAccessor(value) {
+    return value?.resourceType === 'accessor';
 }
-function isMutableAccessor(value) {
-	return value?.resourceType === "mutable-accessor";
+export function isMutableAccessor(value) {
+    return value?.resourceType === 'mutable-accessor';
 }
-
-//#endregion
-export { isAccessor, isLazy, isMutableAccessor, isProviding, isSlot };

package/core/texture/externalTexture.d.ts

@@ -1,12 +1,21 @@
-import "../../data/snippet.js";
-import "../../tgpuBindGroupLayout.js";
-import "../../types.js";
-import "../../data/texture.js";
-import "../../shared/repr.js";
-
-//#region src/core/texture/externalTexture.d.ts
-interface TgpuExternalTexture {
-  readonly resourceType: 'external-texture';
+import { $gpuValueOf, $internal, $resolve } from '../../shared/symbols.ts';
+import type { LayoutMembership } from '../../tgpuBindGroupLayout.ts';
+import { type WgslExternalTexture } from '../../data/texture.ts';
+import type { ResolutionCtx, SelfResolvable } from '../../types.ts';
+import { type ResolvedSnippet } from '../../data/snippet.ts';
+import type { Infer } from '../../shared/repr.ts';
+export interface TgpuExternalTexture {
+    readonly resourceType: 'external-texture';
+}
+export declare function isExternalTexture(value: unknown): value is TgpuExternalTexture;
+export declare class TgpuExternalTextureImpl implements TgpuExternalTexture, SelfResolvable {
+    #private;
+    readonly resourceType = "external-texture";
+    readonly [$internal] = true;
+    readonly schema: WgslExternalTexture;
+    constructor(schema: WgslExternalTexture, membership: LayoutMembership);
+    [$resolve](ctx: ResolutionCtx): ResolvedSnippet;
+    get [$gpuValueOf](): Infer<WgslExternalTexture>;
+    get $(): Infer<WgslExternalTexture>;
+    toString(): string;
 }
-//#endregion
-export { TgpuExternalTexture };

package/core/texture/externalTexture.js

@@ -1,49 +1,49 @@
 import { $gpuValueOf, $internal, $ownSnippet, $resolve } from "../../shared/symbols.js";
 import { getName, setName } from "../../shared/meta.js";
-import { snip } from "../../data/snippet.js";
-import { inCodegenMode } from "../../execMode.js";
-import { valueProxyHandler } from "../valueProxyUtils.js";
 import { textureExternal } from "../../data/texture.js";
-
-//#region src/core/texture/externalTexture.ts
-var TgpuExternalTextureImpl = class {
-	resourceType = "external-texture";
-	[$internal] = true;
-	schema;
-	#membership;
-	constructor(schema, membership) {
-		this.schema = schema;
-		this.#membership = membership;
-		setName(this, membership.key);
-	}
-	[$resolve](ctx) {
-		const id = ctx.makeUniqueIdentifier(getName(this), "global");
-		const group = ctx.allocateLayoutEntry(this.#membership.layout);
-		ctx.addDeclaration(`@group(${group}) @binding(${this.#membership.idx}) var ${id}: ${ctx.resolve(this.schema).value};`);
-		return snip(id, textureExternal(), "handle");
-	}
-	get [$gpuValueOf]() {
-		const schema = this.schema;
-		return new Proxy({
-			[$internal]: true,
-			get [$ownSnippet]() {
-				return snip(this, schema, "handle");
-			},
-			[$resolve]: (ctx) => ctx.resolve(this),
-			toString: () => `textureExternal:${getName(this) ?? "<unnamed>"}.$`
-		}, valueProxyHandler);
-	}
-	get $() {
-		if (inCodegenMode()) return this[$gpuValueOf];
-		throw new Error("Direct access to texture views values is possible only as part of a compute dispatch or draw call. Try .read() or .write() instead");
-	}
-	get value() {
-		return this.$;
-	}
-	toString() {
-		return `textureExternal:${getName(this) ?? "<unnamed>"}`;
-	}
-};
-
-//#endregion
-export { TgpuExternalTextureImpl };
+import { valueProxyHandler } from "../valueProxyUtils.js";
+import { inCodegenMode } from "../../execMode.js";
+import { snip } from "../../data/snippet.js";
+export function isExternalTexture(value) {
+    return value?.resourceType === 'external-texture';
+}
+// --------------
+// Implementation
+// --------------
+export class TgpuExternalTextureImpl {
+    resourceType = 'external-texture';
+    [$internal] = true;
+    schema;
+    #membership;
+    constructor(schema, membership) {
+        this.schema = schema;
+        this.#membership = membership;
+        setName(this, membership.key);
+    }
+    [$resolve](ctx) {
+        const id = ctx.makeUniqueIdentifier(getName(this), 'global');
+        const group = ctx.allocateLayoutEntry(this.#membership.layout);
+        ctx.addDeclaration(`@group(${group}) @binding(${this.#membership.idx}) var ${id}: ${ctx.resolve(this.schema).value};`, id);
+        return snip(id, textureExternal(), 'handle');
+    }
+    get [$gpuValueOf]() {
+        const schema = this.schema;
+        return new Proxy({
+            [$internal]: true,
+            get [$ownSnippet]() {
+                return snip(this, schema, 'handle', false);
+            },
+            [$resolve]: (ctx) => ctx.resolve(this),
+            toString: () => `textureExternal:${getName(this) ?? '<unnamed>'}.$`,
+        }, valueProxyHandler);
+    }
+    get $() {
+        if (inCodegenMode()) {
+            return this[$gpuValueOf];
+        }
+        throw new Error('Direct access to texture views values is possible only as part of a compute dispatch or draw call. Try .read() or .write() instead');
+    }
+    toString() {
+        return `textureExternal:${getName(this) ?? '<unnamed>'}`;
+    }
+}

package/core/texture/texture.d.ts

@@ -1,118 +1,173 @@
-import { TgpuNamable } from "../../shared/meta.js";
-import { $gpuValueOf, $internal } from "../../shared/symbols.js";
-import { Default, TypedArray, UnionToIntersection } from "../../shared/utilityTypes.js";
-import "../../data/snippet.js";
-import { TextureProps } from "./textureProps.js";
-import { AllowedUsages, LiteralToExtensionMap } from "./usageExtension.js";
-import "../../tgpuBindGroupLayout.js";
-import "../root/rootTypes.js";
-import "../../types.js";
-import { F32 } from "../../data/wgslTypes.js";
-import { TextureFormats, ViewDimensionToDimension } from "./textureFormats.js";
-import { TextureSchemaForDescriptor, WgslStorageTexture, WgslTexture } from "../../data/texture.js";
-import { Infer, ValidateTextureViewSchema } from "../../shared/repr.js";
-
-//#region src/core/texture/texture.d.ts
-type TextureInternals = {
-  unwrap(): GPUTexture;
+import { type TextureSchemaForDescriptor, type WgslStorageTexture, type WgslTexture } from '../../data/texture.ts';
+import type { StorageFlag } from '../../extension.ts';
+import { type ResolvedSnippet } from '../../data/snippet.ts';
+import type { F32, Vec4f, Vec4i, Vec4u } from '../../data/wgslTypes.ts';
+import type { TgpuNamable } from '../../shared/meta.ts';
+import type { Infer, ValidateTextureViewSchema } from '../../shared/repr.ts';
+import { type TextureFormats, type ViewDimensionToDimension } from './textureFormats.ts';
+import type { TgpuDeviceOwningSoul, TgpuSoul } from '../../shared/soul.ts';
+import { $gpuValueOf, $internal, $repr, $resolve, $soul } from '../../shared/symbols.ts';
+import type { Default, TypedArray, UnionToIntersection } from '../../shared/utilityTypes.ts';
+import type { LayoutMembership } from '../../tgpuBindGroupLayout.ts';
+import type { ResolutionCtx, SelfResolvable } from '../../types.ts';
+import type { ExperimentalTgpuRoot } from '../root/rootTypes.ts';
+import type { TextureProps } from './textureProps.ts';
+import type { AllowedUsages, LiteralToExtensionMap, RenderFlag, SampledFlag } from './usageExtension.ts';
+export type TextureInternals = {
+    root: ExperimentalTgpuRoot;
+    materialize(): GPUTexture;
 };
+export type TextureUsageLiteral = 'sampled' | 'storage' | 'render' | 'transient';
+export interface TgpuTextureSoul<TProps extends TextureProps = TextureProps> extends TgpuDeviceOwningSoul<'texture', GPUTexture> {
+    readonly props: TProps;
+    flags: GPUTextureUsageFlags;
+    flagsOverridden: boolean;
+    readonly usages: TextureUsageLiteral[];
+}
+export interface TgpuTextureViewSoul<T extends WgslTexture | WgslStorageTexture | 'render' = WgslTexture | WgslStorageTexture | 'render'> extends TgpuSoul<'texture-view'> {
+    readonly texture: TgpuTexture;
+    readonly schema: T;
+    readonly descriptor: (TgpuTextureViewDescriptor & {
+        sampleType?: T extends WgslTexture ? 'float' | 'unfilterable-float' : never;
+    }) | undefined;
+    raw?: GPUTextureView | undefined;
+}
 type TextureViewInternals = {
-  readonly unwrap: (() => GPUTextureView) | undefined;
+    readonly unwrap: (() => GPUTextureView) | undefined;
+    readonly format?: GPUTextureFormat | undefined;
+    readonly aspect?: GPUTextureAspect | undefined;
+};
+export type TexelData = Vec4u | Vec4i | Vec4f;
+export type ExternalImageSource = HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | ImageBitmap | ImageData | OffscreenCanvas | VideoFrame;
+export type TextureWriteFit = 'stretch';
+export type TextureWriteOptions = {
+    /**
+     * How to handle a source whose dimensions do not match the texture.
+     *
+     * By default, mismatched writes throw. Use `'stretch'` to resample the
+     * source to the texture's dimensions.
+     */
+    fit?: TextureWriteFit;
 };
-type ExternalImageSource = HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | ImageBitmap | ImageData | OffscreenCanvas | VideoFrame;
 type TgpuTextureViewDescriptor = {
-  /**
-   * Which {@link GPUTextureAspect | aspect(s)} of the texture are accessible to the texture view.
-   */
-  aspect?: GPUTextureAspect;
-  /**
-   * The first (most detailed) mipmap level accessible to the texture view.
-   */
-  baseMipLevel?: GPUIntegerCoordinate;
-  /**
-   * How many mipmap levels, starting with {@link GPUTextureViewDescriptor#baseMipLevel}, are accessible to
-   * the texture view.
-   */
-  mipLevelCount?: GPUIntegerCoordinate;
-  /**
-   * The index of the first array layer accessible to the texture view.
-   */
-  baseArrayLayer?: GPUIntegerCoordinate;
-  /**
-   * How many array layers, starting with {@link GPUTextureViewDescriptor#baseArrayLayer}, are accessible
-   * to the texture view.
-   */
-  arrayLayerCount?: GPUIntegerCoordinate;
-  /**
-   * The format of the texture view. Must be either the {@link GPUTextureDescriptor#format} of the
-   * texture or one of the {@link GPUTextureDescriptor#viewFormats} specified during its creation.
-   */
-  format?: GPUTextureFormat;
+    /**
+     * Which {@link GPUTextureAspect | aspect(s)} of the texture are accessible to the texture view.
+     */
+    aspect?: GPUTextureAspect;
+    /**
+     * The first (most detailed) mipmap level accessible to the texture view.
+     */
+    baseMipLevel?: GPUIntegerCoordinate;
+    /**
+     * How many mipmap levels, starting with {@link GPUTextureViewDescriptor#baseMipLevel}, are accessible to
+     * the texture view.
+     */
+    mipLevelCount?: GPUIntegerCoordinate;
+    /**
+     * The index of the first array layer accessible to the texture view.
+     */
+    baseArrayLayer?: GPUIntegerCoordinate;
+    /**
+     * How many array layers, starting with {@link GPUTextureViewDescriptor#baseArrayLayer}, are accessible
+     * to the texture view.
+     */
+    arrayLayerCount?: GPUIntegerCoordinate;
+    /**
+     * The format of the texture view. Must be either the {@link GPUTextureDescriptor#format} of the
+     * texture or one of the {@link GPUTextureDescriptor#viewFormats} specified during its creation.
+     */
+    format?: GPUTextureFormat;
 };
 type DefaultViewSchema<T extends Partial<TextureProps>> = TextureSchemaForDescriptor<{
-  dimension: Default<T['dimension'], '2d'>;
-  sampleType: T['format'] extends keyof TextureFormats ? TextureFormats[T['format']]['channelType'] : TextureFormats[keyof TextureFormats]['channelType'];
-  multisampled: Default<T['sampleCount'], 1> extends 1 ? false : true;
+    dimension: Default<T['dimension'], '2d'>;
+    sampleType: T['format'] extends keyof TextureFormats ? TextureFormats[T['format']]['channelType'] : TextureFormats[keyof TextureFormats]['channelType'];
+    multisampled: Default<T['sampleCount'], 1> extends 1 ? false : true;
 }>;
 type BaseDimension<T extends string> = T extends keyof ViewDimensionToDimension ? ViewDimensionToDimension[T] : never;
 type OptionalDimension<T extends string> = T extends '2d' | '2d-array' | 'cube' | 'cube-array' ? {
-  dimension?: BaseDimension<T>;
+    dimension?: BaseDimension<T>;
 } : {
-  dimension: BaseDimension<T>;
+    dimension: BaseDimension<T>;
 };
 type MultisampledProps<T extends WgslTexture> = T['multisampled'] extends true ? OptionalDimension<T['dimension']> & {
-  sampleCount: 4;
+    sampleCount: 4;
 } : OptionalDimension<T['dimension']> & {
-  sampleCount?: 1;
+    sampleCount?: 1;
 };
-type PropsForSchema<T extends WgslTexture | WgslStorageTexture> = T extends WgslTexture ? {
-  size: readonly number[];
-  format: GPUTextureFormat;
+export type PropsForSchema<T extends WgslTexture | WgslStorageTexture> = T extends WgslTexture ? {
+    size: readonly number[];
+    format: GPUTextureFormat;
 } & MultisampledProps<T> : T extends WgslStorageTexture ? {
-  size: readonly number[];
-  format: T['format'];
+    size: readonly number[];
+    format: T['format'];
 } & OptionalDimension<T['dimension']> : never;
 type CopyCompatibleTexture<T extends TextureProps> = TgpuTexture<{
-  size: T['size'];
-  format: T['format'];
-  sampleCount?: T['sampleCount'];
+    size: T['size'];
+    format: T['format'];
+    sampleCount?: T['sampleCount'];
 }>;
-interface TgpuTexture<TProps extends TextureProps = any> extends TgpuNamable {
-  readonly [$internal]: TextureInternals;
-  readonly resourceType: 'texture';
-  readonly props: TProps;
-  readonly destroyed: boolean;
-  readonly usableAsStorage: boolean;
-  readonly usableAsSampled: boolean;
-  readonly usableAsRender: boolean;
-  $usage<T extends AllowedUsages<TProps>[]>(...usages: T): this & UnionToIntersection<LiteralToExtensionMap[T[number]]>;
-  createView(...args: this['usableAsSampled'] extends true ? [] : [ValidateTextureViewSchema<this, WgslTexture>]): TgpuTextureView<DefaultViewSchema<TProps>>;
-  createView(schema: 'render', viewDescriptor?: TgpuTextureViewDescriptor): TgpuTextureRenderView;
-  createView<T extends WgslTexture>(schema: ValidateTextureViewSchema<this, T>, viewDescriptor?: TgpuTextureViewDescriptor & {
-    sampleType?: T['sampleType'] extends F32 ? 'float' | 'unfilterable-float' : never;
-  }): TgpuTextureView<T>;
-  createView<T extends WgslStorageTexture>(schema: ValidateTextureViewSchema<this, T>, viewDescriptor?: TgpuTextureViewDescriptor): TgpuTextureView<T>;
-  clear(mipLevel?: number | 'all'): void;
-  generateMipmaps(baseMipLevel?: number, mipLevels?: number): void;
-  write(source: ExternalImageSource | ExternalImageSource[]): void;
-  write(source: ArrayBuffer | TypedArray | DataView, mipLevel?: number): void;
-  copyFrom<T extends CopyCompatibleTexture<TProps>>(source: T): void;
-  destroy(): void;
+export interface TgpuTexture<TProps extends TextureProps = any> extends TgpuNamable {
+    readonly [$internal]: TextureInternals;
+    readonly [$soul]: TgpuTextureSoul<TProps>;
+    readonly resourceType: 'texture';
+    readonly props: TProps;
+    readonly destroyed: boolean;
+    readonly usableAsStorage: boolean;
+    readonly usableAsSampled: boolean;
+    readonly usableAsRender: boolean;
+    $usage<T extends AllowedUsages<TProps>[]>(...usages: T): this & UnionToIntersection<LiteralToExtensionMap[T[number]]>;
+    $overrideFlags(flags: GPUTextureUsageFlags): this & StorageFlag & SampledFlag & RenderFlag;
+    createView(...args: this['usableAsSampled'] extends true ? [] : [ValidateTextureViewSchema<this, WgslTexture>]): TgpuTextureView<DefaultViewSchema<TProps>>;
+    createView(schema: 'render', viewDescriptor?: TgpuTextureViewDescriptor): TgpuTextureRenderView;
+    createView<T extends WgslTexture>(schema: ValidateTextureViewSchema<this, T>, viewDescriptor?: TgpuTextureViewDescriptor & {
+        sampleType?: T['sampleType'] extends F32 ? 'float' | 'unfilterable-float' : never;
+    }): TgpuTextureView<T>;
+    createView<T extends WgslStorageTexture>(schema: ValidateTextureViewSchema<this, T>, viewDescriptor?: TgpuTextureViewDescriptor): TgpuTextureView<T>;
+    clear(mipLevel?: number | 'all'): void;
+    generateMipmaps(baseMipLevel?: number, mipLevels?: number): void;
+    write(source: ExternalImageSource | ExternalImageSource[], options?: TextureWriteOptions): void;
+    write(source: ArrayBuffer | TypedArray | DataView, mipLevel?: number): void;
+    copyFrom<T extends CopyCompatibleTexture<TProps>>(source: T): void;
+    destroy(): void;
+}
+export interface TgpuTextureView<TSchema extends WgslStorageTexture | WgslTexture = WgslStorageTexture | WgslTexture> extends TgpuNamable {
+    readonly [$internal]: TextureViewInternals;
+    readonly resourceType: 'texture-view';
+    readonly schema: TSchema;
+    readonly size?: number[] | undefined;
+    readonly [$gpuValueOf]: Infer<TSchema>;
+    $: Infer<TSchema>;
+    toString(): string;
+}
+export interface TgpuTextureRenderView {
+    readonly [$internal]: TextureViewInternals;
+    readonly resourceType: 'texture-view';
+    readonly descriptor: TgpuTextureViewDescriptor;
 }
-interface TgpuTextureView<TSchema extends WgslStorageTexture | WgslTexture = WgslStorageTexture | WgslTexture> extends TgpuNamable {
-  readonly [$internal]: TextureViewInternals;
-  readonly resourceType: 'texture-view';
-  readonly schema: TSchema;
-  readonly size?: number[] | undefined;
-  readonly [$gpuValueOf]: Infer<TSchema>;
-  value: Infer<TSchema>;
-  $: Infer<TSchema>;
+export declare function INTERNAL_createTexture(props: TextureProps, root: ExperimentalTgpuRoot, rawTexture?: GPUTexture): TgpuTexture<TextureProps>;
+export declare function isTexture(value: unknown): value is TgpuTexture;
+export declare function isTextureView(value: unknown): value is TgpuTextureView;
+export declare class TgpuLaidOutTextureViewImpl<T extends WgslTexture | WgslStorageTexture> implements TgpuTextureView<T>, SelfResolvable {
+    #private;
+    /** Type-token, not available at runtime */
+    readonly [$repr]: Infer<T>;
+    readonly [$internal]: {
+        unwrap: undefined;
+    };
+    readonly resourceType: "texture-view";
+    readonly schema: T;
+    constructor(schema: T, membership: LayoutMembership);
+    toString(): string;
+    [$resolve](ctx: ResolutionCtx): ResolvedSnippet;
+    get [$gpuValueOf](): Infer<T>;
+    get $(): Infer<T>;
+    $name(label: string): this;
 }
-interface TgpuTextureRenderView {
-  readonly [$internal]: TextureViewInternals;
-  readonly resourceType: 'texture-view';
-  readonly descriptor: TgpuTextureViewDescriptor;
+export declare class TgpuTextureRenderViewImpl implements TgpuTextureRenderView {
+    readonly [$internal]: TextureViewInternals;
+    readonly [$soul]: TgpuTextureViewSoul<'render'>;
+    readonly resourceType: "texture-view";
+    constructor(baseTexture: TgpuTexture, descriptor?: TgpuTextureViewDescriptor);
+    get descriptor(): TgpuTextureViewDescriptor;
 }
-declare function isTexture(value: unknown): value is TgpuTexture;
-//#endregion
-export { PropsForSchema, TextureInternals, TgpuTexture, TgpuTextureRenderView, TgpuTextureView, isTexture };
+export {};