Struct vulkano::sync::FenceSignalFuture
source · [−]pub struct FenceSignalFuture<F> where
F: GpuFuture, { /* private fields */ }
Expand description
Represents a fence being signaled after a previous event.
Contrary to most other future types, it is possible to block the current thread until the event
happens. This is done by calling the wait()
function.
Also note that the GpuFuture
trait is implemented on Arc<FenceSignalFuture<_>>
.
This means that you can put this future in an Arc
and keep a copy of it somewhere in order
to know when the execution reached that point.
use std::sync::Arc;
use vulkano::sync::GpuFuture;
// Assuming you have a chain of operations, like this:
// let future = ...
// .then_execute(foo)
// .then_execute(bar)
// You can signal a fence at this point of the chain, and put the future in an `Arc`.
let fence_signal = Arc::new(future.then_signal_fence());
// And then continue the chain:
// fence_signal.clone()
// .then_execute(baz)
// .then_execute(qux)
// Later you can wait until you reach the point of `fence_signal`:
fence_signal.wait(None).unwrap();
Implementations
sourceimpl<F> FenceSignalFuture<F> where
F: GpuFuture,
impl<F> FenceSignalFuture<F> where
F: GpuFuture,
sourcepub fn wait(&self, timeout: Option<Duration>) -> Result<(), FlushError>
pub fn wait(&self, timeout: Option<Duration>) -> Result<(), FlushError>
Blocks the current thread until the fence is signaled by the GPU. Performs a flush if necessary.
If timeout
is None
, then the wait is infinite. Otherwise the thread will unblock after
the specified timeout has elapsed and an error will be returned.
If the wait is successful, this function also cleans any resource locked by previous submissions.
Trait Implementations
sourceimpl<F> DeviceOwned for FenceSignalFuture<F> where
F: GpuFuture,
impl<F> DeviceOwned for FenceSignalFuture<F> where
F: GpuFuture,
sourceimpl<F> Drop for FenceSignalFuture<F> where
F: GpuFuture,
impl<F> Drop for FenceSignalFuture<F> where
F: GpuFuture,
sourceimpl<F> GpuFuture for FenceSignalFuture<F> where
F: GpuFuture,
impl<F> GpuFuture for FenceSignalFuture<F> where
F: GpuFuture,
sourcefn cleanup_finished(&mut self)
fn cleanup_finished(&mut self)
If possible, checks whether the submission has finished. If so, gives up ownership of the resources used by these submissions. Read more
sourceunsafe fn build_submission(&self) -> Result<SubmitAnyBuilder<'_>, FlushError>
unsafe fn build_submission(&self) -> Result<SubmitAnyBuilder<'_>, FlushError>
Builds a submission that, if submitted, makes sure that the event represented by this
GpuFuture
will happen, and possibly contains extra elements (eg. a semaphore wait or an
event wait) that makes the dependency with subsequent operations work. Read more
sourcefn flush(&self) -> Result<(), FlushError>
fn flush(&self) -> Result<(), FlushError>
Flushes the future and submits to the GPU the actions that will permit this future to occur. Read more
sourceunsafe fn signal_finished(&self)
unsafe fn signal_finished(&self)
Sets the future to its “complete” state, meaning that it can safely be destroyed. Read more
sourcefn queue_change_allowed(&self) -> bool
fn queue_change_allowed(&self) -> bool
Returns true
if elements submitted after this future can be submitted to a different
queue than the other returned by queue()
. Read more
sourcefn queue(&self) -> Option<Arc<Queue>>
fn queue(&self) -> Option<Arc<Queue>>
Returns the queue that triggers the event. Returns None
if unknown or irrelevant. Read more
sourcefn check_buffer_access(
&self,
buffer: &dyn BufferAccess,
exclusive: bool,
queue: &Queue
) -> Result<Option<(PipelineStages, AccessFlags)>, AccessCheckError>
fn check_buffer_access(
&self,
buffer: &dyn BufferAccess,
exclusive: bool,
queue: &Queue
) -> Result<Option<(PipelineStages, AccessFlags)>, AccessCheckError>
Checks whether submitting something after this future grants access (exclusive or shared, depending on the parameter) to the given buffer on the given queue. Read more
sourcefn check_image_access(
&self,
image: &dyn ImageAccess,
layout: ImageLayout,
exclusive: bool,
queue: &Queue
) -> Result<Option<(PipelineStages, AccessFlags)>, AccessCheckError>
fn check_image_access(
&self,
image: &dyn ImageAccess,
layout: ImageLayout,
exclusive: bool,
queue: &Queue
) -> Result<Option<(PipelineStages, AccessFlags)>, AccessCheckError>
Checks whether submitting something after this future grants access (exclusive or shared, depending on the parameter) to the given image on the given queue. Read more
sourcefn join<F>(self, other: F) -> JoinFuture<Self, F> where
Self: Sized,
F: GpuFuture,
fn join<F>(self, other: F) -> JoinFuture<Self, F> where
Self: Sized,
F: GpuFuture,
Joins this future with another one, representing the moment when both events have happened.
sourcefn then_execute<Cb>(
self,
queue: Arc<Queue>,
command_buffer: Cb
) -> Result<CommandBufferExecFuture<Self, Cb>, CommandBufferExecError> where
Self: Sized,
Cb: PrimaryCommandBuffer + 'static,
fn then_execute<Cb>(
self,
queue: Arc<Queue>,
command_buffer: Cb
) -> Result<CommandBufferExecFuture<Self, Cb>, CommandBufferExecError> where
Self: Sized,
Cb: PrimaryCommandBuffer + 'static,
Executes a command buffer after this future. Read more
sourcefn then_execute_same_queue<Cb>(
self,
command_buffer: Cb
) -> Result<CommandBufferExecFuture<Self, Cb>, CommandBufferExecError> where
Self: Sized,
Cb: PrimaryCommandBuffer + 'static,
fn then_execute_same_queue<Cb>(
self,
command_buffer: Cb
) -> Result<CommandBufferExecFuture<Self, Cb>, CommandBufferExecError> where
Self: Sized,
Cb: PrimaryCommandBuffer + 'static,
Executes a command buffer after this future, on the same queue as the future. Read more
sourcefn then_signal_semaphore(self) -> SemaphoreSignalFuture<Self> where
Self: Sized,
fn then_signal_semaphore(self) -> SemaphoreSignalFuture<Self> where
Self: Sized,
Signals a semaphore after this future. Returns another future that represents the signal. Read more
sourcefn then_signal_semaphore_and_flush(
self
) -> Result<SemaphoreSignalFuture<Self>, FlushError> where
Self: Sized,
fn then_signal_semaphore_and_flush(
self
) -> Result<SemaphoreSignalFuture<Self>, FlushError> where
Self: Sized,
Signals a semaphore after this future and flushes it. Returns another future that represents the moment when the semaphore is signalled. Read more
sourcefn then_signal_fence(self) -> FenceSignalFuture<Self> where
Self: Sized,
fn then_signal_fence(self) -> FenceSignalFuture<Self> where
Self: Sized,
Signals a fence after this future. Returns another future that represents the signal. Read more
sourcefn then_signal_fence_and_flush(
self
) -> Result<FenceSignalFuture<Self>, FlushError> where
Self: Sized,
fn then_signal_fence_and_flush(
self
) -> Result<FenceSignalFuture<Self>, FlushError> where
Self: Sized,
Signals a fence after this future. Returns another future that represents the signal. Read more
sourcefn then_swapchain_present<W>(
self,
queue: Arc<Queue>,
swapchain: Arc<Swapchain<W>>,
image_index: usize
) -> PresentFuture<Self, W> where
Self: Sized,
fn then_swapchain_present<W>(
self,
queue: Arc<Queue>,
swapchain: Arc<Swapchain<W>>,
image_index: usize
) -> PresentFuture<Self, W> where
Self: Sized,
Presents a swapchain image after this future. Read more
sourcefn then_swapchain_present_incremental<W>(
self,
queue: Arc<Queue>,
swapchain: Arc<Swapchain<W>>,
image_index: usize,
present_region: PresentRegion
) -> PresentFuture<Self, W> where
Self: Sized,
fn then_swapchain_present_incremental<W>(
self,
queue: Arc<Queue>,
swapchain: Arc<Swapchain<W>>,
image_index: usize,
present_region: PresentRegion
) -> PresentFuture<Self, W> where
Self: Sized,
Same as then_swapchain_present
, except it allows specifying a present region. Read more
sourcefn boxed(self) -> Box<dyn GpuFuture> where
Self: Sized + 'static,
fn boxed(self) -> Box<dyn GpuFuture> where
Self: Sized + 'static,
Turn the current future into a Box<dyn GpuFuture>
. Read more
sourcefn boxed_send(self) -> Box<dyn GpuFuture + Send> where
Self: Sized + Send + 'static,
fn boxed_send(self) -> Box<dyn GpuFuture + Send> where
Self: Sized + Send + 'static,
Turn the current future into a Box<dyn GpuFuture + Send>
. Read more
Auto Trait Implementations
impl<F> RefUnwindSafe for FenceSignalFuture<F>
impl<F> Send for FenceSignalFuture<F> where
F: Send,
impl<F> Sync for FenceSignalFuture<F> where
F: Send,
impl<F> Unpin for FenceSignalFuture<F> where
F: Unpin,
impl<F> UnwindSafe for FenceSignalFuture<F>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more