Struct rendy_command::Fence

pub struct Fence<B: Backend> { /* fields omitted */ }

Fence wrapper.

Methods

impl<B> Fence<B> where
    B: Backend, 

pub fn new(
    device: &impl Device<B>,
    signaled: bool
) -> Result<Self, OutOfMemory>

Create new fence in signaled or unsignaled state.

pub fn is_submitted(&self) -> bool

Check if fence was submitted.

pub fn is_signaled(&self) -> bool

Check if fence is signaled.

pub fn is_unsignaled(&self) -> bool

Check if fence is unsignaled. It can be submitted as well.

pub unsafe fn reset(
    &mut self,
    device: &impl Device<B>
) -> Result<(), OutOfMemory>

Reset signaled fence. Panics if not signaled. Becomes unsigneled.

pub unsafe fn mark_reset(&mut self)

Mark signaled fence as reset. Panics if not signaled. Becomes unsigneled. Fence must be reset using raw fence value.

pub unsafe fn mark_signaled(&mut self) -> FenceEpoch

Mark fence as signaled. Panics if not submitted. Fence must be checked to be signaled using raw fence value.

pub unsafe fn wait_signaled(
    &mut self,
    device: &impl Device<B>,
    timeout_ns: u64
) -> Result<Option<FenceEpoch>, OomOrDeviceLost>

Wait for fence to become signaled. Panics if not submitted. Returns submission epoch on success.

pub unsafe fn check_signaled(
    &mut self,
    device: &impl Device<B>
) -> Result<Option<FenceEpoch>, DeviceLost>

Check if fence has became signaled. Panics if not submitted. Returns submission epoch on success.

pub fn raw(&self) -> &B::Fence

Get raw fence reference. Use mark_* functions to reflect stage changes.

pub fn epoch(&self) -> FenceEpoch

Get submission epoch. Panics if not submitted.

pub fn into_inner(self) -> B::Fence

Unwrap raw fence value. Panics if submitted.

Trait Implementations

impl<B: Debug + Backend> Debug for Fence<B> where
    B::Fence: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.