Struct vulkano::device::physical::PhysicalDevice

pub struct PhysicalDevice { /* private fields */ }

Represents one of the available physical devices on this machine.

Examples

use vulkano::device::physical::PhysicalDevice;

for physical_device in instance.enumerate_physical_devices().unwrap() {
    print_infos(&physical_device);
}

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

Implementations

impl PhysicalDevice

pub unsafe fn from_handle(
    instance: Arc<Instance>,
    handle: PhysicalDevice
) -> Result<Arc<Self>, VulkanError>

Creates a new PhysicalDevice from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from instance.

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

Returns the instance that owns the physical device.

pub fn api_version(&self) -> Version

Returns the version of Vulkan supported by the physical device.

Unlike the api_version property, which is the version reported by the device directly, this function returns the version the device can actually support, based on the instance’s max_api_version.

pub fn properties(&self) -> &Properties

Returns the properties reported by the physical device.

pub fn extension_properties(&self) -> &[ExtensionProperties]

Returns the extension properties reported by the physical device.

pub fn supported_extensions(&self) -> &DeviceExtensions

Returns the extensions that are supported by the physical device.

pub fn supported_features(&self) -> &Features

Returns the features that are supported by the physical device.

pub fn memory_properties(&self) -> &MemoryProperties

Returns the memory properties reported by the physical device.

pub fn queue_family_properties(&self) -> &[QueueFamilyProperties]

Returns the queue family properties reported by the physical device.

pub unsafe fn directfb_presentation_support<D>(
    &self,
    queue_family_index: u32,
    dfb: *const D
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to DirectFB surfaces from queues of the given queue family.

Safety

• dfb must be a valid DirectFB IDirectFB handle.

pub fn external_buffer_properties(
    &self,
    info: ExternalBufferInfo
) -> Result<ExternalBufferProperties, PhysicalDeviceError>

Retrieves the external memory properties supported for buffers with a given configuration.

Instance API version must be at least 1.1, or the khr_external_memory_capabilities extension must be enabled on the instance.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

pub fn external_fence_properties(
    &self,
    info: ExternalFenceInfo
) -> Result<ExternalFenceProperties, PhysicalDeviceError>

Retrieves the external handle properties supported for fences with a given configuration.

The instance API version must be at least 1.1, or the khr_external_fence_capabilities extension must be enabled on the instance.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

pub fn external_semaphore_properties(
    &self,
    info: ExternalSemaphoreInfo
) -> Result<ExternalSemaphoreProperties, PhysicalDeviceError>

Retrieves the external handle properties supported for semaphores with a given configuration.

The instance API version must be at least 1.1, or the khr_external_semaphore_capabilities extension must be enabled on the instance.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

pub fn format_properties(
    &self,
    format: Format
) -> Result<FormatProperties, PhysicalDeviceError>

Retrieves the properties of a format when used by this physical device.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

pub fn image_format_properties(
    &self,
    image_format_info: ImageFormatInfo
) -> Result<Option<ImageFormatProperties>, PhysicalDeviceError>

Returns the properties supported for images with a given image configuration.

Some is returned if the configuration is supported, None if it is not.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

Panics

• Panics if image_format_info.format is None.

pub fn validate_image_format_properties(
    &self,
    image_format_info: &ImageFormatInfo
) -> Result<(), PhysicalDeviceError>

pub unsafe fn qnx_screen_presentation_support<W>(
    &self,
    queue_family_index: u32,
    window: *const W
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to QNX Screen surfaces from queues of the given queue family.

Safety

• window must be a valid QNX Screen _screen_window handle.

pub fn sparse_image_format_properties(
    &self,
    format_info: SparseImageFormatInfo
) -> Result<Vec<SparseImageFormatProperties>, PhysicalDeviceError>

Returns the properties of sparse images with a given image configuration.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

Panics

• Panics if format_info.format is None.

pub fn surface_capabilities(
    &self,
    surface: &Surface,
    surface_info: SurfaceInfo
) -> Result<SurfaceCapabilities, PhysicalDeviceError>

Returns the capabilities that are supported by the physical device for the given surface.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

Panics

• Panics if the physical device and the surface don’t belong to the same instance.

pub fn surface_formats(
    &self,
    surface: &Surface,
    surface_info: SurfaceInfo
) -> Result<Vec<(Format, ColorSpace)>, PhysicalDeviceError>

Returns the combinations of format and color space that are supported by the physical device for the given surface.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

Panics

• Panics if the physical device and the surface don’t belong to the same instance.

pub fn surface_present_modes(
    &self,
    surface: &Surface
) -> Result<impl Iterator<Item = PresentMode>, PhysicalDeviceError>

Returns the present modes that are supported by the physical device for the given surface.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

Panics

• Panics if the physical device and the surface don’t belong to the same instance.

pub fn surface_support(
    &self,
    queue_family_index: u32,
    surface: &Surface
) -> Result<bool, PhysicalDeviceError>

Returns whether queues of the given queue family can draw on the given surface.

The results of this function are cached, so that future calls with the same arguments do not need to make a call to the Vulkan API again.

pub fn tool_properties(
    &self
) -> Result<Vec<ToolProperties>, PhysicalDeviceError>

Retrieves the properties of tools that are currently active on the physical device.

These properties may change during runtime, so the result only reflects the current situation and is not cached.

The physical device API version must be at least 1.3, or the ext_tooling_info extension must be supported by the physical device.

pub unsafe fn wayland_presentation_support<D>(
    &self,
    queue_family_index: u32,
    display: *const D
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to Wayland surfaces from queues of the given queue family.

Safety

• display must be a valid Wayland wl_display handle.

pub fn win32_presentation_support(
    &self,
    queue_family_index: u32
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to Win32 surfaces from queues of the given queue family.

pub unsafe fn xcb_presentation_support<C>(
    &self,
    queue_family_index: u32,
    connection: *const C,
    visual_id: xcb_visualid_t
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to XCB surfaces from queues of the given queue family.

Safety

• connection must be a valid X11 xcb_connection_t handle.

pub unsafe fn xlib_presentation_support<D>(
    &self,
    queue_family_index: u32,
    display: *const D,
    visual_id: VisualID
) -> Result<bool, PhysicalDeviceError>

Queries whether the physical device supports presenting to Xlib surfaces from queues of the given queue family.

Safety

• display must be a valid Xlib Display handle.

Trait Implementations

impl Debug for PhysicalDevice

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

Formats the value using the given formatter.

impl Hash for PhysicalDevice

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<PhysicalDevice> for PhysicalDevice

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for PhysicalDevice

type Handle = PhysicalDevice

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for PhysicalDevice