Struct vulkayes_core::queue::Queue

pub struct Queue { /* fields omitted */ }

An internally synchronized device queue.

Implementations

impl Queue

pub fn submit_one_fence_only(
    queue: &Queue,
    waits: [&Semaphore; 0],
    stages: [PipelineStageFlags; 0],
    buffers: [&CommandBuffer; 1],
    signals: [&Semaphore; 0],
    fence: Option<&Fence>
) -> Result<(), QueueSubmitError>

pub fn submit_one(
    queue: &Queue,
    waits: [&Semaphore; 1],
    stages: [PipelineStageFlags; 1],
    buffers: [&CommandBuffer; 1],
    signals: [&Semaphore; 1],
    fence: Option<&Fence>
) -> Result<(), QueueSubmitError>

Example submit function generated using the const_queue_submit! macro.

At some point in the distant future this function will become const generic and the macro will be an implementation detail.

pub fn present_one(
    queue: &Queue,
    waits: [&Semaphore; 1],
    images: [&SwapchainImage; 1],
    result_for_all: bool
) -> QueuePresentMultipleResult<[QueuePresentResult; 1]>

Example present function generated using the const_queue_present! macro.

At some point in the distant future this function will become const generic and the macro will be an implementation detail.

pub unsafe fn from_device(
    device: Vrc<Device>,
    flags: DeviceQueueCreateFlags,
    queue_family_index: u32,
    queue_index: u32
) -> Vrc<Self>

Gets a queue from the logical device.

Safety

• See https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetDeviceQueue.html.
• See https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetDeviceQueue2.html.

pub unsafe fn submit(
    &self,
    infos: impl AsRef<[SubmitInfo]>,
    fence: Option<&Fence>
) -> Result<(), QueueSubmitError>

Submits to given queue.

Safety

See https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkQueueSubmit.html

Panic

This function will panic if the Vutex is poisoned.

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

Waits until all outstanding operations on the queue are completed.

Panic

This function will panic if the Vutex is poisoned.

pub const fn device(&self) -> &Vrc<Device>

pub const fn queue_family_index(&self) -> u32

pub const fn queue_index(&self) -> u32

Methods from Deref<Target = Vutex<Queue>>

pub fn lock(&self) -> Result<VutexGuard<'_, T>, BorrowMutError>

Trait Implementations

impl Borrow<Vutex<Queue>> for Queue

fn borrow(&self) -> &Vutex<Queue>

Immutably borrows from an owned value.

impl Debug for Queue

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

Formats the value using the given formatter.

impl Deref for Queue

type Target = Vutex<Queue>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for Queue

impl<'a> From<&'a Queue> for SharingMode<[u32; 1]>

fn from(queue: &'a Queue) -> Self

Performs the conversion.

impl HasSynchronizedHandle<Queue> for Queue

fn lock_handle(&self) -> VutexGuard<'_, T>

fn lock_safe_handle(&self) -> VutexGuardSafeHandleBorrow<'_, T>

impl Hash for Queue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Queue

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Queue> for Queue

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Queue> for Queue

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.