[−][src]Struct vulkano::sync::Fence
A fence is used to know when a command buffer submission has finished its execution.
When a command buffer accesses a resource, you have to ensure that the CPU doesn't access the same resource simultaneously (except for concurrent reads). Therefore in order to know when the CPU can access a resource again, a fence has to be used.
Methods
impl<D> Fence<D> where
D: SafeDeref<Target = Device>,
[src]
D: SafeDeref<Target = Device>,
pub fn from_pool(device: D) -> Result<Fence<D>, OomError>
[src]
Takes a fence from the vulkano-provided fence pool.
If the pool is empty, a new fence will be allocated.
Upon drop
, the fence is put back into the pool.
For most applications, using the fence pool should be preferred, in order to avoid creating new fences every frame.
pub fn alloc(device: D) -> Result<Fence<D>, OomError>
[src]
Builds a new fence.
pub fn alloc_signaled(device: D) -> Result<Fence<D>, OomError>
[src]
Builds a new fence in signaled state.
pub fn ready(&self) -> Result<bool, OomError>
[src]
Returns true if the fence is signaled.
pub fn wait(&self, timeout: Option<Duration>) -> Result<(), FenceWaitError>
[src]
Waits until the fence is signaled, or at least until the timeout duration has elapsed.
Returns Ok
if the fence is now signaled. Returns Err
if the timeout was reached instead.
If you pass a duration of 0, then the function will return without blocking.
pub fn multi_wait<'a, I>(
iter: I,
timeout: Option<Duration>
) -> Result<(), FenceWaitError> where
I: IntoIterator<Item = &'a Fence<D>>,
D: 'a,
[src]
iter: I,
timeout: Option<Duration>
) -> Result<(), FenceWaitError> where
I: IntoIterator<Item = &'a Fence<D>>,
D: 'a,
pub fn reset(&mut self) -> Result<(), OomError>
[src]
Resets the fence.
pub fn multi_reset<'a, I>(iter: I) -> Result<(), OomError> where
I: IntoIterator<Item = &'a mut Fence<D>>,
D: 'a,
[src]
I: IntoIterator<Item = &'a mut Fence<D>>,
D: 'a,
Trait Implementations
impl<D: Debug> Debug for Fence<D> where
D: SafeDeref<Target = Device>,
[src]
D: SafeDeref<Target = Device>,
impl DeviceOwned for Fence
[src]
impl<D> Drop for Fence<D> where
D: SafeDeref<Target = Device>,
[src]
D: SafeDeref<Target = Device>,
impl<D> VulkanObject for Fence<D> where
D: SafeDeref<Target = Device>,
[src]
D: SafeDeref<Target = Device>,
type Object = Fence
The type of the object.
const TYPE: ObjectType
[src]
fn internal_object(&self) -> Fence
[src]
Auto Trait Implementations
impl<D> RefUnwindSafe for Fence<D> where
D: RefUnwindSafe,
D: RefUnwindSafe,
impl<D> Send for Fence<D> where
D: Send,
D: Send,
impl<D> Sync for Fence<D> where
D: Sync,
D: Sync,
impl<D> Unpin for Fence<D> where
D: Unpin,
D: Unpin,
impl<D> UnwindSafe for Fence<D> where
D: UnwindSafe,
D: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Content for T
[src]
fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
fn is_size_suitable(usize) -> bool
[src]
fn indiv_size() -> usize
[src]
impl<T> DeviceOwned for T where
T: Deref,
<T as Deref>::Target: DeviceOwned,
[src]
T: Deref,
<T as Deref>::Target: DeviceOwned,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,