public Class EXTAcquireDrmDisplay

The extension name.

The extension specification version.

Unsafe version of: GetDrmDisplayEXT

Acquire access to a VkDisplayKHR using DRM.

C Specification

To acquire permission to directly a display in Vulkan from the Direct Rendering Manager (DRM) interface, call:

VkResult vkAcquireDrmDisplayEXT(
    VkPhysicalDevice                            physicalDevice,
    int32_t                                     drmFd,
    VkDisplayKHR                                display);

Description

All permissions necessary to control the display are granted to the Vulkan instance associated with the provided physicalDevice until the display is either released or the connector is unplugged. The provided drmFd must correspond to the one owned by the physicalDevice. If not, the error code ERROR_UNKNOWN must be returned. The DRM FD must have DRM master permissions. If any error is encountered during the acquisition of the display, the call must return the error code ERROR_INITIALIZATION_FAILED.

The provided DRM fd should not be closed before the display is released, attempting to do it may result in undefined behaviour.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid VkDisplayKHR handle
• display must have been created, allocated, or retrieved from physicalDevice

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED

Parameters

physicalDevice:VkPhysicalDevice

The physical device the display is on.

drmFd:int

DRM primary file descriptor.

display:long

The display the caller wishes Vulkan to control.

Annotations

@NativeType:VkResult

Query the VkDisplayKHR corresponding to a DRM connector ID.

C Specification

Before acquiring a display from the DRM interface, the caller may want to select a specific VkDisplayKHR handle by identifying it using a connectorId. To do so, call:

VkResult vkGetDrmDisplayEXT(
    VkPhysicalDevice                            physicalDevice,
    int32_t                                     drmFd,
    uint32_t                                    connectorId,
    VkDisplayKHR*                               display);

Description

If there is no VkDisplayKHR corresponding to the connectorId on the physicalDevice, the returning display must be set to NULL_HANDLE. The provided drmFd must correspond to the one owned by the physicalDevice. If not, the error code ERROR_UNKNOWN must be returned. Master permissions are not required, because the file descriptor is just used for information gathering purposes. The given connectorId must be a resource owned by the provided drmFd. If not, the error code ERROR_UNKNOWN must be returned. If any error is encountered during the identification of the display, the call must return the error code ERROR_INITIALIZATION_FAILED.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid pointer to a VkDisplayKHR handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY

Parameters

physicalDevice:VkPhysicalDevice

The physical device to query the display from.

drmFd:int

DRM primary file descriptor.

connectorId:int

Identifier of the specified DRM connector.

display:LongBuffer

The corresponding VkDisplayKHR handle will be returned here.

Annotations

@NativeType:VkResult

Array version of: GetDrmDisplayEXT

Annotations

@NativeType:VkResult