Struct Display

pub struct Display<PhysicalDevice: PhysicalDevice>(pub VkDisplayKHR, pub PhysicalDevice);

Available on crate feature VK_KHR_display only.

Tuple Fields

0: VkDisplayKHR

1: PhysicalDevice

Implementations

impl<PhysicalDevice: PhysicalDevice> Display<PhysicalDevice>

pub fn mode_property_count(&self) -> Result<u32>

Available on crate feature Implements only.

Query a count of 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 mode_properties(&self, sink: &mut [DisplayModeProperties]) -> Result<u32>

Available on crate feature Implements only.

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 mode_properties_alloc(&self) -> Result<Vec<DisplayModeProperties>>

Available on crate features Implements and alloc only.

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 release(&self)

where PhysicalDevice::ConcreteInstance: InstanceExtensions,

Available on crate features Implements and VK_EXT_direct_mode_display only.

Release access to an acquired VkDisplayKHR

pub fn acquire_xlib_display(&self, dpy: *mut Display) -> Result<()>

where PhysicalDevice::ConcreteInstance: InstanceExtensions,

Available on crate features Implements and VK_EXT_acquire_xlib_display only.

Acquire access to a VkDisplayKHR using Xlib

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_INITIALIZATION_FAILED

pub unsafe fn create_display_mode_raw( &self, info: &VkDisplayModeCreateInfoKHR, allocation_callbacks: Option<&VkAllocationCallbacks>, ) -> Result<VkDisplayModeKHR>

Available on crate feature Implements only.

Create a display mode

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Safety

no guarantee will be provided (simply calls under api)

pub fn create_display_mode( &self, params: VkDisplayModeParametersKHR, ) -> Result<DisplayMode>

Available on crate feature Implements only.

Create a display mode

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Trait Implementations

impl<PhysicalDevice: PhysicalDevice> VkHandle for Display<PhysicalDevice>

type Handle = VkDisplayKHR

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

Retrieve an underlying handle

fn as_transparent_ref(&self) -> VkHandleRef<'_, Self::Handle>

impl<PhysicalDevice: PhysicalDevice> VkHandleMut for Display<PhysicalDevice>

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut(&mut self) -> VkHandleRefMut<'_, Self::Handle>

impl<PhysicalDevice: PhysicalDevice> VkObject for Display<PhysicalDevice>

const TYPE: VkObjectType = 1_000_002_000i32