Skip to content
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

Document that various sizes and offsets are in bytes. #3773

Merged

Conversation

jimblandy
Copy link
Member

@jimblandy jimblandy commented May 14, 2023

Document that the following are in bytes:

  • BindingType::Buffer::min_binding_size
  • BufferBinding::offset
  • BufferBinding::size
  • BufferDescriptor::size

Clarify other requirements as well.

Fixes #3768.

Checklist

  • Run cargo clippy.
  • Run RUSTFLAGS=--cfg=web_sys_unstable_apis cargo clippy --target wasm32-unknown-unknown if applicable.
  • Add change to CHANGELOG.md. See simple instructions inside file.

Document that the following are in bytes:
- `BindingType::Buffer::min_binding_size`
- `BufferBinding::offset`
- `BufferBinding::size`
- `BufferDescriptor::size`

Clarify other requirements as well.

Fixes gfx-rs#3768.
@jimblandy jimblandy force-pushed the document-alignment-by-byte-wgpu-3768 branch from f85e8d9 to 54377ed Compare May 14, 2023 01:10
Copy link
Member

@cwfitzgerald cwfitzgerald left a comment

Choose a reason for hiding this comment

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

Very nice

@cwfitzgerald cwfitzgerald added the PR: needs back-porting PR with a fix that needs to land on crates label May 14, 2023
Copy link
Member

@cwfitzgerald cwfitzgerald left a comment

Choose a reason for hiding this comment

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

Damn they moved the approve button

@cwfitzgerald cwfitzgerald merged commit 3563849 into gfx-rs:trunk May 14, 2023
@cwfitzgerald cwfitzgerald removed the PR: needs back-porting PR with a fix that needs to land on crates label Sep 27, 2023
@jimblandy jimblandy deleted the document-alignment-by-byte-wgpu-3768 branch December 13, 2023 16:40
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.

Specify size is in bytes for buffer documentation
2 participants