1// Copyright 2018-2021 The Khronos Group, Inc. 2// 3// SPDX-License-Identifier: CC-BY-4.0 4 5=== Display Control 6 7[open,refpage='vkDisplayPowerControlEXT',desc='Set the power state of a display',type='protos'] 8-- 9To set the power state of a display, call: 10 11include::{generated}/api/protos/vkDisplayPowerControlEXT.txt[] 12 13 * pname:device is a logical device associated with pname:display. 14 * pname:display is the display whose power state is modified. 15 * pname:pDisplayPowerInfo is a pointer to a slink:VkDisplayPowerInfoEXT 16 structure specifying the new power state of pname:display. 17 18include::{generated}/validity/protos/vkDisplayPowerControlEXT.txt[] 19-- 20 21[open,refpage='VkDisplayPowerInfoEXT',desc='Describe the power state of a display',type='structs'] 22-- 23The sname:VkDisplayPowerInfoEXT structure is defined as: 24 25include::{generated}/api/structs/VkDisplayPowerInfoEXT.txt[] 26 27 * pname:sType is the type of this structure. 28 * pname:pNext is `NULL` or a pointer to a structure extending this 29 structure. 30 * pname:powerState is a elink:VkDisplayPowerStateEXT value specifying the 31 new power state of the display. 32 33include::{generated}/validity/structs/VkDisplayPowerInfoEXT.txt[] 34-- 35 36[open,refpage='VkDisplayPowerStateEXT',desc='Possible power states for a display',type='enums'] 37-- 38 39Possible values of slink:VkDisplayPowerInfoEXT::pname:powerState, specifying 40the new power state of a display, are: 41 42include::{generated}/api/enums/VkDisplayPowerStateEXT.txt[] 43 44 * ename:VK_DISPLAY_POWER_STATE_OFF_EXT specifies that the display is 45 powered down. 46 * ename:VK_DISPLAY_POWER_STATE_SUSPEND_EXT specifies that the display is 47 put into a low power mode, from which it may: be able to transition back 48 to ename:VK_DISPLAY_POWER_STATE_ON_EXT more quickly than if it were in 49 ename:VK_DISPLAY_POWER_STATE_OFF_EXT. 50 This state may: be the same as ename:VK_DISPLAY_POWER_STATE_OFF_EXT. 51 * ename:VK_DISPLAY_POWER_STATE_ON_EXT specifies that the display is 52 powered on. 53-- 54