Struct erupt_bootstrap::device::QueueFamilyRequirements

source · [−]

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

Expand description

Requirements to 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.

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.

presentation_support: Option<bool>

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

Implementations

source

impl QueueFamilyRequirements

source

pub fn empty() -> QueueFamilyRequirements

Queue family requirements that are always met.

source

pub fn graphics_present() -> QueueFamilyRequirements

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

source

pub fn preferably_separate_transfer() -> QueueFamilyRequirements

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

source

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

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

source

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

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

source

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

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

source

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

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

source

pub fn must_support_presentation(self) -> QueueFamilyRequirements

Require that the queue family must support presentation.

source

pub fn must_not_support_presentation(self) -> QueueFamilyRequirements

Require that the queue family must not support presentation.

source

pub fn 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 first queue family that meets the requirements. Returns Ok(None) when no queue family meets the requirements. Returns Err(_) when an internal Vulkan call failed.