C Specification

When acquiring displays from an X11 server, an application may also wish to enumerate and identify them using a native handle rather than a VkDisplayKHR handle. To determine the VkDisplayKHR handle corresponding to an X11 RandR Output, call:

// Provided by VK_EXT_acquire_xlib_display
VkResult vkGetRandROutputDisplayEXT(
    VkPhysicalDevice                            physicalDevice,
    Display*                                    dpy,
    RROutput                                    rrOutput,
    VkDisplayKHR*                               pDisplay);

Parameters

  • physicalDevice is the physical device to query the display handle on.

  • dpy is a connection to the X11 server from which rrOutput was queried.

  • rrOutput is an X11 RandR output ID.

  • pDisplay is a pointer to a VkDisplayKHR handle where the display is returned.

Description

If there is no VkDisplayKHR corresponding to rrOutput on physicalDevice, VK_NULL_HANDLE will be returned in pDisplay.

Valid Usage (Implicit)

  • VUID-vkGetRandROutputDisplayEXT-physicalDevice-parameter
    physicalDevice must be a valid VkPhysicalDevice handle

  • VUID-vkGetRandROutputDisplayEXT-dpy-parameter
    dpy must be a valid pointer to a Display value

  • VUID-vkGetRandROutputDisplayEXT-pDisplay-parameter
    pDisplay must be a valid pointer to a VkDisplayKHR handle

Return Codes
On success, this command returns
On failure, this command returns

See Also

VK_EXT_acquire_xlib_display, VkDisplayKHR, VkPhysicalDevice

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0