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
|
/*
* Copyright © 2012-2013 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef MIR_CLIENT_LIBRARY_H
#define MIR_CLIENT_LIBRARY_H
#include "mir_toolkit/c_types.h"
#include <mir_toolkit/common.h>
#ifdef __cplusplus
/**
* \addtogroup mir_toolkit
* @{
*/
extern "C" {
#endif
/* This header defines the Mir client library's C API. */
/**
* Request a connection to the Mir server. The supplied callback is called when
* the connection is established, or fails. The returned wait handle remains
* valid until the connection has been released.
* \param [in] server File path of the server socket to connect to, or
* NULL to choose the default server
* \param [in] app_name A name referring to the application
* \param [in] callback Callback function to be invoked when request
* completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_connect(
char const *server,
char const *app_name,
mir_connected_callback callback,
void *context);
/**
* Perform a mir_connect() but also wait for and return the result.
* \param [in] server File path of the server socket to connect to, or
* NULL to choose the default server
* \param [in] app_name A name referring to the application
* \return The resulting MirConnection
*/
MirConnection *mir_connect_sync(char const *server, char const *app_name);
/**
* Test for a valid connection
* \param [in] connection The connection
* \return A non-zero value if the supplied connection is
* valid, 0 otherwise
*/
int mir_connection_is_valid(MirConnection *connection);
/**
* Retrieve a text description of the last error. The returned string is owned
* by the library and remains valid until the connection has been released.
* \param [in] connection The connection
* \return A text description of any error resulting in an
* invalid connection, or the empty string "" if the
* connection is valid.
*/
char const *mir_connection_get_error_message(MirConnection *connection);
/**
* Release a connection to the Mir server
* \param [in] connection The connection
*/
void mir_connection_release(MirConnection *connection);
/**
* Query platform-specific data and/or file descriptors that are required to
* initialize GL/EGL features.
* \param [in] connection The connection
* \param [out] platform_package Structure to be populated
*/
void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package);
/**
* Query the display
* \param [in] connection The connection
* \param [out] display_info Structure to be populated
*/
void mir_connection_get_display_info(MirConnection *connection, MirDisplayInfo *display_info);
/**
* Get a display type that can be used for OpenGL ES 2.0 acceleration.
* \param [in] connection The connection
* \return An EGLNativeDisplayType that the client can use
*/
MirEGLNativeDisplayType mir_connection_get_egl_native_display(MirConnection *connection);
/**
* Request a new Mir surface on the supplied connection with the supplied
* parameters. The returned handle remains valid until the surface has been
* released.
* \param [in] connection The connection
* \param [in] surface_parameters Request surface parameters
* \param [in] callback Callback function to be invoked when
* request completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to
* mir_wait_for
*/
MirWaitHandle *mir_connection_create_surface(
MirConnection *connection,
MirSurfaceParameters const *surface_parameters,
mir_surface_lifecycle_callback callback,
void *context);
/**
* Create a surface like in mir_connection_create_surface(), but also wait for
* creation to complete and return the resulting surface.
* \param [in] connection The connection
* \param [in] params Parameters describing the desired surface
* \return The resulting surface
*/
MirSurface *mir_connection_create_surface_sync(
MirConnection *connection,
MirSurfaceParameters const *params);
/**
* Set the event handler to be called when events arrive for a surface.
* \param [in] surface The surface
* \param [in] event_handler The event handler to call
*/
void mir_surface_set_event_handler(MirSurface *surface,
MirEventDelegate const *event_handler);
/**
* Get a window type that can be used for OpenGL ES 2.0 acceleration.
* \param [in] surface The surface
* \return An EGLNativeWindowType that the client can use
*/
MirEGLNativeWindowType mir_surface_get_egl_native_window(MirSurface *surface);
/**
* Test for a valid surface
* \param [in] surface The surface
* \return A non-zero value if the supplied surface is valid,
* 0 otherwise
*/
int mir_surface_is_valid(MirSurface *surface);
/**
* Retrieve a text description of the error. The returned string is owned by
* the library and remains valid until the surface or the associated
* connection has been released.
* \param [in] surface The surface
* \return A text description of any error resulting in an
* invalid surface, or the empty string "" if the
* connection is valid.
*/
char const *mir_surface_get_error_message(MirSurface *surface);
/**
* Get a surface's parameters.
* \pre The surface is valid
* \param [in] surface The surface
* \param [out] parameters Structure to be populated
*/
void mir_surface_get_parameters(MirSurface *surface, MirSurfaceParameters *parameters);
/**
* Get a surface's buffer in "raw" representation.
* \pre The surface is valid
* \param [in] surface The surface
* \param [out] buffer_package Structure to be populated
*/
void mir_surface_get_current_buffer(MirSurface *surface, MirBufferPackage *buffer_package);
/**
* Get a surface's graphics_region, i.e., map the graphics buffer to main
* memory.
* \pre The surface is valid
* \param [in] surface The surface
* \param [out] graphics_region Structure to be populated
*/
void mir_surface_get_graphics_region(
MirSurface *surface,
MirGraphicsRegion *graphics_region);
/**
* Advance a surface's buffer. The returned handle remains valid until the next
* call to mir_surface_next_buffer, until the surface has been released or the
* connection to the server has been released.
* \param [in] surface The surface
* \param [in] callback Callback function to be invoked when the request
* completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_surface_next_buffer(
MirSurface *surface,
mir_surface_lifecycle_callback callback,
void *context);
/**
* Advance a surface's buffer as in mir_surface_next_buffer(), but also wait
* for the operation to complete.
* \param [in] surface The surface whose buffer to advance
*/
void mir_surface_next_buffer_sync(MirSurface *surface);
/**
* Release the supplied surface and any associated buffer. The returned wait
* handle remains valid until the connection to the server is released.
* \param [in] surface The surface
* \param [in] callback Callback function to be invoked when the request
* completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle *mir_surface_release(
MirSurface *surface,
mir_surface_lifecycle_callback callback,
void *context);
/**
* Release the specified surface like in mir_surface_release(), but also wait
* for the operation to complete.
* \param [in] surface The surface to be released
*/
void mir_surface_release_sync(MirSurface *surface);
/**
* Wait on the supplied handle until the associated request has completed.
* \param [in] wait_handle Handle returned by an asynchronous request
*/
void mir_wait_for(MirWaitHandle *wait_handle);
/**
* Return the ID of a surface (only useful for debug output).
* \param [in] surface The surface
* \return An internal ID that identifies the surface
*/
int mir_surface_get_id(MirSurface *surface);
/**
* Set the type (purpose) of a surface. This is not guaranteed to always work
* with some shell types (e.g. phone/tablet UIs). As such, you may have to
* wait on the function and check the result using mir_surface_get_type.
* \param [in] surface The surface to operate on
* \param [in] type The new type of the surface
* \return A wait handle that can be passed to mir_wait_for
*/
MirWaitHandle* mir_surface_set_type(MirSurface *surface, MirSurfaceType type);
/**
* Get the type (purpose) of a surface.
* \param [in] surface The surface to query
* \return The type of the surface
*/
MirSurfaceType mir_surface_get_type(MirSurface *surface);
/**
* Change the state of a surface.
* \param [in] surface The surface to operate on
* \param [in] state The new state of the surface
* \return A wait handle that can be passed to mir_wait_for
*/
MirWaitHandle* mir_surface_set_state(MirSurface *surface,
MirSurfaceState state);
/**
* Get the current state of a surface.
* \param [in] surface The surface to query
* \return The state of the surface
*/
MirSurfaceState mir_surface_get_state(MirSurface *surface);
#ifdef __cplusplus
}
/**@}*/
#endif
#endif /* MIR_CLIENT_LIBRARY_H */
|