Fix invalid bound type for samplers (#771)

Author: mhawryluk

packages/typegpu/src/experimental/index.ts

@@ -151,6 +151,7 @@ export type {
   TgpuBindGroupLayout,
   TgpuLayoutEntry,
   TgpuLayoutSampler,
+  TgpuLayoutComparisonSampler,
   TgpuLayoutTexture,
   TgpuLayoutStorage,
   TgpuLayoutStorageTexture,

packages/typegpu/src/index.ts

@@ -66,6 +66,7 @@ export type {
   TgpuBindGroupLayout,
   TgpuLayoutEntry,
   TgpuLayoutSampler,
+  TgpuLayoutComparisonSampler,
   TgpuLayoutTexture,
   TgpuLayoutStorage,
   TgpuLayoutStorageTexture,

packages/typegpu/src/tgpuBindGroupLayout.ts

@@ -11,6 +11,7 @@ import {
   TgpuLaidOutBufferImpl,
 } from './core/buffer/bufferUsage';
 import {
+  type TgpuComparisonSampler,
   TgpuLaidOutComparisonSamplerImpl,
   TgpuLaidOutSamplerImpl,
   type TgpuSampler,
@@ -87,8 +88,13 @@ export type TgpuLayoutStorage = TgpuLayoutEntryBase & {
 };
 
 export type TgpuLayoutSampler = TgpuLayoutEntryBase & {
-  sampler: GPUSamplerBindingType;
+  sampler: 'filtering' | 'non-filtering';
 };
+
+export type TgpuLayoutComparisonSampler = TgpuLayoutEntryBase & {
+  sampler: 'comparison';
+};
+
 export type TgpuLayoutTexture<
   TSampleType extends GPUTextureSampleType = GPUTextureSampleType,
 > = TgpuLayoutEntryBase & {
@@ -126,6 +132,7 @@ export type TgpuLayoutEntry =
   | TgpuLayoutUniform
   | TgpuLayoutStorage
   | TgpuLayoutSampler
+  | TgpuLayoutComparisonSampler
   | TgpuLayoutTexture
   | TgpuLayoutStorageTexture
   | TgpuLayoutExternalTexture;
@@ -265,24 +272,26 @@ export type LayoutEntryToInput<T extends TgpuLayoutEntry | null> =
           | (TgpuBuffer<UnwrapRuntimeConstructor<T['storage']>> & Storage)
           | GPUBuffer
       : T extends TgpuLayoutSampler
-        ? GPUSampler
-        : T extends TgpuLayoutTexture
-          ?
-              | GPUTextureView
-              | (Sampled &
-                  TgpuTexture<
-                    Prettify<TextureProps & GetTextureRestriction<T>>
-                  >)
-          : T extends TgpuLayoutStorageTexture
+        ? TgpuSampler | GPUSampler
+        : T extends TgpuLayoutComparisonSampler
+          ? TgpuComparisonSampler | GPUSampler
+          : T extends TgpuLayoutTexture
             ?
                 | GPUTextureView
-                | (Storage &
+                | (Sampled &
                     TgpuTexture<
-                      Prettify<TextureProps & GetStorageTextureRestriction<T>>
+                      Prettify<TextureProps & GetTextureRestriction<T>>
                     >)
-            : T extends TgpuLayoutExternalTexture
-              ? GPUExternalTexture
-              : never;
+            : T extends TgpuLayoutStorageTexture
+              ?
+                  | GPUTextureView
+                  | (Storage &
+                      TgpuTexture<
+                        Prettify<TextureProps & GetStorageTextureRestriction<T>>
+                      >)
+              : T extends TgpuLayoutExternalTexture
+                ? GPUExternalTexture
+                : never;
 
 export type BindLayoutEntry<T extends TgpuLayoutEntry | null> =
   T extends TgpuLayoutUniform
@@ -291,14 +300,16 @@ export type BindLayoutEntry<T extends TgpuLayoutEntry | null> =
       ? StorageUsageForEntry<T>
       : T extends TgpuLayoutSampler
         ? TgpuSampler
-        : T extends TgpuLayoutTexture
-          ? TgpuSampledTexture<
-              Default<GetDimension<T['viewDimension']>, '2d'>,
-              ChannelFormatToSchema[T['texture']]
-            >
-          : T extends TgpuLayoutStorageTexture
-            ? StorageTextureUsageForEntry<T>
-            : never;
+        : T extends TgpuLayoutComparisonSampler
+          ? TgpuComparisonSampler
+          : T extends TgpuLayoutTexture
+            ? TgpuSampledTexture<
+                Default<GetDimension<T['viewDimension']>, '2d'>,
+                ChannelFormatToSchema[T['texture']]
+              >
+            : T extends TgpuLayoutStorageTexture
+              ? StorageTextureUsageForEntry<T>
+              : never;
 
 export type TgpuBindGroup<
   Entries extends Record<string, TgpuLayoutEntry | null> = Record<

packages/typegpu/tests/bindGroupLayout.test.ts

@@ -23,9 +23,12 @@ import tgpu, {
 } from '../src/experimental';
 import './utils/webgpuGlobals';
 import { parse } from 'tgpu-wgsl-parser';
+import { comparisonSampler, sampler } from '../src/core/sampler/sampler';
 import {
   MissingBindingError,
   type TgpuBindGroup,
+  type TgpuLayoutComparisonSampler,
+  type TgpuLayoutSampler,
   type UnwrapRuntimeConstructor,
   bindGroupLayout,
 } from '../src/tgpuBindGroupLayout';
@@ -283,7 +286,7 @@ describe('TgpuBindGroup', () => {
   });
 
   describe('filtering sampler layout', () => {
-    let layout: TgpuBindGroupLayout<{ foo: { sampler: 'filtering' } }>;
+    let layout: TgpuBindGroupLayout<{ foo: TgpuLayoutSampler }>;
 
     beforeEach(() => {
       layout = tgpu
@@ -315,6 +318,84 @@ describe('TgpuBindGroup', () => {
         ],
       });
     });
+
+    it('accepts filtering/non-filtering sampler when creating bind group, but not comparison', ({
+      root,
+    }) => {
+      root.createBindGroup(layout, {
+        foo: sampler({ minFilter: 'linear' }),
+      });
+
+      root.createBindGroup(layout, {
+        foo: sampler({ minFilter: 'nearest' }),
+      });
+
+      root.createBindGroup(layout, {
+        foo: root.device.createSampler(),
+      });
+
+      root.createBindGroup(layout, {
+        // @ts-expect-error
+        foo: comparisonSampler({ compare: 'less' }),
+      });
+    });
+  });
+
+  describe('comparison sampler layout', () => {
+    let layout: TgpuBindGroupLayout<{ foo: TgpuLayoutComparisonSampler }>;
+
+    beforeEach(() => {
+      layout = tgpu
+        .bindGroupLayout({
+          foo: { sampler: 'comparison' },
+        })
+        .$name('example');
+    });
+
+    it('populates a simple layout with a raw sampler', ({ root }) => {
+      const sampler = root.device.createSampler();
+
+      const bindGroup = root.createBindGroup(layout, {
+        foo: sampler,
+      });
+
+      expect(root.device.createBindGroupLayout).not.toBeCalled();
+      root.unwrap(bindGroup);
+      expect(root.device.createBindGroupLayout).toBeCalled();
+
+      expect(root.device.createBindGroup).toBeCalledWith({
+        label: 'example',
+        layout: root.unwrap(layout),
+        entries: [
+          {
+            binding: 0,
+            resource: sampler,
+          },
+        ],
+      });
+    });
+
+    it('accepts comparison sampler when creating bind group, but not filtering/non-filtering', ({
+      root,
+    }) => {
+      root.createBindGroup(layout, {
+        foo: comparisonSampler({ compare: 'equal' }),
+      });
+
+      root.createBindGroup(layout, {
+        foo: root.device.createSampler(),
+      });
+
+      root.createBindGroup(layout, {
+        // @ts-expect-error
+        foo: sampler({ minFilter: 'linear' }),
+      });
+
+      root.createBindGroup(layout, {
+        // @ts-expect-error
+        foo: sampler({ minFilter: 'nearest' }),
+      });
+    });
   });
 
   describe('texture layout', () => {