fix: Better exotic inference (#607)

Author: iwoplaza

packages/typegpu/src/core/buffer/public.ts

@@ -0,0 +1,24 @@
+import type { AnyData } from '../../data/dataTypes';
+import type { Exotic } from '../../data/exotic';
+import type { TgpuBuffer as INTERNAL_TgpuBuffer } from './buffer';
+import type {
+  TgpuBufferMutable as INTERNAL_TgpuBufferMutable,
+  TgpuBufferReadonly as INTERNAL_TgpuBufferReadonly,
+  TgpuBufferUniform as INTERNAL_TgpuBufferUniform,
+} from './bufferUsage';
+
+export type TgpuBuffer<TData extends AnyData> = INTERNAL_TgpuBuffer<
+  Exotic<TData>
+>;
+
+export type TgpuBufferMutable<TData extends AnyData> =
+  INTERNAL_TgpuBufferMutable<Exotic<TData>>;
+
+export type TgpuBufferReadonly<TData extends AnyData> =
+  INTERNAL_TgpuBufferReadonly<Exotic<TData>>;
+
+export type TgpuBufferUniform<TData extends AnyData> =
+  INTERNAL_TgpuBufferUniform<Exotic<TData>>;
+
+// Reexporting as-is
+export type { Uniform, Vertex } from './buffer';

packages/typegpu/src/core/texture/usageExtension.ts

@@ -35,7 +35,7 @@ export function isUsableAsRender<T>(value: T): value is T & Render {
  * @category Errors
  */
 export class NotSampledError extends Error {
-  constructor(value: { readonly label: string | undefined }) {
+  constructor(value: { readonly label?: string | undefined }) {
     super(
       `Resource '${value.label ?? '<unnamed>'}' cannot be bound as 'sampled'. Use .$usage('sampled') to allow it.`,
     );
@@ -49,7 +49,7 @@ export class NotSampledError extends Error {
  * @category Errors
  */
 export class NotRenderError extends Error {
-  constructor(value: { readonly label: string | undefined }) {
+  constructor(value: { readonly label?: string | undefined }) {
     super(
       `Resource '${value.label ?? '<unnamed>'}' cannot be bound as 'render'. Use .$usage('render') to allow it.`,
     );

packages/typegpu/src/data/array.ts

@@ -15,7 +15,9 @@ import type { AnyWgslData, WgslArray } from './wgslTypes';
  * the `byteAlignment` requirement of its elementType.
  */
 export interface TgpuArray<TElement extends AnyWgslData>
-  extends WgslArray<TElement> {}
+  extends WgslArray<TElement> {
+  readonly '~exotic': WgslArray<Exotic<TElement>>;
+}
 
 /**
  * Creates an array schema that can be used to construct gpu buffers.
@@ -44,6 +46,8 @@ class TgpuArrayImpl<TElement extends AnyWgslData>
   public readonly type = 'array';
   /** Type-token, not available at runtime */
   public readonly '~repr'!: Infer<TElement>[];
+  /** Type-token, not available at runtime */
+  public readonly '~exotic'!: WgslArray<Exotic<TElement>>;
 
   constructor(
     public readonly elementType: TElement,

packages/typegpu/src/data/exotic.ts

@@ -1,46 +1,11 @@
-import type * as wgsl from './wgslTypes';
-
-type TypeToPrimitiveMap = {
-  bool: wgsl.Bool;
-  f32: wgsl.F32;
-  i32: wgsl.I32;
-  u32: wgsl.U32;
-  vec2f: wgsl.Vec2f;
-  vec2i: wgsl.Vec2i;
-  vec2u: wgsl.Vec2u;
-  vec3f: wgsl.Vec3f;
-  vec3i: wgsl.Vec3i;
-  vec3u: wgsl.Vec3u;
-  vec4f: wgsl.Vec4f;
-  vec4i: wgsl.Vec4i;
-  vec4u: wgsl.Vec4u;
-  mat2x2f: wgsl.Mat2x2f;
-  mat3x3f: wgsl.Mat3x3f;
-  mat4x4f: wgsl.Mat4x4f;
-};
-
 /**
  * Strips schema types down to their most basic forms. (native -> exotic)
  * This is used by schema constructors to be able to ingest native schemas (created by TypeGPU), and
  * spit out a type that matches non-native schemas as well.
  */
-export type Exotic<T> =
-  // primitives
-  T extends { type: keyof TypeToPrimitiveMap }
-    ? TypeToPrimitiveMap[T['type']]
-    : // arrays
-      T extends wgsl.WgslArray<infer TElement>
-      ? wgsl.WgslArray<TElement>
-      : // structs
-        T extends wgsl.WgslStruct<infer TProps>
-        ? wgsl.WgslStruct<TProps>
-        : // atomics
-          T extends wgsl.Atomic<infer TInner>
-          ? wgsl.Atomic<TInner>
-          : // decorated
-            T extends wgsl.Decorated<infer TInner, infer TAttribs>
-            ? wgsl.Decorated<TInner, TAttribs>
-            : T;
+export type Exotic<T> = T extends { readonly '~exotic': infer TExotic }
+  ? TExotic
+  : T;
 
 export type ExoticArray<T> = T extends unknown[] | []
   ? {

packages/typegpu/src/data/matrix.ts

@@ -439,7 +439,9 @@ class mat4x4fImpl extends mat4x4Impl<v4f> implements m4x4f {
 /**
  * Type of the `d.mat2x2f` object/function: matrix data type schema/constructor
  */
-export type Mat2x2fConstructor = ((...elements: number[]) => m2x2f) &
+export type NativeMat2x2f = Mat2x2f & { '~exotic': Mat2x2f } & ((
+    ...elements: number[]
+  ) => m2x2f) &
   ((...columns: v2f[]) => m2x2f) &
   (() => m2x2f);
 
@@ -470,12 +472,14 @@ export const mat2x2f = createMatSchema<'mat2x2f', m2x2f, v2f>({
   rows: 2,
   columns: 2,
   makeFromElements: (...elements: number[]) => new mat2x2fImpl(...elements),
-}) as Mat2x2f & Mat2x2fConstructor;
+}) as NativeMat2x2f;
 
 /**
  * Type of the `d.mat3x3f` object/function: matrix data type schema/constructor
  */
-export type Mat3x3fConstructor = ((...elements: number[]) => m3x3f) &
+export type NativeMat3x3f = Mat3x3f & { '~exotic': Mat3x3f } & ((
+    ...elements: number[]
+  ) => m3x3f) &
   ((...columns: v3f[]) => m3x3f) &
   (() => m3x3f);
 
@@ -508,12 +512,14 @@ export const mat3x3f = createMatSchema<'mat3x3f', m3x3f, v3f>({
   rows: 3,
   columns: 3,
   makeFromElements: (...elements: number[]) => new mat3x3fImpl(...elements),
-}) as Mat3x3f & Mat3x3fConstructor;
+}) as NativeMat3x3f;
 
 /**
  * Type of the `d.mat4x4f` object/function: matrix data type schema/constructor
  */
-export type Mat4x4fConstructor = ((...elements: number[]) => m4x4f) &
+export type NativeMat4x4f = Mat4x4f & { '~exotic': Mat4x4f } & ((
+    ...elements: number[]
+  ) => m4x4f) &
   ((...columns: v4f[]) => m4x4f) &
   (() => m4x4f);
 
@@ -548,7 +554,7 @@ export const mat4x4f = createMatSchema<'mat4x4f', m4x4f, v4f>({
   rows: 4,
   columns: 4,
   makeFromElements: (...elements: number[]) => new mat4x4fImpl(...elements),
-}) as Mat4x4f & Mat4x4fConstructor;
+}) as NativeMat4x4f;
 
 export function matToArray(mat: m2x2f | m3x3f | m4x4f): number[] {
   if (mat.kind === 'mat3x3f') {

packages/typegpu/src/data/numeric.ts

@@ -11,7 +11,10 @@ export const bool: Bool = {
 /**
  * Unsigned 32-bit integer schema representing a single WGSL u32 value.
  */
-export type U32Cast = (v: number | boolean) => number;
+export type NativeU32 = U32 & { '~exotic': U32 } & ((
+    v: number | boolean,
+  ) => number);
+
 const u32Cast = (v: number | boolean) => {
   if (inGPUMode()) {
     return `u32(${v})` as unknown as number;
@@ -42,14 +45,17 @@ const u32Cast = (v: number | boolean) => {
  * @example
  * const value = u32(-3.1); // 0
  */
-export const u32: U32 & U32Cast = Object.assign(u32Cast, {
+export const u32: NativeU32 = Object.assign(u32Cast, {
   type: 'u32',
-} as U32);
+}) as NativeU32;
 
 /**
  * Signed 32-bit integer schema representing a single WGSL i32 value.
  */
-export type I32Cast = (v: number | boolean) => number;
+export type NativeI32 = I32 & { '~exotic': I32 } & ((
+    v: number | boolean,
+  ) => number);
+
 const i32Cast = (v: number | boolean) => {
   if (inGPUMode()) {
     return `i32(${v})` as unknown as number;
@@ -82,14 +88,17 @@ const i32Cast = (v: number | boolean) => {
  * @example
  * const value = i32(10000000000) // 1410065408
  */
-export const i32: I32 & I32Cast = Object.assign(i32Cast, {
+export const i32: NativeI32 = Object.assign(i32Cast, {
   type: 'i32',
-} as I32);
+}) as NativeI32;
 
 /**
  * 32-bit float schema representing a single WGSL f32 value.
  */
-export type F32Cast = (v: number | boolean) => number;
+export type NativeF32 = F32 & { '~exotic': F32 } & ((
+    v: number | boolean,
+  ) => number);
+
 const f32Cast = (v: number | boolean) => {
   if (inGPUMode()) {
     return `f32(${v})` as unknown as number;
@@ -108,6 +117,6 @@ const f32Cast = (v: number | boolean) => {
  * @example
  * const value = f32(true); // 1
  */
-export const f32: F32 & F32Cast = Object.assign(f32Cast, {
+export const f32: NativeF32 = Object.assign(f32Cast, {
   type: 'f32',
-} as F32);
+}) as NativeF32;

packages/typegpu/src/data/struct.ts

@@ -17,7 +17,9 @@ import type { AnyWgslData, BaseWgslData, WgslStruct } from './wgslTypes';
  */
 export interface TgpuStruct<TProps extends Record<string, BaseWgslData>>
   extends WgslStruct<TProps>,
-    TgpuNamable {}
+    TgpuNamable {
+  readonly '~exotic': WgslStruct<ExoticRecord<TProps>>;
+}
 
 /**
  * Creates a struct schema that can be used to construct GPU buffers.
@@ -47,6 +49,8 @@ class TgpuStructImpl<TProps extends Record<string, AnyWgslData>>
   public readonly type = 'struct';
   /** Type-token, not available at runtime */
   public readonly '~repr'!: InferRecord<TProps>;
+  /** Type-token, not available at runtime */
+  public readonly '~exotic'!: WgslStruct<ExoticRecord<TProps>>;
 
   constructor(public readonly propTypes: TProps) {}