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