Mir
client_types.h
Go to the documentation of this file.
1 /*
2  * client_types.h: Type definitions used in client apps and libmirclient.
3  *
4  * Copyright © 2013 Canonical Ltd.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * Authored by: Robert Carr <robert.carr@canonical.com>
19  */
20 
21 #ifndef MIR_TOOLKIT_CLIENT_TYPES_H_
22 #define MIR_TOOLKIT_CLIENT_TYPES_H_
23 
25 #include <mir_toolkit/common.h>
26 
27 #include <stddef.h>
28 
29 #ifdef __cplusplus
30 
34 extern "C" {
35 #endif
36 
37 /* Display server connection API */
38 typedef void* MirEGLNativeWindowType;
41 typedef struct MirSurface MirSurface;
48 typedef struct MirBlob MirBlob;
50 typedef struct MirError MirError;
51 
52 
59 typedef struct MirOutput MirOutput;
60 
67 
69 
76 typedef void (*mir_connected_callback)(MirConnection *connection, void *client_context);
77 
87 typedef void (*mir_surface_callback)(MirSurface *surface, void *client_context);
88 
96 typedef void (*mir_buffer_stream_callback)(MirBufferStream *stream, void *client_context);
97 
105  MirSurface* surface, MirEvent const* event, void* context);
106 
116  MirConnection* connection, MirLifecycleState state, void* context);
117 
125 typedef void (*mir_ping_event_callback)(
126  MirConnection* connection, int32_t serial, void* context);
127 
135  MirConnection* connection, void* context);
136 
147 typedef void (*mir_client_fd_callback)(
148  MirPromptSession *prompt_session, size_t count, int const* fds, void* context);
149 
150 
151 typedef void (*mir_surface_id_callback)(
152  MirSurface* surface, MirPersistentId* id, void* context);
153 
159 typedef enum MirBufferUsage
160 {
164 
169 typedef struct MirSurfaceParameters
170 {
171  char const *name;
172  int width;
173  int height;
175  MirBufferUsage buffer_usage;
184  uint32_t output_id;
186 
188 
197 #ifndef __cplusplus
198 __attribute__ ((deprecated))
199 #endif
200 typedef enum MirPlatformType
201 {
206 
207 typedef struct MirPlatformPackage
208 {
210  int fd_items;
211 
215 
223 typedef struct MirModuleProperties
224 {
225  char const *name;
229  char const *filename;
231 
236 typedef struct MirGraphicsRegion
237 {
238  int width;
239  int height;
240  int stride;
242  char *vaddr;
243 
245 
250 typedef struct MirDisplayInfo
251 {
252  uint32_t width;
253  uint32_t height;
254 
258 
263 typedef struct MirDisplayCard
264 {
265  uint32_t card_id;
268 
270 {
288 
289 typedef enum MirOutputType
290 {
307 } MirOutputType;
308 
310 {
315 
316 typedef struct MirDisplayMode
317 {
320  double refresh_rate;
322 
324 
325 typedef struct MirDisplayOutput
326 {
327  uint32_t num_modes;
329  uint32_t preferred_mode;
331  uint32_t current_mode;
332 
336 
337  uint32_t card_id;
338  uint32_t output_id;
339  MirDisplayOutputType type;
340 
341  int32_t position_x;
342  int32_t position_y;
343  uint32_t connected;
344  uint32_t used;
345 
348 
352 
354 {
355  uint32_t num_outputs;
357  uint32_t num_cards;
360 
364 typedef struct MirBufferStreamInfo
365 {
370 
371 typedef struct MirRectangle
372 {
373  int left;
374  int top;
375  unsigned int width;
376  unsigned int height;
377 } MirRectangle;
378 
381 
389 {
396  unsigned int width;
398  unsigned int height;
405 
411 typedef void (*mir_screencast_callback)(MirScreencast *screencast, void *client_context);
412 
418 typedef void (*mir_prompt_session_callback)(MirPromptSession* prompt_provider, void* context);
419 
427  MirPromptSession* prompt_provider, MirPromptSessionState state, void* context);
428 
440  MirConnection* connection, MirPlatformMessage* reply, void* context);
441 
450  MirConnection* connection, void* context);
451 
457 typedef enum MirErrorDomain
458 {
466 
476 
477 typedef void (*mir_error_callback)(
478  MirConnection* connection,
479  MirError const* error,
480  void* context);
481 
482 #ifdef __cplusplus
483 }
485 #endif
486 
487 #endif /* MIR_TOOLKIT_CLIENT_TYPES_H_ */
struct MirOutput MirOutput
Descriptor for an output connection.
Definition: client_types.h:59
Definition: mir_screencast.h:50
uint32_t physical_height_mm
Definition: client_types.h:347
int displacement_y
Definition: client_types.h:368
MirPowerMode power_mode
Definition: client_types.h:349
Definition: client_types.h:207
Definition: client_types.h:353
Definition: mir_surface.h:86
struct MirDisplayConfig MirDisplayConfig
Definition: client_types.h:49
struct MirModuleProperties MirModuleProperties
Retrieved information about a loadable module.
struct MirScreencastParameters MirScreencastParameters
MirScreencastParameters is the structure of required information that you must provide to Mir in orde...
int left
Definition: client_types.h:373
Definition: mir_surface.h:147
void(* mir_lifecycle_event_callback)(MirConnection *connection, MirLifecycleState state, void *context)
Callback called when a lifecycle event/callback is requested from the running server.
Definition: client_types.h:115
struct MirBufferStream MirBufferStream
Definition: client_types.h:46
MirScreencastParameters is the structure of required information that you must provide to Mir in orde...
Definition: client_types.h:388
void(* mir_surface_id_callback)(MirSurface *surface, MirPersistentId *id, void *context)
Definition: client_types.h:151
Definition: client_types.h:296
struct MirSurfaceParameters MirSurfaceParameters
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in...
Definition: client_types.h:272
Definition: client_types.h:284
Definition: client_types.h:305
void(* mir_surface_event_callback)(MirSurface *surface, MirEvent const *event, void *context)
Callback for handling of surface events.
Definition: client_types.h:104
MirOrientation orientation
Definition: client_types.h:350
Definition: mir_wait_handle.h:31
void(* mir_buffer_stream_callback)(MirBufferStream *stream, void *client_context)
Callback to be passed when calling:
Definition: client_types.h:96
int height
Definition: client_types.h:173
struct MirBlob MirBlob
Definition: client_types.h:48
int top
Definition: client_types.h:374
MirPromptSessionState
Definition: common.h:109
MirPixelFormat pixel_format
Definition: client_types.h:174
uint32_t output_id
The id of the output to place the surface in.
Definition: client_types.h:184
Definition: client_types.h:271
Definition: client_types.h:283
Definition: client_types.h:304
Definition: client_types.h:291
MirDisplayMode * modes
Definition: client_types.h:328
int __attribute__((constructor)) init_google_protobuf()
Definition: google_protobuf_guard.cpp:21
Definition: client_types.h:286
int32_t position_y
Definition: client_types.h:342
Definition: client_types.h:202
Definition: client_types.h:292
MirOutputConnectionState
Definition: client_types.h:309
struct MirInputDevice MirInputDevice
Definition: client_types.h:380
Definition: mir_error.h:24
int displacement_x
Definition: client_types.h:367
MirDisplayCard * cards
Definition: client_types.h:358
Definition: client_types.h:161
unsigned int height
The height of the screencast which can be different than the screen region capture height...
Definition: client_types.h:398
The displacement from the top-left corner of the surface.
Definition: client_types.h:364
uint32_t output_id
Definition: client_types.h:338
Definition: client_types.h:323
uint32_t used
Definition: client_types.h:344
Definition: client_types.h:295
Definition: client_types.h:187
int32_t position_x
Definition: client_types.h:341
uint32_t width
Definition: client_types.h:252
Definition: mir_screencast.h:69
struct MirDisplayMode MirDisplayMode
uint32_t height
Definition: client_types.h:253
int stride
Definition: client_types.h:240
Definition: client_types.h:285
uint32_t connected
Definition: client_types.h:343
Definition: client_types.h:299
MirDisplayConfiguration provides details of the graphics environment.
Definition: client_types.h:263
Definition: client_types.h:280
Definition: client_types.h:316
int height
Definition: client_types.h:239
uint32_t vertical_resolution
Definition: client_types.h:318
MirPixelFormat pixel_format
Definition: client_types.h:241
MirPixelFormat current_format
Definition: client_types.h:335
Definition: client_types.h:300
char const * name
Definition: client_types.h:225
struct MirDisplayConfiguration MirDisplayConfiguration
void(* mir_client_fd_callback)(MirPromptSession *prompt_session, size_t count, int const *fds, void *context)
Callback called when a request for client file descriptors completes.
Definition: client_types.h:147
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition: common.h:164
char const * name
Definition: client_types.h:171
Definition: client_types.h:203
uint32_t card_id
Definition: client_types.h:265
struct MirBufferStreamInfo MirBufferStreamInfo
The displacement from the top-left corner of the surface.
char * vaddr
Definition: client_types.h:242
void(* mir_screencast_callback)(MirScreencast *screencast, void *client_context)
Callback to be passed when calling MirScreencast functions.
Definition: client_types.h:411
MirDisplayConfigurationError
Errors from the mir_error_domain_display_configuration MirErrorDomain.
Definition: client_types.h:470
Definition: mir_surface.h:136
struct MirGraphicsRegion MirGraphicsRegion
Retrieved information about a MirSurface.
uint32_t num_outputs
Definition: client_types.h:355
Retrieved information about a loadable module.
Definition: client_types.h:223
Definition: client_types.h:311
uint32_t current_mode
Definition: client_types.h:331
Definition: client_types.h:250
uint32_t num_output_formats
Definition: client_types.h:333
void(* mir_ping_event_callback)(MirConnection *connection, int32_t serial, void *context)
Callback called when the server pings for responsiveness testing.
Definition: client_types.h:125
Definition: client_types.h:325
MirErrorDomain
Specifies the origin of an error.
Definition: client_types.h:457
Definition: client_types.h:273
struct MirPlatformMessage MirPlatformMessage
Definition: client_types.h:68
Definition: client_types.h:275
struct MirPlatformPackage MirPlatformPackage
struct MirDisplayOutput MirDisplayOutput
struct MirDisplayInfo MirDisplayInfo
uint32_t physical_width_mm
Definition: client_types.h:346
void(* mir_platform_operation_callback)(MirConnection *connection, MirPlatformMessage *reply, void *context)
Callback called when a platform operation completes.
Definition: client_types.h:439
Errors relating to display configuration.
Definition: client_types.h:464
int supported_pixel_format_items
Definition: client_types.h:255
Definition: client_types.h:276
MirPixelFormat * output_formats
Definition: client_types.h:334
int minor_version
Definition: client_types.h:227
MirPowerMode
Definition: common.h:101
void(* mir_input_config_callback)(MirConnection *connection, void *context)
Callback called when a change of input devices has occurred.
Definition: client_types.h:449
Definition: client_types.h:298
unsigned int width
Definition: client_types.h:375
void(* mir_error_callback)(MirConnection *connection, MirError const *error, void *context)
Definition: client_types.h:477
MirBufferUsage
MirBufferUsage specifies how a surface can and will be used.
Definition: client_types.h:159
Definition: client_types.h:277
Definition: mir_prompt_session.h:49
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:134
int fd_items
Definition: client_types.h:210
void(* mir_surface_callback)(MirSurface *surface, void *client_context)
Callback to be passed when calling:
Definition: client_types.h:87
void(* mir_prompt_session_callback)(MirPromptSession *prompt_provider, void *context)
Callback member of MirPromptSession for handling of prompt sessions.
Definition: client_types.h:418
uint32_t max_simultaneous_outputs
Definition: client_types.h:266
MirBufferUsage buffer_usage
Definition: client_types.h:175
uint32_t num_cards
Definition: client_types.h:357
double refresh_rate
Definition: client_types.h:320
MirLifecycleState
Definition: common.h:94
MirRectangle region
The rectangular region of the screen to capture - The region is specified in virtual screen space hen...
Definition: client_types.h:394
uint32_t preferred_mode
There might be no preferred mode, which is indicated by a value >=num_modes.
Definition: client_types.h:329
unsigned int height
Definition: client_types.h:376
void * MirEGLNativeWindowType
Definition: client_types.h:38
Definition: client_types.h:204
Definition: client_types.h:294
MirPixelFormat pixel_format
The pixel format of the screencast.
Definition: client_types.h:403
int data_items
Definition: client_types.h:209
unsigned int width
The width of the screencast which can be different than the screen region capture width...
Definition: client_types.h:396
void(* mir_connected_callback)(MirConnection *connection, void *client_context)
Callback to be passed when issuing a mir_connect request.
Definition: client_types.h:76
MirDisplayOutputType type
Definition: client_types.h:339
Definition: client_types.h:282
Definition: client_types.h:297
error
Definition: connector_report_tp.h:56
Definition: mir_connection.h:96
MirDisplayOutputType
Definition: client_types.h:269
Definition: client_types.h:279
Definition: client_types.h:293
Definition: client_types.h:301
int micro_version
Definition: client_types.h:228
Definition: client_types.h:371
Retrieved information about a MirSurface.
Definition: client_types.h:236
int major_version
Definition: client_types.h:226
Definition: client_types.h:302
struct MirRectangle MirRectangle
int width
Definition: client_types.h:172
Definition: client_types.h:274
void(* mir_display_config_callback)(MirConnection *connection, void *context)
Callback called when a display config change has occurred.
Definition: client_types.h:134
MirOutputType
Definition: client_types.h:289
char const * filename
Definition: client_types.h:229
Definition: client_types.h:303
uint32_t num_modes
Definition: client_types.h:327
struct MirDisplayCard MirDisplayCard
MirDisplayConfiguration provides details of the graphics environment.
uint32_t card_id
Definition: client_types.h:337
Definition: client_types.h:281
int width
Definition: client_types.h:238
MirPlatformType
The native buffer type for the system the client is connected on.
Definition: client_types.h:200
MirDisplayOutput * outputs
Definition: client_types.h:356
struct MirInputConfig MirInputConfig
Definition: client_types.h:379
Definition: client_types.h:313
Definition: client_types.h:249
Definition: client_types.h:162
Definition: event.h:30
Definition: client_types.h:306
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in...
Definition: client_types.h:169
Definition: client_types.h:278
void(* mir_prompt_session_state_change_callback)(MirPromptSession *prompt_provider, MirPromptSessionState state, void *context)
Callback member of MirPromptSession for handling of prompt sessions events.
Definition: client_types.h:426
MirBufferStream * stream
Definition: client_types.h:366
uint32_t horizontal_resolution
Definition: client_types.h:319
void * MirEGLNativeDisplayType
Definition: client_types.h:39
Client is not permitted to change global display configuration.
Definition: client_types.h:474
Definition: client_types.h:312

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Sep 8 14:50:19 UTC 2016