Struct bedrock::PhysicalDevice

pub struct PhysicalDevice(_, _);

Opaque handle to a physical device object

Platform Dependent Methods: Presentation Support checking functions

• xlib_presentation_support(&self, queue_family: u32, display: *mut x11::xlib::Display, visual: x11::xlib::VisualID) -> bool: VK_KHR_xlib_surface
• xcb_presentation_support(&self, queue_family: u32, connection: *mut xcb::ffi::xcb_connection_t, visual: xcb::ffi::xcb_visualid_t) -> bool: VK_KHR_xcb_surface
• wayland_presentation_support(&self, queue_family: u32, display: *mut wayland_client::sys::wl_display) -> bool: VK_KHR_wayland_surface
• win32_presentation_support(&self, queue_family: u32) -> bool: VK_KHR_win32_surface
• Methods for Android and Mir surfaces are not implemented

Methods

impl PhysicalDevice

Following methods are enabled with [feature = "Implements"]

pub fn parent(&self) -> &Instance

pub fn features(&self) -> VkPhysicalDeviceFeatures

Reports capabilities of a physical device.

pub fn format_properties(&self, format: VkFormat) -> VkFormatProperties

Lists physical device's format capabilities

pub fn image_format_properties(
    &self,
    format: VkFormat,
    itype: VkImageType,
    tiling: VkImageTiling,
    usage: ImageUsage,
    flags: ImageFlags
) -> Result<VkImageFormatProperties>

Lists physical device's image format capabilities

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_FORMAT_NOT_SUPPORTED

pub fn properties(&self) -> VkPhysicalDeviceProperties

Returns properties of a physical device

pub fn queue_family_properties(&self) -> QueueFamilies

Reports properties of the queues of the specified physical device

pub fn memory_properties(&self) -> MemoryProperties

Reports memory information for the specified physical device

pub fn sparse_image_format_properties(
    &self,
    format: VkFormat,
    itype: VkImageType,
    samples: VkSampleCountFlags,
    usage: ImageUsage,
    tiling: VkImageTiling
) -> Vec<VkSparseImageFormatProperties>

Retrieve properties of an image format applied to sparse images

impl PhysicalDevice

[feature = "VK_KHR_surface" and feature = "Implements"] Surface functions

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

Query if presentation is supported

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_SURFACE_LOST_KHR

pub fn surface_capabilities(
    &self,
    surface: &Surface
) -> Result<VkSurfaceCapabilitiesKHR>

Query surface capabilities

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_SURFACE_LOST_KHR

pub fn surface_formats(
    &self,
    surface: &Surface
) -> Result<Vec<VkSurfaceFormatKHR>>

Query color formats supported by surface

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_SURFACE_LOST_KHR

pub fn surface_present_modes(
    &self,
    surface: &Surface
) -> Result<Vec<PresentMode>>

Query supported presentation modes

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_SURFACE_LOST_KHR

impl PhysicalDevice

feature = "VK_KHR_display" functions (required to enable the "Implements" feature)

pub fn display_properties(&self) -> Result<Vec<VkDisplayPropertiesKHR>>

Query information about the available displays

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn display_plane_properties(
    &self
) -> Result<Vec<VkDisplayPlanePropertiesKHR>>

Query the plane properties

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn display_plane_supported_displays(
    &self,
    index: u32
) -> Result<Vec<VkDisplayKHR>>

Query the list of displays a plane supports

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn display_mode_properties(
    &self,
    display: VkDisplayKHR
) -> Result<Vec<VkDisplayModePropertiesKHR>>

Query the set of mode properties supported by the display

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn new_display_mode(
    &self,
    display: VkDisplayKHR,
    region: Extent2D,
    refresh_rate: u32
) -> Result<VkDisplayModeKHR>

Create a display mode

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_INITIALIZATION_FAILED

pub fn display_plane_capabilities(
    &self,
    mode: VkDisplayModeKHR,
    plane_index: u32
) -> Result<VkDisplayPlaneCapabilitiesKHR>

Query capabilities of a mode and plane combination

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Trait Implementations

impl VkHandle for PhysicalDevice

type Handle = VkPhysicalDevice

fn native_ptr(&self) -> VkPhysicalDevice

Retrieve an underlying handle