[DRAFT] Proposal for a high-level utility module: @typegpu/kit

[iwoplaza]

Note

This is a draft discussion

Questions to answer

• Do we use it in our live examples?
  • Live examples are more-so capability tests and showcases, as well as test beds for new features, not ways for devs to learn base TypeGPU. Imo, we should use @typegpu/kit and other utility modules in our Live Examples.
• Where do we document it?
  • It would be great to be able to use @typegpu/kit in our Fundamentals, just to show quick examples of how a small TypeGPU program can look.

API ideas

Dispatch

An easy way to dispatch a tagged kernel function, without having to construct a compute pipeline.

import { dispatch, dispatch1d, dispatch2d, dispatch3d } from '@typegpu/kit';

dispatch(root, () => {
  'kernel';
  // ...
});

dispatch1d(root, [WIDTH], (idx) => {
  'kernel';
  // ...
});

dispatch2d(root, [WIDTH, HEIGHT], (x, y) => {
  'kernel';
  // ...
});

dispatch3d(root, [WIDTH, HEIGHT, DEPTH], (x, y, z) => {
  'kernel';
  // ...
});

The pipeline could be memoized based on the passed in callback, so if users wanted to call it multiple times, they can save the function somewhere:

const fooKernel = () => {
  'kernel';
  // ...
};

for (let i = 0; i < 16; ++i) {
  // Reuses pipelines & compiled shaders
  dispatch(root, fooKernel);
}

[iwoplaza]

Implemented already