Mir
mir_connection.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2012-2014 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_TOOLKIT_MIR_CONNECTION_H_
19 #define MIR_TOOLKIT_MIR_CONNECTION_H_
20 
22 #include <mir_toolkit/common.h>
23 
24 #include <stdbool.h>
25 
26 #ifdef __cplusplus
27 
31 extern "C" {
32 #endif
33 
51  char const *server,
52  char const *app_name,
53  MirConnectedCallback callback,
54  void *context);
55 
63 MirConnection *mir_connect_sync(char const *server, char const *app_name);
64 
71 bool mir_connection_is_valid(MirConnection *connection);
72 
81 char const *mir_connection_get_error_message(MirConnection *connection);
82 
87 void mir_connection_release(MirConnection *connection);
88 
95 void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package)
96 __attribute__((deprecated("use platform extensions instead")));
97 
108 __attribute__((deprecated("use graphics module extension instead")));
109 
117  MirLifecycleEventCallback callback, void* context);
118 
119 
138  MirPingEventCallback callback, void* context);
139 
140 
146 void mir_connection_pong(MirConnection* connection, int32_t serial);
147 
159 __attribute__ ((deprecated("use mir_connection_create_display_configuration instead")));
160 
171 
183  MirConnection* connection,
184  MirDisplayConfigCallback callback, void* context);
185 
190 void mir_display_config_destroy(MirDisplayConfiguration* display_configuration)
191 __attribute__ ((deprecated("use mir_display_config_release instead")));
192 
207 __attribute__ ((deprecated("use mir_connection_apply_session_display_config instead")));
208 
220 void mir_connection_apply_session_display_config(MirConnection* connection, MirDisplayConfig const* display_config);
221 
232 
255  MirConnection* connection,
256  MirDisplayConfiguration const* display_configuration)
257 __attribute__ ((deprecated("use mir_connection_preview_base_display_configuration/mir_connection_confirm_base_display_configuration")));
258 
259 
286  MirConnection* connection,
287  MirDisplayConfig const* configuration,
288  int timeout_seconds);
289 
310  MirConnection* connection,
311  MirDisplayConfig const* configuration);
312 
327  MirConnection* connection);
328 
335 
345  MirConnection *connection, void *egldisplay, void *eglconfig);
346 
363  MirConnection* connection, MirPixelFormat* formats,
364  unsigned const int formats_size, unsigned int *num_valid_formats);
365 
379  MirConnection* connection,
380  MirPlatformMessage const* request,
381  MirPlatformOperationCallback callback, void* context)
382 __attribute__ ((deprecated("use platform specific extensions instead")));
383 
392 
401 void mir_input_config_destroy(MirInputConfig const* config)
402 __attribute__ ((deprecated("use mir_input_config_release instead")));
403 
410 void mir_input_config_release(MirInputConfig const* config);
411 
412 
424  MirConnection* connection,
425  MirInputConfigCallback callback, void* context);
426 
435  MirConnection* connection,
436  MirErrorCallback callback,
437  void* context);
438 
439 #ifdef __cplusplus
440 }
442 #endif
443 
444 #endif /* MIR_TOOLKIT_MIR_CONNECTION_H_ */
void mir_connection_pong(MirConnection *connection, int32_t serial)
Respond to a ping event.
void(* MirDisplayConfigCallback)(MirConnection *connection, void *context)
Callback called when a display config change has occurred.
Definition: client_types.h:147
Definition: client_types.h:226
Definition: client_types.h:369
struct MirDisplayConfig MirDisplayConfig
Definition: client_types.h:52
char const * mir_connection_get_error_message(MirConnection *connection)
Retrieve a text description of the last error.
void mir_connection_release(MirConnection *connection)
Release a connection to the Mir server.
void mir_connection_set_display_config_change_callback(MirConnection *connection, MirDisplayConfigCallback callback, void *context)
Register a callback to be called when the hardware display configuration changes. ...
void(* MirPingEventCallback)(MirConnection *connection, int32_t serial, void *context)
Callback called when the server pings for responsiveness testing.
Definition: client_types.h:136
void mir_connection_cancel_base_display_configuration_preview(MirConnection *connection)
Cancel a pending base display configuration preview.
void mir_connection_get_graphics_module(MirConnection *connection, MirModuleProperties *properties) __attribute__((deprecated("use graphics module extension instead")))
Query graphics platform module.
void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package) __attribute__((deprecated("use platform extensions instead")))
Query platform-specific data and/or file descriptors that are required to initialize GL/EGL features...
void(* MirErrorCallback)(MirConnection *connection, MirError const *error, void *context)
Definition: client_types.h:539
void mir_display_config_destroy(MirDisplayConfiguration *display_configuration) __attribute__((deprecated("use mir_display_config_release instead")))
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config.
void(* MirLifecycleEventCallback)(MirConnection *connection, MirLifecycleState state, void *context)
Callback called when a lifecycle event/callback is requested from the running server.
Definition: client_types.h:124
void(* MirInputConfigCallback)(MirConnection *connection, void *context)
Callback called when a change of input devices has occurred.
Definition: client_types.h:479
MirConnection * mir_connect_sync(char const *server, char const *app_name)
Perform a mir_connect() but also wait for and return the result.
MirWaitHandle * mir_connection_set_base_display_config(MirConnection *connection, MirDisplayConfiguration const *display_configuration) __attribute__((deprecated("use mir_connection_preview_base_display_configuration/mir_connection_confirm_base_display_configuration")))
Set the base display configuration.
void mir_connection_remove_session_display_config(MirConnection *connection)
Remove the display configuration for the connection.
MirWaitHandle * mir_connect(char const *server, char const *app_name, MirConnectedCallback callback, void *context)
Request a connection to the Mir server.
void mir_connection_apply_session_display_config(MirConnection *connection, MirDisplayConfig const *display_config)
Apply the display config for the connection.
void(* MirPlatformOperationCallback)(MirConnection *connection, MirPlatformMessage *reply, void *context)
Callback called when a platform operation completes.
Definition: client_types.h:467
void mir_connection_set_input_config_change_callback(MirConnection *connection, MirInputConfigCallback callback, void *context)
Register a callback to be called when the input devices change.
void mir_connection_preview_base_display_configuration(MirConnection *connection, MirDisplayConfig const *configuration, int timeout_seconds)
Preview a new base display configuration.
void mir_connection_get_available_surface_formats(MirConnection *connection, MirPixelFormat *formats, unsigned const int formats_size, unsigned int *num_valid_formats)
Get the list of possible formats that a surface can be created with.
struct MirWaitHandle MirWaitHandle
Returned by asynchronous functions.
Definition: client_types.h:72
Retrieved information about a loadable module.
Definition: client_types.h:242
MirDisplayConfig * mir_connection_create_display_configuration(MirConnection *connection)
Query the display.
void mir_connection_set_lifecycle_event_callback(MirConnection *connection, MirLifecycleEventCallback callback, void *context)
Register a callback to be called when a Lifecycle state change occurs.
void(* MirConnectedCallback)(MirConnection *connection, void *client_context)
Callback to be passed when issuing a mir_connect request.
Definition: client_types.h:82
struct MirPlatformMessage MirPlatformMessage
Definition: client_types.h:74
void mir_input_config_destroy(MirInputConfig const *config) __attribute__((deprecated("use mir_input_config_release instead")))
void mir_connection_confirm_base_display_configuration(MirConnection *connection, MirDisplayConfig const *configuration)
Confirm a base configuration change initiated by mir_connection_preview_base_display_configuration() ...
bool mir_connection_is_valid(MirConnection *connection)
Test for a valid connection.
struct MirConnection MirConnection
Definition: client_types.h:40
MirWaitHandle * mir_connection_apply_display_config(MirConnection *connection, MirDisplayConfiguration *display_configuration) __attribute__((deprecated("use mir_connection_apply_session_display_config instead")))
Apply the display configuration.
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:239
MirConnectedCallback mir_connected_callback __attribute__((deprecated("Use MirConnectedCallback instead")))
Release a platform message.
Definition: client_types.h:85
MirPixelFormat mir_connection_get_egl_pixel_format(MirConnection *connection, void *egldisplay, void *eglconfig)
Get the exact MirPixelFormat to use in creating a surface for a chosen EGLConfig. ...
MirDisplayConfiguration * mir_connection_create_display_config(MirConnection *connection) __attribute__((deprecated("use mir_connection_create_display_configuration instead")))
Query the display.
MirWaitHandle * mir_connection_platform_operation(MirConnection *connection, MirPlatformMessage const *request, MirPlatformOperationCallback callback, void *context) __attribute__((deprecated("use platform specific extensions instead")))
Perform a platform specific operation.
MirEGLNativeDisplayType mir_connection_get_egl_native_display(MirConnection *connection)
Get a display type that can be used for OpenGL ES 2.0 acceleration.
Definition: mir_input_config.h:77
void mir_connection_set_ping_event_callback(MirConnection *connection, MirPingEventCallback callback, void *context)
Register a callback for server ping events.
MirInputConfig * mir_connection_create_input_config(MirConnection *connection)
Create a snapshot of the attached input devices and device configurations.
void mir_connection_set_error_callback(MirConnection *connection, MirErrorCallback callback, void *context)
Register a callback to be called on non-fatal errors.
void mir_input_config_release(MirInputConfig const *config)
Release this snapshot of the input configuration.
void * MirEGLNativeDisplayType
Definition: client_types.h:39

Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Mar 27 12:06:55 UTC 2017