Enum rafx_api::RafxFence

source · 
pub enum RafxFence {
    Empty(RafxFenceEmpty),
}
Expand description

A GPU -> CPU synchronization mechanism.

A fence can be in the following states:

  • Unsubmitted - Initial state when created
  • Incomplete - Once a command buffer is submitted, the fence is marked as incomplete
  • Complete - The GPU can mark a fence as complete to signal completion of work.

The status of the fence returns to Unsubmitted when get_fence_status() is called while in a completed state. In other words, the Complete status can only be returned one time unless the fence is submitted again.

Fences must not be dropped if they are in use by the GPU.

Variants§

§

Empty(RafxFenceEmpty)

Implementations§

source§

impl RafxFence

source

pub fn get_fence_status(&self) -> RafxResult<RafxFenceStatus>

Get the status of the fence. See RafxFenceStatus

The status of the fence returns to Unsubmitted when get_fence_status() is called while in a completed state. In other words, the Complete status can only be returned one time unless the fence is submitted again.

source

pub fn wait(&self) -> RafxResult<()>

Wait for the fence to be signaled as complete by the GPU

source

pub fn empty_fence(&self) -> Option<&RafxFenceEmpty>

Get the underlying metal API object. This provides access to any internally created metal objects.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Resource for T
where T: Downcast + Send + Sync,