Struct gfx_hal::adapter::Adapter

pub struct Adapter<B: Backend> {
    pub info: AdapterInfo,
    pub physical_device: B::PhysicalDevice,
    pub queue_families: Vec<B::QueueFamily>,
}

The list of Adapter instances is obtained by calling Instance::enumerate_adapters().

Given an Adapter a Gpu can be constructed by calling PhysicalDevice::open() on its physical_device field. However, if only a single queue family is needed or if no additional device features are required, then the Adapter::open_with convenience method can be used instead.

Fields

info: AdapterInfo

General information about this adapter.

physical_device: B::PhysicalDevice

Actual physical device.

queue_families: Vec<B::QueueFamily>

Queue families supported by this adapter.

Methods

impl<B: Backend> Adapter<B>

pub fn open_with<F, C>(
    &self,
    count: usize,
    selector: F
) -> Result<(B::Device, QueueGroup<B, C>), DeviceCreationError> where
    F: Fn(&B::QueueFamily) -> bool,
    C: Capability, 

Open the physical device with count queues from some active queue family. The family is the first that both provides the capability C, supports at least count queues, and for which selector returns true.

Examples

use hal::General;

let (device, queues) = adapter.open_with::<_, General>(1, |_| true).unwrap();

Return

Returns the same errors as open and InitializationFailed if no suitable queue family could be found.

Trait Implementations

impl<B: Debug + Backend> Debug for Adapter<B> where
    B::PhysicalDevice: Debug,
    B::QueueFamily: Debug, 

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

Formats the value using the given formatter.