1 /*
2  * This file generated automatically from dpms.xml by d_client.py.
3  * Edit at your peril.
4  */
5 
6 /**
7  * @defgroup XCB_DPMS_API XCB DPMS API
8  * @brief DPMS XCB Protocol Implementation.
9  * @{
10  **/
11 
12 module xcb.dpms;
13 
14 import xcb.xcb;
15 
16 extern (C):
17 
18 enum int XCB_DPMS_MAJOR_VERSION = 0;
19 enum int XCB_DPMS_MINOR_VERSION = 0;
20 
21 extern (C) __gshared extern xcb_extension_t xcb_dpms_id;
22 
23 /**
24  * @brief xcb_dpms_get_version_cookie_t
25  **/
26 struct xcb_dpms_get_version_cookie_t {
27 	uint sequence; /**<  */
28 }
29 
30 /** Opcode for xcb_dpms_get_version. */
31 enum XCB_DPMS_GET_VERSION = 0;
32 
33 /**
34  * @brief xcb_dpms_get_version_request_t
35  **/
36 struct xcb_dpms_get_version_request_t {
37 	ubyte major_opcode; /**<  */
38 	ubyte minor_opcode; /**<  */
39 	ushort length; /**<  */
40 	ushort client_major_version; /**<  */
41 	ushort client_minor_version; /**<  */
42 }
43 
44 /**
45  * @brief xcb_dpms_get_version_reply_t
46  **/
47 struct xcb_dpms_get_version_reply_t {
48 	ubyte response_type; /**<  */
49 	ubyte pad0; /**<  */
50 	ushort sequence; /**<  */
51 	uint length; /**<  */
52 	ushort server_major_version; /**<  */
53 	ushort server_minor_version; /**<  */
54 }
55 
56 /**
57  * @brief xcb_dpms_capable_cookie_t
58  **/
59 struct xcb_dpms_capable_cookie_t {
60 	uint sequence; /**<  */
61 }
62 
63 /** Opcode for xcb_dpms_capable. */
64 enum XCB_DPMS_CAPABLE = 1;
65 
66 /**
67  * @brief xcb_dpms_capable_request_t
68  **/
69 struct xcb_dpms_capable_request_t {
70 	ubyte major_opcode; /**<  */
71 	ubyte minor_opcode; /**<  */
72 	ushort length; /**<  */
73 }
74 
75 /**
76  * @brief xcb_dpms_capable_reply_t
77  **/
78 struct xcb_dpms_capable_reply_t {
79 	ubyte response_type; /**<  */
80 	ubyte pad0; /**<  */
81 	ushort sequence; /**<  */
82 	uint length; /**<  */
83 	ubyte capable; /**<  */
84 	ubyte[23] pad1; /**<  */
85 }
86 
87 /**
88  * @brief xcb_dpms_get_timeouts_cookie_t
89  **/
90 struct xcb_dpms_get_timeouts_cookie_t {
91 	uint sequence; /**<  */
92 }
93 
94 /** Opcode for xcb_dpms_get_timeouts. */
95 enum XCB_DPMS_GET_TIMEOUTS = 2;
96 
97 /**
98  * @brief xcb_dpms_get_timeouts_request_t
99  **/
100 struct xcb_dpms_get_timeouts_request_t {
101 	ubyte major_opcode; /**<  */
102 	ubyte minor_opcode; /**<  */
103 	ushort length; /**<  */
104 }
105 
106 /**
107  * @brief xcb_dpms_get_timeouts_reply_t
108  **/
109 struct xcb_dpms_get_timeouts_reply_t {
110 	ubyte response_type; /**<  */
111 	ubyte pad0; /**<  */
112 	ushort sequence; /**<  */
113 	uint length; /**<  */
114 	ushort standby_timeout; /**<  */
115 	ushort suspend_timeout; /**<  */
116 	ushort off_timeout; /**<  */
117 	ubyte[18] pad1; /**<  */
118 }
119 
120 /** Opcode for xcb_dpms_set_timeouts. */
121 enum XCB_DPMS_SET_TIMEOUTS = 3;
122 
123 /**
124  * @brief xcb_dpms_set_timeouts_request_t
125  **/
126 struct xcb_dpms_set_timeouts_request_t {
127 	ubyte major_opcode; /**<  */
128 	ubyte minor_opcode; /**<  */
129 	ushort length; /**<  */
130 	ushort standby_timeout; /**<  */
131 	ushort suspend_timeout; /**<  */
132 	ushort off_timeout; /**<  */
133 }
134 
135 /** Opcode for xcb_dpms_enable. */
136 enum XCB_DPMS_ENABLE = 4;
137 
138 /**
139  * @brief xcb_dpms_enable_request_t
140  **/
141 struct xcb_dpms_enable_request_t {
142 	ubyte major_opcode; /**<  */
143 	ubyte minor_opcode; /**<  */
144 	ushort length; /**<  */
145 }
146 
147 /** Opcode for xcb_dpms_disable. */
148 enum XCB_DPMS_DISABLE = 5;
149 
150 /**
151  * @brief xcb_dpms_disable_request_t
152  **/
153 struct xcb_dpms_disable_request_t {
154 	ubyte major_opcode; /**<  */
155 	ubyte minor_opcode; /**<  */
156 	ushort length; /**<  */
157 }
158 
159 enum xcb_dpms_dpms_mode_t {
160 	XCB_DPMS_DPMS_MODE_ON = 0,
161 	XCB_DPMS_DPMS_MODE_STANDBY = 1,
162 	XCB_DPMS_DPMS_MODE_SUSPEND = 2,
163 	XCB_DPMS_DPMS_MODE_OFF = 3
164 }
165 
166 alias XCB_DPMS_DPMS_MODE_ON = xcb_dpms_dpms_mode_t.XCB_DPMS_DPMS_MODE_ON;
167 alias XCB_DPMS_DPMS_MODE_STANDBY = xcb_dpms_dpms_mode_t.XCB_DPMS_DPMS_MODE_STANDBY;
168 alias XCB_DPMS_DPMS_MODE_SUSPEND = xcb_dpms_dpms_mode_t.XCB_DPMS_DPMS_MODE_SUSPEND;
169 alias XCB_DPMS_DPMS_MODE_OFF = xcb_dpms_dpms_mode_t.XCB_DPMS_DPMS_MODE_OFF;
170 
171 /** Opcode for xcb_dpms_force_level. */
172 enum XCB_DPMS_FORCE_LEVEL = 6;
173 
174 /**
175  * @brief xcb_dpms_force_level_request_t
176  **/
177 struct xcb_dpms_force_level_request_t {
178 	ubyte major_opcode; /**<  */
179 	ubyte minor_opcode; /**<  */
180 	ushort length; /**<  */
181 	ushort power_level; /**<  */
182 }
183 
184 /**
185  * @brief xcb_dpms_info_cookie_t
186  **/
187 struct xcb_dpms_info_cookie_t {
188 	uint sequence; /**<  */
189 }
190 
191 /** Opcode for xcb_dpms_info. */
192 enum XCB_DPMS_INFO = 7;
193 
194 /**
195  * @brief xcb_dpms_info_request_t
196  **/
197 struct xcb_dpms_info_request_t {
198 	ubyte major_opcode; /**<  */
199 	ubyte minor_opcode; /**<  */
200 	ushort length; /**<  */
201 }
202 
203 /**
204  * @brief xcb_dpms_info_reply_t
205  **/
206 struct xcb_dpms_info_reply_t {
207 	ubyte response_type; /**<  */
208 	ubyte pad0; /**<  */
209 	ushort sequence; /**<  */
210 	uint length; /**<  */
211 	ushort power_level; /**<  */
212 	ubyte state; /**<  */
213 	ubyte[21] pad1; /**<  */
214 }
215 
216 /**
217  *
218  * @param c The connection
219  * @return A cookie
220  *
221  * Delivers a request to the X server.
222  *
223  */
224 xcb_dpms_get_version_cookie_t xcb_dpms_get_version(xcb_connection_t* c /**< */ , ushort client_major_version /**< */ ,
225 	ushort client_minor_version /**< */ );
226 
227 /**
228  *
229  * @param c The connection
230  * @return A cookie
231  *
232  * Delivers a request to the X server.
233  *
234  * This form can be used only if the request will cause
235  * a reply to be generated. Any returned error will be
236  * placed in the event queue.
237  */
238 xcb_dpms_get_version_cookie_t xcb_dpms_get_version_unchecked(xcb_connection_t* c /**< */ , ushort client_major_version /**< */ ,
239 	ushort client_minor_version /**< */ );
240 
241 /**
242  * Return the reply
243  * @param c      The connection
244  * @param cookie The cookie
245  * @param e      The xcb_generic_error_t supplied
246  *
247  * Returns the reply of the request asked by
248  *
249  * The parameter @p e supplied to this function must be NULL if
250  * xcb_dpms_get_version_unchecked(). is used.
251  * Otherwise, it stores the error if any.
252  *
253  * The returned value must be freed by the caller using free().
254  */
255 xcb_dpms_get_version_reply_t* xcb_dpms_get_version_reply(xcb_connection_t* c /**< */ ,
256 	xcb_dpms_get_version_cookie_t cookie /**< */ , xcb_generic_error_t** e /**< */ );
257 
258 /**
259  *
260  * @param c The connection
261  * @return A cookie
262  *
263  * Delivers a request to the X server.
264  *
265  */
266 xcb_dpms_capable_cookie_t xcb_dpms_capable(xcb_connection_t* c /**< */ );
267 
268 /**
269  *
270  * @param c The connection
271  * @return A cookie
272  *
273  * Delivers a request to the X server.
274  *
275  * This form can be used only if the request will cause
276  * a reply to be generated. Any returned error will be
277  * placed in the event queue.
278  */
279 xcb_dpms_capable_cookie_t xcb_dpms_capable_unchecked(xcb_connection_t* c /**< */ );
280 
281 /**
282  * Return the reply
283  * @param c      The connection
284  * @param cookie The cookie
285  * @param e      The xcb_generic_error_t supplied
286  *
287  * Returns the reply of the request asked by
288  *
289  * The parameter @p e supplied to this function must be NULL if
290  * xcb_dpms_capable_unchecked(). is used.
291  * Otherwise, it stores the error if any.
292  *
293  * The returned value must be freed by the caller using free().
294  */
295 xcb_dpms_capable_reply_t* xcb_dpms_capable_reply(xcb_connection_t* c /**< */ , xcb_dpms_capable_cookie_t cookie /**< */ ,
296 	xcb_generic_error_t** e /**< */ );
297 
298 /**
299  *
300  * @param c The connection
301  * @return A cookie
302  *
303  * Delivers a request to the X server.
304  *
305  */
306 xcb_dpms_get_timeouts_cookie_t xcb_dpms_get_timeouts(xcb_connection_t* c /**< */ );
307 
308 /**
309  *
310  * @param c The connection
311  * @return A cookie
312  *
313  * Delivers a request to the X server.
314  *
315  * This form can be used only if the request will cause
316  * a reply to be generated. Any returned error will be
317  * placed in the event queue.
318  */
319 xcb_dpms_get_timeouts_cookie_t xcb_dpms_get_timeouts_unchecked(xcb_connection_t* c /**< */ );
320 
321 /**
322  * Return the reply
323  * @param c      The connection
324  * @param cookie The cookie
325  * @param e      The xcb_generic_error_t supplied
326  *
327  * Returns the reply of the request asked by
328  *
329  * The parameter @p e supplied to this function must be NULL if
330  * xcb_dpms_get_timeouts_unchecked(). is used.
331  * Otherwise, it stores the error if any.
332  *
333  * The returned value must be freed by the caller using free().
334  */
335 xcb_dpms_get_timeouts_reply_t* xcb_dpms_get_timeouts_reply(xcb_connection_t* c /**< */ ,
336 	xcb_dpms_get_timeouts_cookie_t cookie /**< */ , xcb_generic_error_t** e /**< */ );
337 
338 /**
339  *
340  * @param c The connection
341  * @return A cookie
342  *
343  * Delivers a request to the X server.
344  *
345  * This form can be used only if the request will not cause
346  * a reply to be generated. Any returned error will be
347  * saved for handling by xcb_request_check().
348  */
349 xcb_void_cookie_t xcb_dpms_set_timeouts_checked(xcb_connection_t* c /**< */ , ushort standby_timeout /**< */ ,
350 	ushort suspend_timeout /**< */ , ushort off_timeout /**< */ );
351 
352 /**
353  *
354  * @param c The connection
355  * @return A cookie
356  *
357  * Delivers a request to the X server.
358  *
359  */
360 xcb_void_cookie_t xcb_dpms_set_timeouts(xcb_connection_t* c /**< */ , ushort standby_timeout /**< */ ,
361 	ushort suspend_timeout /**< */ , ushort off_timeout /**< */ );
362 
363 /**
364  *
365  * @param c The connection
366  * @return A cookie
367  *
368  * Delivers a request to the X server.
369  *
370  * This form can be used only if the request will not cause
371  * a reply to be generated. Any returned error will be
372  * saved for handling by xcb_request_check().
373  */
374 xcb_void_cookie_t xcb_dpms_enable_checked(xcb_connection_t* c /**< */ );
375 
376 /**
377  *
378  * @param c The connection
379  * @return A cookie
380  *
381  * Delivers a request to the X server.
382  *
383  */
384 xcb_void_cookie_t xcb_dpms_enable(xcb_connection_t* c /**< */ );
385 
386 /**
387  *
388  * @param c The connection
389  * @return A cookie
390  *
391  * Delivers a request to the X server.
392  *
393  * This form can be used only if the request will not cause
394  * a reply to be generated. Any returned error will be
395  * saved for handling by xcb_request_check().
396  */
397 xcb_void_cookie_t xcb_dpms_disable_checked(xcb_connection_t* c /**< */ );
398 
399 /**
400  *
401  * @param c The connection
402  * @return A cookie
403  *
404  * Delivers a request to the X server.
405  *
406  */
407 xcb_void_cookie_t xcb_dpms_disable(xcb_connection_t* c /**< */ );
408 
409 /**
410  *
411  * @param c The connection
412  * @return A cookie
413  *
414  * Delivers a request to the X server.
415  *
416  * This form can be used only if the request will not cause
417  * a reply to be generated. Any returned error will be
418  * saved for handling by xcb_request_check().
419  */
420 xcb_void_cookie_t xcb_dpms_force_level_checked(xcb_connection_t* c /**< */ , ushort power_level /**< */ );
421 
422 /**
423  *
424  * @param c The connection
425  * @return A cookie
426  *
427  * Delivers a request to the X server.
428  *
429  */
430 xcb_void_cookie_t xcb_dpms_force_level(xcb_connection_t* c /**< */ , ushort power_level /**< */ );
431 
432 /**
433  *
434  * @param c The connection
435  * @return A cookie
436  *
437  * Delivers a request to the X server.
438  *
439  */
440 xcb_dpms_info_cookie_t xcb_dpms_info(xcb_connection_t* c /**< */ );
441 
442 /**
443  *
444  * @param c The connection
445  * @return A cookie
446  *
447  * Delivers a request to the X server.
448  *
449  * This form can be used only if the request will cause
450  * a reply to be generated. Any returned error will be
451  * placed in the event queue.
452  */
453 xcb_dpms_info_cookie_t xcb_dpms_info_unchecked(xcb_connection_t* c /**< */ );
454 
455 /**
456  * Return the reply
457  * @param c      The connection
458  * @param cookie The cookie
459  * @param e      The xcb_generic_error_t supplied
460  *
461  * Returns the reply of the request asked by
462  *
463  * The parameter @p e supplied to this function must be NULL if
464  * xcb_dpms_info_unchecked(). is used.
465  * Otherwise, it stores the error if any.
466  *
467  * The returned value must be freed by the caller using free().
468  */
469 xcb_dpms_info_reply_t* xcb_dpms_info_reply(xcb_connection_t* c /**< */ , xcb_dpms_info_cookie_t cookie /**< */ , xcb_generic_error_t** e /**< */ );
470 
471 /**
472  * @}
473  */