fix(breaking): shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice by iwoplaza · Pull Request #2745 · software-mansion/TypeGPU

iwoplaza · 2026-07-20T10:13:52Z

No description provided.

github-actions · 2026-07-20T10:16:38Z

Resolution Time Benchmark

---
config:
  themeVariables:
    xyChart:
      plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
  title "Random Branching (🔴 PR | 🔵 main | 🟢 release)"
  x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
  y-axis "time (ms)"
  line [0.92, 1.83, 4.27, 6.32, 7.40, 11.85, 21.65, 23.59]
  line [0.96, 1.95, 4.39, 5.84, 7.60, 11.61, 22.36, 23.59]
  line [0.88, 1.86, 4.53, 6.82, 7.56, 12.26, 22.05, 24.59]

---
config:
  themeVariables:
    xyChart:
      plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
  title "Linear Recursion (🔴 PR | 🔵 main | 🟢 release)"
  x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
  y-axis "time (ms)"
  line [0.33, 0.51, 0.64, 0.79, 1.10, 1.19, 1.36, 1.51]
  line [0.28, 0.46, 0.68, 0.83, 1.08, 1.21, 1.38, 1.54]
  line [0.35, 0.53, 0.70, 0.79, 1.14, 1.14, 1.41, 1.57]

---
config:
  themeVariables:
    xyChart:
      plotColorPalette: "#E63946, #3B82F6, #059669"
---
xychart
  title "Full Tree (🔴 PR | 🔵 main | 🟢 release)"
  x-axis "max depth" [1, 2, 3, 4, 5, 6, 7, 8]
  y-axis "time (ms)"
  line [0.79, 2.09, 4.05, 7.20, 12.10, 26.05, 54.26, 108.72]
  line [0.77, 2.09, 3.81, 6.64, 12.05, 25.26, 54.06, 107.66]
  line [0.88, 2.13, 3.90, 6.51, 13.00, 25.68, 54.76, 111.12]

github-actions · 2026-07-20T10:21:35Z

pkg.pr.new

packages
Ready to be installed by your favorite package manager ⬇️

https://pkg.pr.new/software-mansion/TypeGPU/eslint-plugin-typegpu@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/tgpu-gen@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/tinyest-for-wgsl@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/typegpu@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/cli@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/color@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/gl@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/noise@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/radiance-cascades@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/react@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/sdf@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/three@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

https://pkg.pr.new/software-mansion/TypeGPU/unplugin-typegpu@6d3badc05efe7a58573fa6dcaaaef47f4b15bf00

benchmark
view benchmark

commit
view commit

github-actions · 2026-07-20T10:22:37Z

Bundle size comparison (`import * as ...` in PR vs `import * as ...` in target):

🟢 Decreased	➖ Unchanged	🔴 Increased (max 0.01%)	❔ Unknown
0	301	21	0

`import { ... }` in PR vs `import * as ...` in PR (is the library tree-Shakeable?):

Test	tsdown
tgpu_init.ts	260.02 kB ($${\color{green}-3.2\%}$$)
tgpu_initFromDevice.ts	259.49 kB ($${\color{green}-3.4\%}$$)
tgpu_resolve.ts	165.41 kB ($${\color{green}-38.4\%}$$)
tgpu_resolveWithContext.ts	165.35 kB ($${\color{green}-38.4\%}$$)
tgpu_bindGroupLayout.ts	69.27 kB ($${\color{green}-74.2\%}$$)
tgpu_mutableAccessor.ts	66.27 kB ($${\color{green}-75.3\%}$$)
tgpu_accessor.ts	66.26 kB ($${\color{green}-75.3\%}$$)
tgpu_privateVar.ts	65.61 kB ($${\color{green}-75.6\%}$$)
tgpu_workgroupVar.ts	65.60 kB ($${\color{green}-75.6\%}$$)
tgpu_const.ts	64.85 kB ($${\color{green}-75.9\%}$$)
tgpu_fn.ts	38.45 kB ($${\color{green}-85.7\%}$$)
tgpu_fragmentFn.ts	38.45 kB ($${\color{green}-85.7\%}$$)
tgpu_vertexFn.ts	38.27 kB ($${\color{green}-85.8\%}$$)
tgpu_computeFn.ts	37.97 kB ($${\color{green}-85.9\%}$$)
tgpu_vertexLayout.ts	27.08 kB ($${\color{green}-89.9\%}$$)
tgpu_comptime.ts	14.77 kB ($${\color{green}-94.5\%}$$)
tgpu_unroll.ts	1.66 kB ($${\color{green}-99.4\%}$$)
tgpu_slot.ts	1.54 kB ($${\color{green}-99.4\%}$$)
tgpu_lazy.ts	1.19 kB ($${\color{green}-99.6\%}$$)

If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu.

Copilot

Pull request overview

This PR updates the public initialization options API so that the shader generator hook is explicitly marked unstable by renaming shaderGenerator to unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice.

Changes:

Rename InitOptions.shaderGenerator → InitOptions.unstable_shaderGenerator and wire it through init().
Rename InitFromDeviceOptions.shaderGenerator → InitFromDeviceOptions.unstable_shaderGenerator and wire it through initFromDevice().

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pullfrog

✅ No new issues found.

Reviewed changes — a breaking rename of the shaderGenerator option to unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice.

Renames the public option key in InitOptions and InitFromDeviceOptions to align with the existing unstable_-prefixed experimental options (unstable_names, unstable_logOptions).
Updates destructuring in both entry points to use the new key and passes the value through to TgpuRootImpl unchanged.
Internal shaderGenerator property names on TgpuRootImpl, ExperimentalTgpuRoot, resolve contexts, pipelines, and the GL package remain correctly untouched.

^{｜ View workflow run ｜ Using Kimi K2 (free via Pullfrog for OSS) ｜ 𝕏}

pullfrog

✅ No new issues found.

Reviewed changes — since the prior review, the JSDoc @default for unstable_names was corrected from 'random' to 'strict' in init.ts and tgpuResolve.ts, and init() / initFromDevice() now destructure unstable_logOptions and unstable_shaderGenerator with consistent local aliases.

Fixed the documented default for InitOptions.unstable_names in packages/typegpu/src/core/root/init.ts to match the runtime 'strict' default.
Fixed the documented default for InitFromDeviceOptions.unstable_names in the same file.
Fixed the documented default for TgpuResolveOptions.names in packages/typegpu/src/core/resolve/tgpuResolve.ts.
Refactored destructuring of unstable_logOptions and unstable_shaderGenerator in init() and initFromDevice() to use renamed locals (logOptions, shaderGenerator) before passing them to TgpuRootImpl.

Ran pnpm --filter typegpu test:types successfully.

^{｜ View workflow run ｜ Using Kimi K2 (free via Pullfrog for OSS) ｜ 𝕏}

pullfrog

✅ No new issues found.

Reviewed changes — since the prior review, the branch was rebased onto recent main and a merge commit brought in base-branch updates. The PR's diff is identical to what was already reviewed and approved.

Rebased the unstable_shaderGenerator rename and JSDoc @default fixes onto recent main (no net-new changes).

<!--
Pullfrog review metadata — for any agent (or human-with-agent) reading this
review. Incorporate the fields below into your understanding of the context
this review was made in. The findings below were written against
3f6f1bc; if new commits have landed on fix/unstable-shader-generator-in-root since this review
was submitted, treat any specific bug, file, or line callout as POTENTIALLY
STALE — re-diff against 3f6f1bc (or trigger a fresh review) and
factor commits past 3f6f1bc into your understanding of the current
state before acting on findings.

Mode: IncrementalReview (delta against prior pullfrog review)
Files reviewed: 2
Commits reviewed: 2
Base: main (55bec73)
Head: fix/unstable-shader-generator-in-root (3f6f1bc)
Reviewed commits:
- 3078b10 — fix: shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice
- 3f6f1bc — Merge branch 'main' into fix/unstable-shader-generator-in-root
Prior pullfrog review: 6ae7b41 (#2745 (review))
Submitted at: 2026-07-29T00:00:00Z
-->

^{｜ View workflow run ｜ Using DeepSeek Pro (free via Pullfrog for OSS) (Kimi K2 not used — the program covers this model; add its provider key to run your pick) ｜ 𝕏}

…u.init and tgpu.initFromDevice

iwoplaza changed the title ~~fix: shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice~~ fix(breaking): shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice Jul 20, 2026

iwoplaza force-pushed the fix/unstable-shader-generator-in-root branch from 2c996e4 to 5e68df2 Compare July 20, 2026 10:19

iwoplaza marked this pull request as ready for review July 20, 2026 10:22

Copilot AI review requested due to automatic review settings July 20, 2026 10:22

Copilot started reviewing on behalf of iwoplaza July 20, 2026 10:22 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

Comment thread packages/typegpu/src/core/root/init.ts

Comment thread packages/typegpu/src/core/root/init.ts

pullfrog Bot reviewed Jul 20, 2026

View reviewed changes

iwoplaza force-pushed the fix/unstable-shader-generator-in-root branch 2 times, most recently from 57f2b22 to 6ae7b41 Compare July 21, 2026 14:24

iwoplaza requested review from aleksanderkatan, cieplypolar and reczkok July 21, 2026 14:24

pullfrog Bot reviewed Jul 21, 2026

View reviewed changes

reczkok approved these changes Jul 27, 2026

View reviewed changes

iwoplaza force-pushed the fix/unstable-shader-generator-in-root branch 2 times, most recently from 184d1fd to 3f6f1bc Compare July 29, 2026 08:56

pullfrog Bot reviewed Jul 29, 2026

View reviewed changes

fix: shaderGenerator option should be unstable_shaderGenerator in tgp…

6d3badc

…u.init and tgpu.initFromDevice

iwoplaza force-pushed the fix/unstable-shader-generator-in-root branch from 3f6f1bc to 6d3badc Compare July 30, 2026 20:23

iwoplaza merged commit 8d9b88f into main Jul 30, 2026
8 checks passed

iwoplaza deleted the fix/unstable-shader-generator-in-root branch July 30, 2026 20:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(breaking): shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice - #2745

fix(breaking): shaderGenerator option should be unstable_shaderGenerator in tgpu.init and tgpu.initFromDevice#2745
iwoplaza merged 1 commit into
mainfrom
fix/unstable-shader-generator-in-root

iwoplaza commented Jul 20, 2026

Uh oh!

github-actions Bot commented Jul 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

pullfrog Bot left a comment

Uh oh!

pullfrog Bot left a comment

Uh oh!

pullfrog Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

iwoplaza commented Jul 20, 2026

Uh oh!

github-actions Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Resolution Time Benchmark

Uh oh!

github-actions Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle size comparison (import * as ... in PR vs import * as ... in target):

import { ... } in PR vs import * as ... in PR (is the library tree-Shakeable?):

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 20, 2026 •

edited

Loading

github-actions Bot commented Jul 20, 2026 •

edited

Loading

github-actions Bot commented Jul 20, 2026 •

edited

Loading

Bundle size comparison (`import * as ...` in PR vs `import * as ...` in target):

`import { ... }` in PR vs `import * as ...` in PR (is the library tree-Shakeable?):