Skip to content

docs: correct BlasAabbGeometry stride reference and document AABB layout - #9934

Merged
Vecvec merged 1 commit into
gfx-rs:trunkfrom
mstampfli:docs/aabb-geometry-stride-and-layout
Jul 25, 2026
Merged

docs: correct BlasAabbGeometry stride reference and document AABB layout#9934
Vecvec merged 1 commit into
gfx-rs:trunkfrom
mstampfli:docs/aabb-geometry-stride-and-layout

Conversation

@mstampfli

Copy link
Copy Markdown
Contributor

Connections
None.

Description
BlasAabbGeometry's documentation referred to a size.stride field, but BlasAABBGeometrySizeDescriptor (the size sub-descriptor) has no stride field - the stride lives on BlasAabbGeometry itself. This fixes the two stale references and documents the packed AABB buffer layout (minimum then maximum corner, two consecutive vec3<f32>, the 24-byte AABB_GEOMETRY_MIN_STRIDE), which was previously only implied by the ray_aabb_compute example.

Testing
Documentation only, no code change; cargo fmt clean and the docs build.

Squash or Rebase?
Squash.

@mstampfli
mstampfli force-pushed the docs/aabb-geometry-stride-and-layout branch 2 times, most recently from 3f8e698 to 1929b28 Compare July 23, 2026 06:15
The BlasAabbGeometry doc referred to a size.stride field, but
BlasAABBGeometrySizeDescriptor has no stride; the stride lives on
BlasAabbGeometry itself. Point the docs at the right field and, while
there, document the packed AABB buffer layout (each primitive is a
minimum then a maximum corner, two consecutive vec3<f32>, the 24-byte
AABB_GEOMETRY_MIN_STRIDE) which was only implied before.

@Vecvec Vecvec left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

#9290 previously had a size.stride, but it was removed, I guess that change didn't carry over to the docs.

Nice to have the layout specified on the buffer as well as on AABB_GEOMETRY_MIN_STRIDE (which is probably more out of the way).

@Vecvec
Vecvec merged commit 4d4c1e1 into gfx-rs:trunk Jul 25, 2026
60 checks passed
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.

2 participants