Blame view

protocol/viewporter-client-protocol.h 14.5 KB
a902b0089   신재종   fork clone_app so...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
  /* Generated by wayland-scanner 1.19.0 */
  
  #ifndef VIEWPORTER_CLIENT_PROTOCOL_H
  #define VIEWPORTER_CLIENT_PROTOCOL_H
  
  #include <stdint.h>
  #include <stddef.h>
  #include "wayland-client.h"
  
  #ifdef  __cplusplus
  extern "C" {
  #endif
  
  /**
   * @page page_viewporter The viewporter protocol
   * @section page_ifaces_viewporter Interfaces
   * - @subpage page_iface_wp_viewporter - surface cropping and scaling
   * - @subpage page_iface_wp_viewport - crop and scale interface to a wl_surface
   * @section page_copyright_viewporter Copyright
   * <pre>
   *
   * Copyright © 2013-2016 Collabora, Ltd.
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice (including the next
   * paragraph) shall be included in all copies or substantial portions of the
   * Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   * DEALINGS IN THE SOFTWARE.
   * </pre>
   */
  struct wl_surface;
  struct wp_viewport;
  struct wp_viewporter;
  
  #ifndef WP_VIEWPORTER_INTERFACE
  #define WP_VIEWPORTER_INTERFACE
  /**
   * @page page_iface_wp_viewporter wp_viewporter
   * @section page_iface_wp_viewporter_desc Description
   *
   * The global interface exposing surface cropping and scaling
   * capabilities is used to instantiate an interface extension for a
   * wl_surface object. This extended interface will then allow
   * cropping and scaling the surface contents, effectively
   * disconnecting the direct relationship between the buffer and the
   * surface size.
   * @section page_iface_wp_viewporter_api API
   * See @ref iface_wp_viewporter.
   */
  /**
   * @defgroup iface_wp_viewporter The wp_viewporter interface
   *
   * The global interface exposing surface cropping and scaling
   * capabilities is used to instantiate an interface extension for a
   * wl_surface object. This extended interface will then allow
   * cropping and scaling the surface contents, effectively
   * disconnecting the direct relationship between the buffer and the
   * surface size.
   */
  extern const struct wl_interface wp_viewporter_interface;
  #endif
  #ifndef WP_VIEWPORT_INTERFACE
  #define WP_VIEWPORT_INTERFACE
  /**
   * @page page_iface_wp_viewport wp_viewport
   * @section page_iface_wp_viewport_desc Description
   *
   * An additional interface to a wl_surface object, which allows the
   * client to specify the cropping and scaling of the surface
   * contents.
   *
   * This interface works with two concepts: the source rectangle (src_x,
   * src_y, src_width, src_height), and the destination size (dst_width,
   * dst_height). The contents of the source rectangle are scaled to the
   * destination size, and content outside the source rectangle is ignored.
   * This state is double-buffered, and is applied on the next
   * wl_surface.commit.
   *
   * The two parts of crop and scale state are independent: the source
   * rectangle, and the destination size. Initially both are unset, that
   * is, no scaling is applied. The whole of the current wl_buffer is
   * used as the source, and the surface size is as defined in
   * wl_surface.attach.
   *
   * If the destination size is set, it causes the surface size to become
   * dst_width, dst_height. The source (rectangle) is scaled to exactly
   * this size. This overrides whatever the attached wl_buffer size is,
   * unless the wl_buffer is NULL. If the wl_buffer is NULL, the surface
   * has no content and therefore no size. Otherwise, the size is always
   * at least 1x1 in surface local coordinates.
   *
   * If the source rectangle is set, it defines what area of the wl_buffer is
   * taken as the source. If the source rectangle is set and the destination
   * size is not set, then src_width and src_height must be integers, and the
   * surface size becomes the source rectangle size. This results in cropping
   * without scaling. If src_width or src_height are not integers and
   * destination size is not set, the bad_size protocol error is raised when
   * the surface state is applied.
   *
   * The coordinate transformations from buffer pixel coordinates up to
   * the surface-local coordinates happen in the following order:
   * 1. buffer_transform (wl_surface.set_buffer_transform)
   * 2. buffer_scale (wl_surface.set_buffer_scale)
   * 3. crop and scale (wp_viewport.set*)
   * This means, that the source rectangle coordinates of crop and scale
   * are given in the coordinates after the buffer transform and scale,
   * i.e. in the coordinates that would be the surface-local coordinates
   * if the crop and scale was not applied.
   *
   * If src_x or src_y are negative, the bad_value protocol error is raised.
   * Otherwise, if the source rectangle is partially or completely outside of
   * the non-NULL wl_buffer, then the out_of_buffer protocol error is raised
   * when the surface state is applied. A NULL wl_buffer does not raise the
   * out_of_buffer error.
   *
   * The x, y arguments of wl_surface.attach are applied as normal to
   * the surface. They indicate how many pixels to remove from the
   * surface size from the left and the top. In other words, they are
   * still in the surface-local coordinate system, just like dst_width
   * and dst_height are.
   *
   * If the wl_surface associated with the wp_viewport is destroyed,
   * all wp_viewport requests except 'destroy' raise the protocol error
   * no_surface.
   *
   * If the wp_viewport object is destroyed, the crop and scale
   * state is removed from the wl_surface. The change will be applied
   * on the next wl_surface.commit.
   * @section page_iface_wp_viewport_api API
   * See @ref iface_wp_viewport.
   */
  /**
   * @defgroup iface_wp_viewport The wp_viewport interface
   *
   * An additional interface to a wl_surface object, which allows the
   * client to specify the cropping and scaling of the surface
   * contents.
   *
   * This interface works with two concepts: the source rectangle (src_x,
   * src_y, src_width, src_height), and the destination size (dst_width,
   * dst_height). The contents of the source rectangle are scaled to the
   * destination size, and content outside the source rectangle is ignored.
   * This state is double-buffered, and is applied on the next
   * wl_surface.commit.
   *
   * The two parts of crop and scale state are independent: the source
   * rectangle, and the destination size. Initially both are unset, that
   * is, no scaling is applied. The whole of the current wl_buffer is
   * used as the source, and the surface size is as defined in
   * wl_surface.attach.
   *
   * If the destination size is set, it causes the surface size to become
   * dst_width, dst_height. The source (rectangle) is scaled to exactly
   * this size. This overrides whatever the attached wl_buffer size is,
   * unless the wl_buffer is NULL. If the wl_buffer is NULL, the surface
   * has no content and therefore no size. Otherwise, the size is always
   * at least 1x1 in surface local coordinates.
   *
   * If the source rectangle is set, it defines what area of the wl_buffer is
   * taken as the source. If the source rectangle is set and the destination
   * size is not set, then src_width and src_height must be integers, and the
   * surface size becomes the source rectangle size. This results in cropping
   * without scaling. If src_width or src_height are not integers and
   * destination size is not set, the bad_size protocol error is raised when
   * the surface state is applied.
   *
   * The coordinate transformations from buffer pixel coordinates up to
   * the surface-local coordinates happen in the following order:
   * 1. buffer_transform (wl_surface.set_buffer_transform)
   * 2. buffer_scale (wl_surface.set_buffer_scale)
   * 3. crop and scale (wp_viewport.set*)
   * This means, that the source rectangle coordinates of crop and scale
   * are given in the coordinates after the buffer transform and scale,
   * i.e. in the coordinates that would be the surface-local coordinates
   * if the crop and scale was not applied.
   *
   * If src_x or src_y are negative, the bad_value protocol error is raised.
   * Otherwise, if the source rectangle is partially or completely outside of
   * the non-NULL wl_buffer, then the out_of_buffer protocol error is raised
   * when the surface state is applied. A NULL wl_buffer does not raise the
   * out_of_buffer error.
   *
   * The x, y arguments of wl_surface.attach are applied as normal to
   * the surface. They indicate how many pixels to remove from the
   * surface size from the left and the top. In other words, they are
   * still in the surface-local coordinate system, just like dst_width
   * and dst_height are.
   *
   * If the wl_surface associated with the wp_viewport is destroyed,
   * all wp_viewport requests except 'destroy' raise the protocol error
   * no_surface.
   *
   * If the wp_viewport object is destroyed, the crop and scale
   * state is removed from the wl_surface. The change will be applied
   * on the next wl_surface.commit.
   */
  extern const struct wl_interface wp_viewport_interface;
  #endif
  
  #ifndef WP_VIEWPORTER_ERROR_ENUM
  #define WP_VIEWPORTER_ERROR_ENUM
  enum wp_viewporter_error
  {
  	/**
  	 * the surface already has a viewport object associated
  	 */
  	WP_VIEWPORTER_ERROR_VIEWPORT_EXISTS = 0,
  };
  #endif /* WP_VIEWPORTER_ERROR_ENUM */
  
  #define WP_VIEWPORTER_DESTROY      0
  #define WP_VIEWPORTER_GET_VIEWPORT 1
  
  
  /**
   * @ingroup iface_wp_viewporter
   */
  #define WP_VIEWPORTER_DESTROY_SINCE_VERSION 1
  /**
   * @ingroup iface_wp_viewporter
   */
  #define WP_VIEWPORTER_GET_VIEWPORT_SINCE_VERSION 1
  
  /** @ingroup iface_wp_viewporter */
  static inline void
  wp_viewporter_set_user_data(struct wp_viewporter *wp_viewporter, void *user_data)
  {
  	wl_proxy_set_user_data((struct wl_proxy *) wp_viewporter, user_data);
  }
  
  /** @ingroup iface_wp_viewporter */
  static inline void *
  wp_viewporter_get_user_data(struct wp_viewporter *wp_viewporter)
  {
  	return wl_proxy_get_user_data((struct wl_proxy *) wp_viewporter);
  }
  
  static inline uint32_t
  wp_viewporter_get_version(struct wp_viewporter *wp_viewporter)
  {
  	return wl_proxy_get_version((struct wl_proxy *) wp_viewporter);
  }
  
  /**
   * @ingroup iface_wp_viewporter
   *
   * Informs the server that the client will not be using this
   * protocol object anymore. This does not affect any other objects,
   * wp_viewport objects included.
   */
  static inline void
  wp_viewporter_destroy(struct wp_viewporter *wp_viewporter)
  {
  	wl_proxy_marshal((struct wl_proxy *) wp_viewporter,
  			WP_VIEWPORTER_DESTROY);
  
  	wl_proxy_destroy((struct wl_proxy *) wp_viewporter);
  }
  
  /**
   * @ingroup iface_wp_viewporter
   *
   * Instantiate an interface extension for the given wl_surface to
   * crop and scale its content. If the given wl_surface already has
   * a wp_viewport object associated, the viewport_exists
   * protocol error is raised.
   */
  static inline struct wp_viewport *
  wp_viewporter_get_viewport(struct wp_viewporter *wp_viewporter, struct wl_surface *surface)
  {
  	struct wl_proxy *id;
  
  	id = wl_proxy_marshal_constructor((struct wl_proxy *) wp_viewporter,
  					WP_VIEWPORTER_GET_VIEWPORT, &wp_viewport_interface, NULL, surface);
  
  	return (struct wp_viewport *) id;
  }
  
  #ifndef WP_VIEWPORT_ERROR_ENUM
  #define WP_VIEWPORT_ERROR_ENUM
  enum wp_viewport_error
  {
  	/**
  	 * negative or zero values in width or height
  	 */
  	WP_VIEWPORT_ERROR_BAD_VALUE = 0,
  	/**
  	 * destination size is not integer
  	 */
  	WP_VIEWPORT_ERROR_BAD_SIZE = 1,
  	/**
  	 * source rectangle extends outside of the content area
  	 */
  	WP_VIEWPORT_ERROR_OUT_OF_BUFFER = 2,
  	/**
  	 * the wl_surface was destroyed
  	 */
  	WP_VIEWPORT_ERROR_NO_SURFACE = 3,
  };
  #endif /* WP_VIEWPORT_ERROR_ENUM */
  
  #define WP_VIEWPORT_DESTROY         0
  #define WP_VIEWPORT_SET_SOURCE      1
  #define WP_VIEWPORT_SET_DESTINATION 2
  
  
  /**
   * @ingroup iface_wp_viewport
   */
  #define WP_VIEWPORT_DESTROY_SINCE_VERSION 1
  /**
   * @ingroup iface_wp_viewport
   */
  #define WP_VIEWPORT_SET_SOURCE_SINCE_VERSION 1
  /**
   * @ingroup iface_wp_viewport
   */
  #define WP_VIEWPORT_SET_DESTINATION_SINCE_VERSION 1
  
  /** @ingroup iface_wp_viewport */
  static inline void
  wp_viewport_set_user_data(struct wp_viewport *wp_viewport, void *user_data)
  {
  	wl_proxy_set_user_data((struct wl_proxy *) wp_viewport, user_data);
  }
  
  /** @ingroup iface_wp_viewport */
  static inline void *
  wp_viewport_get_user_data(struct wp_viewport *wp_viewport)
  {
  	return wl_proxy_get_user_data((struct wl_proxy *) wp_viewport);
  }
  
  static inline uint32_t
  wp_viewport_get_version(struct wp_viewport *wp_viewport)
  {
  	return wl_proxy_get_version((struct wl_proxy *) wp_viewport);
  }
  
  /**
   * @ingroup iface_wp_viewport
   *
   * The associated wl_surface's crop and scale state is removed.
   * The change is applied on the next wl_surface.commit.
   */
  static inline void
  wp_viewport_destroy(struct wp_viewport *wp_viewport)
  {
  	wl_proxy_marshal((struct wl_proxy *) wp_viewport,
  			WP_VIEWPORT_DESTROY);
  
  	wl_proxy_destroy((struct wl_proxy *) wp_viewport);
  }
  
  /**
   * @ingroup iface_wp_viewport
   *
   * Set the source rectangle of the associated wl_surface. See
   * wp_viewport for the description, and relation to the wl_buffer
   * size.
   *
   * If all of x, y, width and height are -1.0, the source rectangle is
   * unset instead. Any other set of values where width or height are zero
   * or negative, or x or y are negative, raise the bad_value protocol
   * error.
   *
   * The crop and scale state is double-buffered state, and will be
   * applied on the next wl_surface.commit.
   */
  static inline void
  wp_viewport_set_source(struct wp_viewport *wp_viewport, wl_fixed_t x, wl_fixed_t y, wl_fixed_t width, wl_fixed_t height)
  {
  	wl_proxy_marshal((struct wl_proxy *) wp_viewport,
  			WP_VIEWPORT_SET_SOURCE, x, y, width, height);
  }
  
  /**
   * @ingroup iface_wp_viewport
   *
   * Set the destination size of the associated wl_surface. See
   * wp_viewport for the description, and relation to the wl_buffer
   * size.
   *
   * If width is -1 and height is -1, the destination size is unset
   * instead. Any other pair of values for width and height that
   * contains zero or negative values raises the bad_value protocol
   * error.
   *
   * The crop and scale state is double-buffered state, and will be
   * applied on the next wl_surface.commit.
   */
  static inline void
  wp_viewport_set_destination(struct wp_viewport *wp_viewport, int32_t width, int32_t height)
  {
  	wl_proxy_marshal((struct wl_proxy *) wp_viewport,
  			WP_VIEWPORT_SET_DESTINATION, width, height);
  }
  
  #ifdef  __cplusplus
  }
  #endif
  
  #endif