impr: Simplify pipelines with method #1767
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
pkg.pr.new packages benchmark commit |
There was a problem hiding this comment.
Pull Request Overview
This PR simplifies the pipeline API by introducing single-argument with method overloads that accept only a bind group, making the API more ergonomic while maintaining backward compatibility with the existing layout + bind group pattern.
- Adds single-argument
withmethod overloads for both compute and render pipelines that accept only a bind group - Deprecates the existing two-argument
withmethod overloads - Updates error messages, examples, and documentation to reflect the simplified API
Reviewed Changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/typegpu/src/core/pipeline/computePipeline.ts | Adds single-argument with overload and implementation for compute pipelines |
| packages/typegpu/src/core/pipeline/renderPipeline.ts | Adds single-argument with overload and implementation for render pipelines |
| packages/typegpu/src/prepareDispatch.ts | Updates prepareDispatch API to use simplified with method |
| packages/typegpu/src/errors.ts | Updates error message to reflect new API |
| packages/typegpu/tests/*.test.ts | Updates tests to use new API and adds type checking tests |
| apps/typegpu-docs/src/examples/**/*.ts | Updates all examples to use simplified API |
| apps/typegpu-docs/src/content/docs/**/*.mdx | Updates documentation to reflect new API |
| packages/typegpu-noise/src/**/dynamic-cache.ts | Updates noise package examples |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
aleksanderkatan
requested review from
iwoplaza,
reczkok,
lursz and
cieplypolar
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1727.
Closes #1750.
withmethods.compute.withoverload.withoverloads.withoverloads.prepareDispatchAPI.There is some code duplication, but I think it's fine since it will disappear once we remove the deprecated implementations.