C Specification

To set the power state of a display, call:

// Provided by VK_EXT_display_control
VkResult vkDisplayPowerControlEXT(
    VkDevice                                    device,
    VkDisplayKHR                                display,
    const VkDisplayPowerInfoEXT*                pDisplayPowerInfo);

Parameters

  • device is a logical device associated with display.

  • display is the display whose power state is modified.

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

Description

If VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations is VK_TRUE, vkDisplayPowerControlEXT must not return VK_ERROR_OUT_OF_HOST_MEMORY.

Valid Usage (Implicit)

  • VUID-vkDisplayPowerControlEXT-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkDisplayPowerControlEXT-display-parameter
    display must be a valid VkDisplayKHR handle

  • VUID-vkDisplayPowerControlEXT-pDisplayPowerInfo-parameter
    pDisplayPowerInfo must be a valid pointer to a valid VkDisplayPowerInfoEXT structure

  • VUID-vkDisplayPowerControlEXT-commonparent
    Both of device, and display must have been created, allocated, or retrieved from the same VkPhysicalDevice

Return Codes
On success, this command returns

  • VK_SUCCESS

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY

See Also

VK_EXT_display_control, VkDevice, VkDisplayKHR, VkDisplayPowerInfoEXT

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-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0