Struct vulkano::deferred::DeferredOperation

pub struct DeferredOperation { /* private fields */ }

An operation on the host that has been deferred.

The object cannot be dropped while an operation is pending. If it is dropped prematurely, the current thread will block to wait for the operation to finish.

Implementations

impl DeferredOperation

pub fn new(device: Arc<Device>) -> Result<Arc<Self>, Validated<VulkanError>>

Creates a new DeferredOperation.

The khr_deferred_host_operations extension must be enabled on the device.

pub unsafe fn from_handle( device: Arc<Device>, handle: DeferredOperationKHR ) -> Arc<Self>

Creates a new DeferredOperation from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.

pub fn join(&self) -> Result<DeferredOperationJoinStatus, VulkanError>

Executes a portion of the operation on the current thread.

pub fn result(&self) -> Option<Result<(), VulkanError>>

Returns the result of the operation, or None if the operation is not yet complete.

pub fn wait(&self) -> Result<Result<(), VulkanError>, VulkanError>

Waits for the operation to complete, then returns its result.

pub fn max_concurrency(&self) -> Option<u32>

The maximum number of threads that could usefully execute the operation at this point in its execution, or zero if the operation is complete.

Returns None if no exact number of threads can be calculated.

Trait Implementations

impl Debug for DeferredOperation

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

Formats the value using the given formatter.

impl DeviceOwned for DeferredOperation

fn device(&self) -> &Arc<Device>

Returns the device that owns self.

impl Drop for DeferredOperation

fn drop(&mut self)

Executes the destructor for this type.

impl VulkanObject for DeferredOperation

type Handle = DeferredOperationKHR

The type of the object.

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

Returns the raw Vulkan handle of the object.