Skip to content
New issue

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

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

Already on GitHub? # to your account

Typo in PrimaryCommandBufferAbstract docs? #2129

Closed
thanatos opened this issue Jan 14, 2023 · 1 comment
Closed

Typo in PrimaryCommandBufferAbstract docs? #2129

thanatos opened this issue Jan 14, 2023 · 1 comment

Comments

@thanatos
Copy link
Contributor

Template

If you dont understand something just leave it.
If you can provide more detailed information than the template allows for, please ignore the template and present all of your findings.

  • Version of vulkano: 0.32.3
  • OS: (the docs)
  • GPU (the selected PhysicalDevice): N/A
  • GPU Driver: N/A
  • Upload of a reasonably minimal complete main.rs file that demonstrates the issue: N/A

Issue

The docs for PrimaryCommandBufferAbstract::execute, as well as PrimaryCommandBufferAbstract::execute_after read:

The command buffer is not actually executed until you call flush() on the object. You are encouraged to chain together as many futures as possible before calling flush(), and call .then_signal_future() before doing so. Note however that once you called execute() there is no way to cancel the execution, even if you didn’t flush yet.

There doesn't seem to be any method then_signal_future; this is probably meant to refer to one or all of the then_signal_fence(_*) or then_signal_semaphore(_*) methods.

(There's also some grammatical errors towards the end of the paragraph; I've sent #2128 for those. However, I'm not sure how the bits around "then_signal_future are supposed to read, so I didn't fix those, and hence, put that in this issue.)

@Rua
Copy link
Contributor

Rua commented Jan 15, 2023

Yeah that looks like a mistake, it should be then_signal_fence. Can you fix it as part of your PR?

thanatos added a commit to thanatos/vulkano that referenced this issue Feb 20, 2023
Rua pushed a commit that referenced this issue Mar 2, 2023
* Minor touch-ups to the docs for `PrimaryCommandBufferAbstract`

* Rewrite this passage to address the comments in #2129
@Rua Rua closed this as completed Mar 3, 2023
hakolao pushed a commit to hakolao/vulkano that referenced this issue Feb 20, 2024
…no-rs#2128)

* Minor touch-ups to the docs for `PrimaryCommandBufferAbstract`

* Rewrite this passage to address the comments in vulkano-rs#2129
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants