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.

Sign up for GitHub

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

Jump to bottom

Specify size is in bytes for buffer documentation #3768

Closed
JMS55 opened this issue May 11, 2023 · 2 comments · Fixed by #3773
Closed

Specify size is in bytes for buffer documentation #3768

JMS55 opened this issue May 11, 2023 · 2 comments · Fixed by #3773
Labels
area: documentation Documentation for crate items, public or private good first issue Good for newcomers help required We need community help to make this happen. type: enhancement New feature or request

Comments

@JMS55
Copy link
Collaborator

JMS55 commented May 11, 2023

These two fields should specify that they're the size in bytes.

https://docs.rs/wgpu/latest/wgpu/enum.BindingType.html#variant.Buffer.field.min_binding_size

https://docs.rs/wgpu-types/0.16.0/wgpu_types/struct.BufferDescriptor.html#structfield.size
@JMS55 JMS55 changed the title Specify size in bytes for buffer documentation Specify size is in bytes for buffer documentation May 11, 2023
@cwfitzgerald cwfitzgerald added type: enhancement New feature or request help required We need community help to make this happen. good first issue Good for newcomers area: documentation Documentation for crate items, public or private labels May 11, 2023
@jimblandy
Copy link
Member

@JMS55 Are you working on this? If not, I could take care of this.

@JMS55
Copy link
Collaborator Author

JMS55 commented May 13, 2023

I am not. I would love for someone else to tackle this, thank you.

jimblandy added a commit to jimblandy/wgpu that referenced this issue May 14, 2023
@jimblandy
Document that various sizes and offsets are in bytes.
f85e8d9 
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 mentioned this issue May 14, 2023
Merged
3 tasks
jimblandy added a commit to jimblandy/wgpu that referenced this issue May 14, 2023
@jimblandy
Document that various sizes and offsets are in bytes.
54377ed 
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Documentation for crate items, public or private good first issue Good for newcomers help required We need community help to make this happen. type: enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document that various sizes and offsets are in bytes. jimblandy/wgpu
3 participants
@jimblandy @cwfitzgerald @JMS55