Struct erupt_bootstrap::device::QueueFamilyCriteria

pub struct QueueFamilyCriteria {
    pub must_support: QueueFlags,
    pub should_support: QueueFlags,
    pub must_not_support: QueueFlags,
    pub should_not_support: QueueFlags,
    pub presentation_support: Option<bool>,
}

Criteria for queue families.

Fields

must_support: QueueFlags

A queue family will only be considered if all these flags are set.

should_support: QueueFlags

A queue family will be preferred over other ones if all these flags are set. The more of these flags are set, the more likely it is for the queue family to be chosen.

must_not_support: QueueFlags

A queue family will only be considered if none of these flags are set.

should_not_support: QueueFlags

A queue family will be preferred over other ones if none of these flags are set. The less of these flags are set, the more likely it is for the queue family to be chosen.

presentation_support: Option<bool>

This criteria is only met if the presentation support matches with this flag. None corresponds to being indifferent to the support. Some(expected) corresponds to the criteria being met if the support matches with expected.

Implementations

impl QueueFamilyCriteria

pub fn none() -> QueueFamilyCriteria

Queue family criteria that are always met.

pub fn graphics_present() -> QueueFamilyCriteria

The criteria are only met if the queue family supports graphics and presentation.

pub fn preferably_separate_transfer() -> QueueFamilyCriteria

Tries to match the queue family that’s the closest to being a pure transfer queue.

pub fn must_support(self, must_support: QueueFlags) -> QueueFamilyCriteria

Add an requirement that these queue flags must be present in the queue family.

pub fn should_support(self, should_support: QueueFlags) -> QueueFamilyCriteria

Add an recommendation that these queue flags should be present in the queue family.

pub fn must_not_support(
    self,
    must_not_support: QueueFlags
) -> QueueFamilyCriteria

Add an requirement that these queue flags must not be present in the queue family.

pub fn should_not_support(
    self,
    should_not_support: QueueFlags
) -> QueueFamilyCriteria

Add an recommendation that these queue flags should not be present in the queue family.

pub fn must_support_presentation(self) -> QueueFamilyCriteria

Require that the queue family must support presentation.

pub fn must_not_support_presentation(self) -> QueueFamilyCriteria

Require that the queue family must not support presentation.

pub fn choose_queue_family<'a>(
    &self,
    instance: &InstanceLoader,
    physical_device: PhysicalDevice,
    queue_family_properties: &'a [QueueFamilyProperties],
    surface: Option<SurfaceKHR>
) -> Result<Option<(u32, &'a QueueFamilyProperties)>, Result>

Returns the index of the best suited queue family. Returns Ok(None) when no queue family meets the criteria. Returns Err(_) when an internal Vulkan call failed.

Trait Implementations

impl Clone for QueueFamilyCriteria

fn clone(&self) -> QueueFamilyCriteria

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueueFamilyCriteria

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

Formats the value using the given formatter.

impl Default for QueueFamilyCriteria

fn default() -> QueueFamilyCriteria

Returns the “default value” for a type.

impl Hash for QueueFamilyCriteria

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<QueueFamilyCriteria> for QueueFamilyCriteria

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

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

fn ne(&self, other: &QueueFamilyCriteria) -> bool

This method tests for !=.

impl Copy for QueueFamilyCriteria

impl Eq for QueueFamilyCriteria

impl StructuralEq for QueueFamilyCriteria

impl StructuralPartialEq for QueueFamilyCriteria