Struct FenceObject

pub struct FenceObject<Device: VkHandle<Handle = VkDevice>>(/* private fields */);

Implementations

impl<Device: VkHandle<Handle = VkDevice>> FenceObject<Device>

pub const unsafe fn manage(handle: VkFence, parent: Device) -> Self

Constructs from raw values

Safety

the resource must be created from the device and not freed anywhere

pub const fn unmanage(self) -> (VkFence, Device)

Purges the construct (Drop will not be called for this resource)

impl<Device: VkHandle<Handle = VkDevice> + Clone> FenceObject<&Device>

pub fn clone_parent(self) -> FenceObject<Device>

Owning parent object by cloning it.

impl<Device: Device> FenceObject<Device>

pub fn new(device: Device, create_info: &FenceCreateInfo<'_>) -> Result<Self>

Create a new fence object

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Trait Implementations

impl<Device: Device> DeviceChild for FenceObject<Device>

type ConcreteDevice = Device

A concrete type of the parent device object.

fn device(&self) -> &Self::ConcreteDevice

Retrieve a reference to a device object that creates this object

impl<Device: VkHandle<Handle = VkDevice>> DeviceChildHandle for FenceObject<Device>

fn device_handle(&self) -> VkDevice

Retrieve a reference to a device handle that creates this objecs

impl<Device: VkHandle<Handle = VkDevice>> Drop for FenceObject<Device>

fn drop(&mut self)

Executes the destructor for this type.

impl<Device: VkHandle<Handle = VkDevice>> Fence for FenceObject<Device>

fn wait_timeout(&self, timeout: u64) -> Result<bool>

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

fn wait(&self) -> Result<()>

Wait for a fence to become signaled

impl<Device: VkHandle<Handle = VkDevice>> FenceMut for FenceObject<Device>

fn reset(&mut self) -> Result<()>

Resets a fence object

impl<Device: VkHandle<Handle = VkDevice>> Status for FenceObject<Device>

fn status(&self) -> Result<bool>

Retrieve the status(whether is signaled or not) of a synchronize object

impl<Device: VkHandle<Handle = VkDevice>> VkHandle for FenceObject<Device>

type Handle = VkFence

fn native_ptr(&self) -> Self::Handle

Retrieve an underlying handle

fn as_transparent_ref(&self) -> VkHandleRef<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkHandleMut for FenceObject<Device>

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut(&mut self) -> VkHandleRefMut<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkObject for FenceObject<Device>

const TYPE: VkObjectType = 7i32

impl<Device: VkHandle<Handle = VkDevice> + Send> Send for FenceObject<Device>

impl<Device: VkHandle<Handle = VkDevice> + Sync> Sync for FenceObject<Device>