[−][src]Struct bedrock::Fence

pub struct Fence(pub VkFence, _);

Opaque handle to a fence object

Methods

impl Fence[src]

Following methods are enabled with [feature = "Implements"]

pub fn new(device: &Device, signaled: bool) -> Result<Self>[src]

Create a new fence object

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY

impl Fence[src]

Following methods are enabled with [feature = "Implements"]

pub fn wait_multiple(
    objects: &[&Self],
    wait_all: bool,
    timeout: Option<u64>
) -> Result<bool>[src]

Wait for one or more fences to become signaled, returns Ok(true) if operation is timed out

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_DEVICE_LOST

pub fn wait_timeout(&self, timeout: u64) -> Result<bool>[src]

Wait for a fence to become signaled, returns Ok(true) if operation is timed out

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_DEVICE_LOST

pub fn reset_multiple(objects: &[&Self]) -> Result<()>[src]

Resets one or more fence objects

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn reset(&self) -> Result<()>[src]

Resets a fence object

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY

Trait Implementations

impl DeviceChild for Fence[src]

impl Drop for Fence[src]

impl<'s> From<&'s Fence> for CompletionHandler<'s>[src]

impl Send for Fence[src]

impl Status for Fence[src]

impl Sync for Fence[src]

impl VkHandle for Fence[src]

type Handle = VkFence

impl Waitable for Fence[src]

fn wait(&self) -> Result<()>[src]

[feature = "Implements"] Wait for a fence to become signaled

Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_DEVICE_LOST

Auto Trait Implementations

impl !RefUnwindSafe for Fence

impl Unpin for Fence

impl !UnwindSafe for Fence

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.