Mir
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
include
client
mir_toolkit
mir_client_library.h
Go to the documentation of this file.
1
/*
2
* Copyright © 2012-2013 Canonical Ltd.
3
*
4
* This program is free software: you can redistribute it and/or modify it
5
* under the terms of the GNU Lesser General Public License version 3,
6
* as published by the Free Software Foundation.
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU Lesser General Public License for more details.
12
*
13
* You should have received a copy of the GNU Lesser General Public License
14
* along with this program. If not, see <http://www.gnu.org/licenses/>.
15
*
16
*/
17
18
#ifndef MIR_CLIENT_LIBRARY_H
19
#define MIR_CLIENT_LIBRARY_H
20
21
#include <
mir_toolkit/mir_native_buffer.h
>
22
#include <
mir_toolkit/client_types.h
>
23
#include <
mir_toolkit/common.h
>
24
25
#ifdef __cplusplus
26
30
extern
"C"
{
31
#endif
32
33
/* This header defines the Mir client library's C API. */
34
51
MirWaitHandle
*
mir_connect
(
52
char
const
*server,
53
char
const
*app_name,
54
mir_connected_callback
callback,
55
void
*context);
56
64
MirConnection
*
mir_connect_sync
(
char
const
*server,
char
const
*app_name);
65
72
int
mir_connection_is_valid
(
MirConnection
*connection);
73
82
char
const
*
mir_connection_get_error_message
(
MirConnection
*connection);
83
88
void
mir_connection_release
(
MirConnection
*connection);
89
96
void
mir_connection_get_platform
(
MirConnection
*connection,
MirPlatformPackage
*platform_package);
97
104
void
mir_connection_set_lifecycle_event_callback
(
MirConnection
* connection,
105
mir_lifecycle_event_callback
callback,
void
* context);
106
110
__attribute__
((__deprecated__(
"Use mir_connection_create_display_config()"
)))
111
void
mir_connection_get_display_info
(
MirConnection
*connection,
MirDisplayInfo
*
display_info
);
112
120
MirDisplayConfiguration
*
mir_connection_create_display_config
(
MirConnection
*connection);
121
132
void
mir_connection_set_display_config_change_callback
(
133
MirConnection
* connection,
134
mir_display_config_callback
callback,
void
* context);
135
140
void
mir_display_config_destroy
(
MirDisplayConfiguration
* display_configuration);
141
155
MirWaitHandle
*
mir_connection_apply_display_config
(
MirConnection
*connection,
MirDisplayConfiguration
* display_configuration);
156
162
MirEGLNativeDisplayType
mir_connection_get_egl_native_display
(
MirConnection
*connection);
163
171
void
mir_connection_get_available_surface_formats
(
172
MirConnection
* connection,
MirPixelFormat
* formats,
173
unsigned
const
int
format_size,
unsigned
int
*num_valid_formats);
174
190
MirWaitHandle
*
mir_connection_create_surface
(
191
MirConnection
*connection,
192
MirSurfaceParameters
const *surface_parameters,
193
mir_surface_callback
callback,
194
void
*context);
195
203
MirSurface
*
mir_connection_create_surface_sync
(
204
MirConnection
*connection,
205
MirSurfaceParameters
const *params);
206
217
void
mir_surface_set_event_handler
(
MirSurface
*surface,
218
MirEventDelegate
const *event_handler);
219
225
MirEGLNativeWindowType
mir_surface_get_egl_native_window
(
MirSurface
*surface);
226
233
int
mir_surface_is_valid
(
MirSurface
*surface);
234
244
char
const *
mir_surface_get_error_message
(
MirSurface
*surface);
245
252
void
mir_surface_get_parameters
(
MirSurface
*surface,
MirSurfaceParameters
*parameters);
253
261
MirPlatformType
mir_surface_get_platform_type
(
MirSurface
*surface);
262
269
void
mir_surface_get_current_buffer
(
MirSurface
*surface,
MirNativeBuffer
**buffer_package);
270
278
void
mir_surface_get_graphics_region
(
279
MirSurface
*surface,
280
MirGraphicsRegion
*graphics_region);
281
295
MirWaitHandle
*
mir_surface_swap_buffers
(
296
MirSurface
*surface,
297
mir_surface_callback
callback,
298
void
*context);
299
305
void
mir_surface_swap_buffers_sync
(
MirSurface
*surface);
306
319
MirWaitHandle
*
mir_surface_release
(
320
MirSurface
*surface,
321
mir_surface_callback
callback,
322
void
*context);
323
329
void
mir_surface_release_sync
(
MirSurface
*surface);
330
336
void
mir_wait_for
(
MirWaitHandle
*wait_handle);
337
345
void
mir_wait_for_one
(
MirWaitHandle
*wait_handle);
346
350
__attribute__
((__deprecated__("Use
mir_debug_surface_id
()")))
351
int
mir_surface_get_id
(
MirSurface
*surface);
352
361
MirWaitHandle
*
mir_surface_set_type
(
MirSurface
*surface,
MirSurfaceType
type);
362
368
MirSurfaceType
mir_surface_get_type
(
MirSurface
*surface);
369
376
MirWaitHandle
*
mir_surface_set_state
(
MirSurface
*surface,
377
MirSurfaceState
state);
378
384
MirSurfaceState
mir_surface_get_state
(
MirSurface
*surface);
385
396
MirWaitHandle
*
mir_surface_set_swapinterval
(
MirSurface
* surface,
int
interval);
397
405
int
mir_surface_get_swapinterval
(
MirSurface
* surface);
406
407
#ifdef __cplusplus
408
}
410
#endif
411
412
#endif
/* MIR_CLIENT_LIBRARY_H */
Copyright © 2012,2013 Canonical Ltd.
Generated on Wed Oct 30 18:52:19 UTC 2013