Struct vulkano::instance::PhysicalDevice

pub struct PhysicalDevice<'a> { /* fields omitted */ }

Represents one of the available devices on this machine.

This struct simply contains a pointer to an instance and a number representing the physical device. You are therefore encouraged to pass this around by value instead of by reference.

Example

use vulkano::instance::PhysicalDevice;

for physical_device in PhysicalDevice::enumerate(&instance) {
    print_infos(physical_device);
}

fn print_infos(dev: PhysicalDevice) {
    println!("Name: {}", dev.name());
}

Methods

impl<'a> PhysicalDevice<'a>

Important traits for PhysicalDevicesIter<'a>

impl<'a> Iterator for PhysicalDevicesIter<'a> type Item = PhysicalDevice<'a>;

pub fn enumerate(instance: &'a Arc<Instance>) -> PhysicalDevicesIter<'a>

Returns an iterator that enumerates the physical devices available.

Example

use vulkano::instance::PhysicalDevice;

for physical_device in PhysicalDevice::enumerate(&instance) {
    println!("Available device: {}", physical_device.name());
}

pub fn from_index(
    instance: &'a Arc<Instance>,
    index: usize
) -> Option<PhysicalDevice<'a>>

Returns a physical device from its index. Returns None if out of range.

Indices range from 0 to the number of devices.

Example

use vulkano::instance::Instance;
use vulkano::instance::InstanceExtensions;
use vulkano::instance::PhysicalDevice;

let instance = Instance::new(None, &InstanceExtensions::none(), None).unwrap();
let first_physical_device = PhysicalDevice::from_index(&instance, 0).unwrap();

pub fn instance(&self) -> &'a Arc<Instance>

Returns the instance corresponding to this physical device.

Example

use vulkano::instance::PhysicalDevice;

fn do_something(physical_device: PhysicalDevice) {
    let _loaded_extensions = physical_device.instance().loaded_extensions();
    // ...
}

pub fn index(&self) -> usize

Returns the index of the physical device in the physical devices list.

This index never changes and can be used later to retrieve a PhysicalDevice from an instance and an index.

pub fn name(&self) -> String

Returns the human-readable name of the device.

pub fn ty(&self) -> PhysicalDeviceType

Returns the type of the device.

Example

use vulkano::instance::PhysicalDevice;

for physical_device in PhysicalDevice::enumerate(&instance) {
    println!("Available device: {} (type: {:?})",
              physical_device.name(), physical_device.ty());
}

pub fn api_version(&self) -> Version

Returns the version of Vulkan supported by this device.

pub fn supported_features(&self) -> &'a Features

Returns the Vulkan features that are supported by this physical device.

Important traits for QueueFamiliesIter<'a>

impl<'a> Iterator for QueueFamiliesIter<'a> type Item = QueueFamily<'a>;

pub fn queue_families(&self) -> QueueFamiliesIter<'a>

Builds an iterator that enumerates all the queue families on this physical device.

pub fn queue_family_by_id(&self, id: u32) -> Option<QueueFamily<'a>>

Returns the queue family with the given index, or None if out of range.

Important traits for MemoryTypesIter<'a>

impl<'a> Iterator for MemoryTypesIter<'a> type Item = MemoryType<'a>;

pub fn memory_types(&self) -> MemoryTypesIter<'a>

Builds an iterator that enumerates all the memory types on this physical device.

pub fn memory_type_by_id(&self, id: u32) -> Option<MemoryType<'a>>

Returns the memory type with the given index, or None if out of range.

Important traits for MemoryHeapsIter<'a>

impl<'a> Iterator for MemoryHeapsIter<'a> type Item = MemoryHeap<'a>;

pub fn memory_heaps(&self) -> MemoryHeapsIter<'a>

Builds an iterator that enumerates all the memory heaps on this physical device.

pub fn memory_heap_by_id(&self, id: u32) -> Option<MemoryHeap<'a>>

Returns the memory heap with the given index, or None if out of range.

pub fn limits(&self) -> Limits<'a>

Gives access to the limits of the physical device.

This function should be zero-cost in release mode. It only exists to not pollute the namespace of PhysicalDevice with all the limits-related getters.

pub fn driver_version(&self) -> u32

Returns an opaque number representing the version of the driver of this device.

The meaning of this number is implementation-specific. It can be used in bug reports, for example.

pub fn pci_device_id(&self) -> u32

Returns the PCI ID of the device.

pub fn pci_vendor_id(&self) -> u32

Returns the PCI ID of the vendor.

pub fn uuid(&self) -> &[u8; 16]

Returns a unique identifier for the device.

Can be stored in a configuration file, so that you can retrieve the device again the next time the program is run.

Trait Implementations

impl<'a> VulkanObject for PhysicalDevice<'a>

type Object = PhysicalDevice

The type of the object.

const TYPE: DebugReportObjectTypeEXT

The DebugReportObjectTypeEXT of the internal Vulkan handle.

fn internal_object(&self) -> PhysicalDevice

Returns a reference to the object.

impl<'a> Clone for PhysicalDevice<'a>

fn clone(&self) -> PhysicalDevice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PhysicalDevice<'a>

impl<'a> Debug for PhysicalDevice<'a>

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

Formats the value using the given formatter.