Skip to content

docs: index buffers #1496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: release
Choose a base branch
from
Open

docs: index buffers #1496

wants to merge 5 commits into from

Conversation

lursz
Copy link
Contributor

@lursz lursz commented Jul 15, 2025

No description provided.

@lursz lursz changed the base branch from main to release July 15, 2025 11:55
Copy link

github-actions bot commented Jul 15, 2025

pkg.pr.new

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

https://pkg.pr.new/software-mansion/TypeGPU/typegpu@640c886895ff08fed684aa6d78a4c68d6c00c87d
https://pkg.pr.new/software-mansion/TypeGPU/@typegpu/noise@640c886895ff08fed684aa6d78a4c68d6c00c87d
https://pkg.pr.new/software-mansion/TypeGPU/unplugin-typegpu@640c886895ff08fed684aa6d78a4c68d6c00c87d

benchmark
view benchmark

commit
view commit

@lursz lursz linked an issue Jul 15, 2025 that may be closed by this pull request
@lursz lursz marked this pull request as ready for review July 17, 2025 10:37
@lursz lursz requested a review from reczkok July 18, 2025 13:36
Copy link
Contributor

@reczkok reczkok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the content but I think we should create a more visible split between the index buffer explanation and how to use them in index pipelines. In buffers.mdx we should only explain what they are and that they are basically just normal buffers with the INDEX flag (for the purpose of unwrapping). The attachment to pipeline and drawIndexed should't be a part of the buffers guide - we can have a note with a reference to the pipelines guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Document index buffers and drawIndexed API
2 participants