public Class EXTDisplayControl

VkDeviceEventTypeEXT - Events that can occur on a device object

Description

• DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT specifies that the fence is signaled when a display is plugged into or unplugged from the specified device. Applications can use this notification to determine when they need to re-enumerate the available displays on a device.

See Also

VkDeviceEventInfoEXT

VkDisplayEventTypeEXT - Events that can occur on a display object

Description

• DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT specifies that the fence is signaled when the first pixel of the next display refresh cycle leaves the display engine for the display.

See Also

VkDisplayEventInfoEXT

VkDisplayPowerStateEXT - Possible power states for a display

Description

• DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.
• DISPLAY_POWER_STATE_SUSPEND_EXT specifies that the display is put into a low power mode, from which it may be able to transition back to DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in DISPLAY_POWER_STATE_OFF_EXT. This state may be the same as DISPLAY_POWER_STATE_OFF_EXT.
• DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

See Also

VkDisplayPowerInfoEXT

VkDisplayPowerStateEXT - Possible power states for a display

Description

• DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.
• DISPLAY_POWER_STATE_SUSPEND_EXT specifies that the display is put into a low power mode, from which it may be able to transition back to DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in DISPLAY_POWER_STATE_OFF_EXT. This state may be the same as DISPLAY_POWER_STATE_OFF_EXT.
• DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

See Also

VkDisplayPowerInfoEXT

VkDisplayPowerStateEXT - Possible power states for a display

Description

• DISPLAY_POWER_STATE_OFF_EXT specifies that the display is powered down.
• DISPLAY_POWER_STATE_SUSPEND_EXT specifies that the display is put into a low power mode, from which it may be able to transition back to DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in DISPLAY_POWER_STATE_OFF_EXT. This state may be the same as DISPLAY_POWER_STATE_OFF_EXT.
• DISPLAY_POWER_STATE_ON_EXT specifies that the display is powered on.

See Also

VkDisplayPowerInfoEXT

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
• STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
• STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
• STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
• STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
• STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
• STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
• STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
• STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

Unsafe version of: DisplayPowerControlEXT

Unsafe version of: GetSwapchainCounterEXT

Unsafe version of: RegisterDeviceEventEXT

Unsafe version of: RegisterDisplayEventEXT

Set the power state of a display.

C Specification

To set the power state of a display, call:

VkResult vkDisplayPowerControlEXT(
    VkDevice                                    device,
    VkDisplayKHR                                display,
    const VkDisplayPowerInfoEXT*                pDisplayPowerInfo);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• display must be a valid VkDisplayKHR handle
• pDisplayPowerInfo must be a valid pointer to a valid VkDisplayPowerInfoEXT structure
• Both of device, and display must have been created, allocated, or retrieved from the same VkPhysicalDevice

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkDisplayPowerInfoEXT

Parameters

device:VkDevice

a logical device associated with display.

display:long

the display whose power state is modified.

pDisplayPowerInfo:VkDisplayPowerInfoEXT

a pointer to a VkDisplayPowerInfoEXT structure specifying the new power state of display.

Annotations

@NativeType:VkResult

Query the current value of a surface counter.

C Specification

The requested counters become active when the first presentation command for the associated swapchain is processed by the presentation engine. To query the value of an active counter, use:

VkResult vkGetSwapchainCounterEXT(
    VkDevice                                    device,
    VkSwapchainKHR                              swapchain,
    VkSurfaceCounterFlagBitsEXT                 counter,
    uint64_t*                                   pCounterValue);

Description

If a counter is not available because the swapchain is out of date, the implementation may return ERROR_OUT_OF_DATE_KHR.

Valid Usage

• One or more present commands on swapchain must have been processed by the presentation engine

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• counter must be a valid VkSurfaceCounterFlagBitsEXT value
• pCounterValue must be a valid pointer to a uint64_t value
• swapchain must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_DEVICE_LOST
• ERROR_OUT_OF_DATE_KHR

Parameters

device:VkDevice

the VkDevice associated with swapchain.

swapchain:long

the swapchain from which to query the counter value.

counter:int

a VkSurfaceCounterFlagBitsEXT value specifying the counter to query.

pCounterValue:LongBuffer

will return the current value of the counter.

Annotations

@NativeType:VkResult

Array version of: GetSwapchainCounterEXT

Annotations

@NativeType:VkResult

Signal a fence when a device event occurs.

C Specification

To create a fence that will be signaled when an event occurs on a device, call:

VkResult vkRegisterDeviceEventEXT(
    VkDevice                                    device,
    const VkDeviceEventInfoEXT*                 pDeviceEventInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkFence*                                    pFence);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pDeviceEventInfo must be a valid pointer to a valid VkDeviceEventInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pFence must be a valid pointer to a VkFence handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkAllocationCallbacks, VkDeviceEventInfoEXT

Parameters

device:VkDevice

a logical device on which the event may occur.

pDeviceEventInfo:VkDeviceEventInfoEXT

a pointer to a VkDeviceEventInfoEXT structure describing the event of interest to the application.

pAllocator:VkAllocationCallbacks

controls host memory allocation as described in the Memory Allocation chapter.

pFence:LongBuffer

a pointer to a handle in which the resulting fence object is returned.

Annotations

@NativeType:VkResult

Array version of: RegisterDeviceEventEXT

Annotations

@NativeType:VkResult

Signal a fence when a display event occurs.

C Specification

To create a fence that will be signaled when an event occurs on a VkDisplayKHR object, call:

VkResult vkRegisterDisplayEventEXT(
    VkDevice                                    device,
    VkDisplayKHR                                display,
    const VkDisplayEventInfoEXT*                pDisplayEventInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkFence*                                    pFence);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• display must be a valid VkDisplayKHR handle
• pDisplayEventInfo must be a valid pointer to a valid VkDisplayEventInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pFence must be a valid pointer to a VkFence handle
• Both of device, and display must have been created, allocated, or retrieved from the same VkPhysicalDevice

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkAllocationCallbacks, VkDisplayEventInfoEXT

Parameters

device:VkDevice

a logical device associated with display

display:long

the display on which the event may occur.

pDisplayEventInfo:VkDisplayEventInfoEXT

a pointer to a VkDisplayEventInfoEXT structure describing the event of interest to the application.

pAllocator:VkAllocationCallbacks

controls host memory allocation as described in the Memory Allocation chapter.

pFence:LongBuffer

a pointer to a handle in which the resulting fence object is returned.

Annotations

@NativeType:VkResult

Array version of: RegisterDisplayEventEXT

Annotations

@NativeType:VkResult