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

[core] Document command encoding and command buffers. #5516

Merged
merged 1 commit into from
Apr 15, 2024
Merged

[core] Document command encoding and command buffers. #5516

merged 1 commit into from
Apr 15, 2024

Conversation

jimblandy
Copy link
Member

Flesh out the documentation for wgpu_core's CommandBuffer, CommandEncoder, and associated types.

@jimblandy jimblandy requested a review from a team as a code owner April 10, 2024 20:28
@jimblandy jimblandy marked this pull request as draft April 10, 2024 22:55
@jimblandy jimblandy marked this pull request as ready for review April 12, 2024 20:03
@jimblandy jimblandy force-pushed the core-document-command-buffer-encoder branch from baa5525 to 04521da Compare April 12, 2024 20:03
@jimblandy
Copy link
Member Author

It may look weird that this requirement got deleted from Queue::submit's documentation in wgpu_hal/src/lib.rs:

  • all of the command buffers had CommandBuffer::finish() called.

However, there is no longer any method named finish (or any methods on CommandBuffer at all). With the current CommandEncoder trait, it's not possible to obtain a CommandBuffer at all until it's been finished.

@jimblandy jimblandy force-pushed the core-document-command-buffer-encoder branch from 04521da to 3ea873a Compare April 12, 2024 20:11
Wumpf
Wumpf approved these changes Apr 14, 2024
View reviewed changes
Copy link
Member

@Wumpf Wumpf left a comment •
edited
Loading

Choose a reason for hiding this comment

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

nice! even learned a few new things while reading
looks like a lot of things could be named better

wgpu-core/src/command/mod.rs Outdated Show resolved Hide resolved
@jimblandy jimblandy force-pushed the core-document-command-buffer-encoder branch 3 times, most recently from 6dfdbb1 to 93ac7b7 Compare April 14, 2024 22:30
@jimblandy
[core] Document command encoding and command buffers.
a3bc86d 
Flesh out the documentation for `wgpu_core`'s `CommandBuffer`,
`CommandEncoder`, and associated types.

Allow doc links to private items. `wgpu-core` isn't entirely
user-facing, so it's useful to document internal items.
@jimblandy jimblandy force-pushed the core-document-command-buffer-encoder branch from 93ac7b7 to a3bc86d Compare April 14, 2024 22:31
@jimblandy jimblandy merged commit c9212c6 into gfx-rs:trunk Apr 15, 2024
25 checks passed
@jimblandy jimblandy deleted the core-document-command-buffer-encoder branch April 15, 2024 03:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Wumpf Wumpf Wumpf approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jimblandy @Wumpf