• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# WindowManager_WindowProperties
2
3
4## Overview
5
6The WindowManager_WindowProperties struct describes the window properties.
7
8**Since**: 15
9
10**Related module**: [WindowManager_NativeModule](_window_manager___native_module.md)
11
12
13## Summary
14
15
16### Member Variables
17
18| Name| Description|
19| -------- | -------- |
20| [WindowManager_Rect](_window_manager___rect.md)  [windowRect](#windowrect) | Position and size of the window.|
21| [WindowManager_Rect](_window_manager___rect.md)  [drawableRect](#drawablerect) | Size of the drawable area within the window.|
22| [WindowManager_WindowType](_window_manager___native_module.md#windowmanager_windowtype)  [type](#type) | Window type.|
23| bool [isFullScreen](#isfullscreen) | Whether the window is in full-screen mode. The default value is **false**. The value **true** means that the window is in full-screen mode, and **false** means the opposite.|
24| bool [isLayoutFullScreen](#islayoutfullscreen) | Whether the window layout is immersive. The default value is **false**. The value **true** means that the window layout is immersive, and **false** means the opposite.|
25| bool [focusable](#focusable) | Whether the window is focusable. The default value is **true**. The value **true** means that the window is focusable, and **false** means the opposite.|
26| bool [touchable](#touchable) | Whether the window is touchable. The default value is **true**. The value **true** means that the window is touchable, and **false** means the opposite.|
27| float [brightness](#brightness) | Screen brightness of the window. The value is a floating point number in the range [0.0, 1.0] or set to **-1.0**, where **1.0** indicates the brightest, and **-1.0** is the default brightness.|
28| bool [isKeepScreenOn](#iskeepscreenon) | Whether the screen is steady on. The default value is **false**. The value **true** means that the screen is steady on, and **false** means the opposite.|
29| bool [isPrivacyMode](#isprivacymode) | Whether privacy mode is enabled for the window. The default value is **false**. The value **true** means that privacy mode is enabled, and **false** means the opposite.|
30| bool [isTransparent](#istransparent) | Whether the window is transparent. The default value is **false**. The value **true** means that the window is transparent, and **false** means the opposite.|
31| uint32_t [id](#id) | Window ID. The default value is **0**, and the value is an integer.|
32| uint32_t [displayId](#displayid) | ID of the screen where the window is located. By default, the ID of the primary screen is returned. The value is an integer.|
33
34
35## Member Variable Description
36
37
38### brightness
39
40```
41float WindowManager_WindowProperties::brightness
42```
43
44**Description**
45
46Screen brightness of the window. The value is a floating point number in the range [0.0, 1.0] or set to **-1.0**, where **1.0** indicates the brightest, and **-1.0** is the default brightness.
47
48
49### displayId
50
51```
52uint32_t WindowManager_WindowProperties::displayId
53```
54
55**Description**
56
57ID of the screen where the window is located. By default, the ID of the primary screen is returned. The value is an integer.
58
59
60### drawableRect
61
62```
63WindowManager_Rect WindowManager_WindowProperties::drawableRect
64```
65
66**Description**
67
68Size of the drawable area within the window.
69
70
71### focusable
72
73```
74bool WindowManager_WindowProperties::focusable
75```
76
77**Description**
78
79Whether the window is focusable. The default value is **true**. The value **true** means that the window is focusable, and **false** means the opposite.
80
81
82### id
83
84```
85uint32_t WindowManager_WindowProperties::id
86```
87
88**Description**
89
90Window ID. The default value is **0**, and the value is an integer.
91
92
93### isFullScreen
94
95```
96bool WindowManager_WindowProperties::isFullScreen
97```
98
99**Description**
100
101Whether the window is in full-screen mode. The default value is **false**. The value **true** means that the window is in full-screen mode, and **false** means the opposite.
102
103
104### isKeepScreenOn
105
106```
107bool WindowManager_WindowProperties::isKeepScreenOn
108```
109
110**Description**
111
112Whether the screen is steady on. The default value is **false**. The value **true** means that the screen is steady on, and **false** means the opposite.
113
114
115### isLayoutFullScreen
116
117```
118bool WindowManager_WindowProperties::isLayoutFullScreen
119```
120
121**Description**
122
123Whether the window layout is immersive. The default value is **false**. The value **true** means that the window layout is immersive, and **false** means the opposite.
124
125
126### isPrivacyMode
127
128```
129bool WindowManager_WindowProperties::isPrivacyMode
130```
131
132**Description**
133
134Whether privacy mode is enabled for the window. The default value is **false**. The value **true** means that privacy mode is enabled, and **false** means the opposite.
135
136
137### isTransparent
138
139```
140bool WindowManager_WindowProperties::isTransparent
141```
142
143**Description**
144
145Whether the window is transparent. The default value is **false**. The value **true** means that the window is transparent, and **false** means the opposite.
146
147
148### touchable
149
150```
151bool WindowManager_WindowProperties::touchable
152```
153
154**Description**
155
156Whether the window is touchable. The default value is **true**. The value **true** means that the window is touchable, and **false** means the opposite.
157
158
159### type
160
161```
162WindowManager_WindowType WindowManager_WindowProperties::type
163```
164
165**Description**
166
167Window type.
168
169
170### windowRect
171
172```
173WindowManager_Rect WindowManager_WindowProperties::windowRect
174```
175
176**Description**
177
178Position and size of the window.
179