Skip to content

Commit

Permalink
Minor touch-ups to the docs for PrimaryCommandBufferAbstract (vulka…
Browse files Browse the repository at this point in the history
…no-rs#2128)

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

* Rewrite this passage to address the comments in vulkano-rs#2129
  • Loading branch information
thanatos authored and hakolao committed Feb 20, 2024
1 parent 991166f commit a2c1738
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions vulkano/src/command_buffer/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,17 @@ pub unsafe trait PrimaryCommandBufferAbstract:

/// Executes this command buffer on a queue.
///
/// This function returns an object that implements the `GpuFuture` trait. See the
/// documentation of the `sync` module for more information.
/// This function returns an object that implements the [`GpuFuture`] trait. See the
/// documentation of the [`future`][crate::sync::future] module for more information.
///
/// 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.
/// The command buffer is not actually executed until you call [`flush()`][GpuFuture::flush] on
/// the future. You are encouraged to chain together as many futures as possible prior to
/// calling [`flush()`][GpuFuture::flush]. In order to know when the future has completed, call
/// one of [`then_signal_fence()`][GpuFuture::then_signal_fence] or
/// [`then_signal_semaphore()`][GpuFuture::then_signal_semaphore]. You can do both together
/// with [`then_signal_fence_and_flush()`][GpuFuture::then_signal_fence_and_flush] or
/// [`then_signal_semaphore_and_flush()`][GpuFuture::then_signal_semaphore_and_flush],
/// respectively.
///
/// > **Note**: In the future this function may return `-> impl GpuFuture` instead of a
/// > concrete type.
Expand All @@ -74,13 +78,17 @@ pub unsafe trait PrimaryCommandBufferAbstract:

/// Executes the command buffer after an existing future.
///
/// This function returns an object that implements the `GpuFuture` trait. See the
/// documentation of the `sync` module for more information.
/// This function returns an object that implements the [`GpuFuture`] trait. See the
/// documentation of the [`future`][crate::sync::future] module for more information.
///
/// 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.
/// The command buffer is not actually executed until you call [`flush()`][GpuFuture::flush] on
/// the future. You are encouraged to chain together as many futures as possible prior to
/// calling [`flush()`][GpuFuture::flush]. In order to know when the future has completed, call
/// one of [`then_signal_fence()`][GpuFuture::then_signal_fence] or
/// [`then_signal_semaphore()`][GpuFuture::then_signal_semaphore]. You can do both together
/// with [`then_signal_fence_and_flush()`][GpuFuture::then_signal_fence_and_flush] or
/// [`then_signal_semaphore_and_flush()`][GpuFuture::then_signal_semaphore_and_flush],
/// respectively.
///
/// > **Note**: In the future this function may return `-> impl GpuFuture` instead of a
/// > concrete type.
Expand Down

0 comments on commit a2c1738

Please # to comment.