| // Copyright 2018-2021 The Khronos Group, Inc. |
| // |
| // SPDX-License-Identifier: CC-BY-4.0 |
| |
| === Display Control |
| |
| [open,refpage='vkDisplayPowerControlEXT',desc='Set the power state of a display',type='protos'] |
| -- |
| To set the power state of a display, call: |
| |
| include::{generated}/api/protos/vkDisplayPowerControlEXT.txt[] |
| |
| * pname:device is a logical device associated with pname:display. |
| * pname:display is the display whose power state is modified. |
| * pname:pDisplayPowerInfo is a pointer to a slink:VkDisplayPowerInfoEXT |
| structure specifying the new power state of pname:display. |
| |
| include::{generated}/validity/protos/vkDisplayPowerControlEXT.txt[] |
| -- |
| |
| [open,refpage='VkDisplayPowerInfoEXT',desc='Describe the power state of a display',type='structs'] |
| -- |
| The sname:VkDisplayPowerInfoEXT structure is defined as: |
| |
| include::{generated}/api/structs/VkDisplayPowerInfoEXT.txt[] |
| |
| * pname:sType is the type of this structure. |
| * pname:pNext is `NULL` or a pointer to a structure extending this |
| structure. |
| * pname:powerState is a elink:VkDisplayPowerStateEXT value specifying the |
| new power state of the display. |
| |
| include::{generated}/validity/structs/VkDisplayPowerInfoEXT.txt[] |
| -- |
| |
| [open,refpage='VkDisplayPowerStateEXT',desc='Possible power states for a display',type='enums'] |
| -- |
| |
| Possible values of slink:VkDisplayPowerInfoEXT::pname:powerState, specifying |
| the new power state of a display, are: |
| |
| include::{generated}/api/enums/VkDisplayPowerStateEXT.txt[] |
| |
| * ename:VK_DISPLAY_POWER_STATE_OFF_EXT specifies that the display is |
| powered down. |
| * ename:VK_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 ename:VK_DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in |
| ename:VK_DISPLAY_POWER_STATE_OFF_EXT. |
| This state may: be the same as ename:VK_DISPLAY_POWER_STATE_OFF_EXT. |
| * ename:VK_DISPLAY_POWER_STATE_ON_EXT specifies that the display is |
| powered on. |
| -- |
