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  mir_connected_callback 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 
104  mir_lifecycle_event_callback callback, void* context);
105 
109 __attribute__((__deprecated__("Use mir_connection_create_display_config()")))
111 
120 
132  MirConnection* connection,
133  mir_display_config_callback callback, void* context);
134 
139 void mir_display_config_destroy(MirDisplayConfiguration* display_configuration);
140 
155 
162 
171  MirConnection* connection, MirPixelFormat* formats,
172  unsigned const int format_size, unsigned int *num_valid_formats);
173 
187  MirConnection* connection,
188  MirPlatformMessage const* request,
189  mir_platform_operation_callback callback, void* context);
190 
191 #ifdef __cplusplus
192 }
194 #endif
195 
196 #endif /* MIR_TOOLKIT_MIR_CONNECTION_H_ */
MirDisplayConfiguration * mir_connection_create_display_config(MirConnection *connection)
Query the display.
Definition: mir_connection_api.cpp:255
Definition: client_types.h:167
Definition: client_types.h:270
char const * mir_connection_get_error_message(MirConnection *connection)
Retrieve a text description of the last error.
Definition: mir_connection_api.cpp:173
void mir_connection_set_lifecycle_event_callback(MirConnection *connection, mir_lifecycle_event_callback callback, void *context)
Register a callback to be called when a Lifecycle state change occurs.
Definition: mir_connection_api.cpp:197
void mir_connection_release(MirConnection *connection)
Release a connection to the Mir server.
Definition: mir_connection_api.cpp:178
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:98
Definition: mir_wait_handle.h:31
MirWaitHandle * mir_connection_platform_operation(MirConnection *connection, MirPlatformMessage const *request, mir_platform_operation_callback callback, void *context)
Perform a platform specific operation.
MirWaitHandle * mir_connect(char const *server, char const *app_name, mir_connected_callback callback, void *context)
Request a connection to the Mir server.
Definition: mir_connection_api.cpp:135
MirDisplayInfo * display_info
Definition: mir_connection.h:110
void mir_connection_get_available_surface_formats(MirConnection *connection, MirPixelFormat *formats, unsigned const int format_size, unsigned int *num_valid_formats)
Get the list of possible formats that a surface can be created with.
Definition: mir_connection_api.cpp:298
MirConnection * mir_connect_sync(char const *server, char const *app_name)
Perform a mir_connect() but also wait for and return the result.
Definition: mir_connection_api.cpp:156
MirWaitHandle * mir_connection_apply_display_config(MirConnection *connection, MirDisplayConfiguration *display_configuration)
Apply the display configuration.
Definition: mir_connection_api.cpp:277
void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package)
Query platform-specific data and/or file descriptors that are required to initialize GL/EGL features...
Definition: mir_connection_api.cpp:190
Definition: client_types.h:195
struct MirPlatformMessage MirPlatformMessage
Definition: client_types.h:59
bool mir_connection_is_valid(MirConnection *connection)
Test for a valid connection.
Definition: mir_connection_api.cpp:168
void(* mir_platform_operation_callback)(MirConnection *connection, MirPlatformMessage *reply, void *context)
Callback called when a platform operation completes.
Definition: client_types.h:353
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition: common.h:127
void mir_display_config_destroy(MirDisplayConfiguration *display_configuration)
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config.
Definition: mir_connection_api.cpp:272
void(* mir_connected_callback)(MirConnection *connection, void *client_context)
Callback to be passed when issuing a mir_connect request.
Definition: client_types.h:67
Definition: mir_connection.h:79
void mir_connection_get_display_info(MirConnection *connection, MirDisplayInfo *display_info)
Definition: mir_connection_api.cpp:207
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_connection_api.cpp:292
void(* mir_display_config_callback)(MirConnection *connection, void *context)
Callback called when a display config change has occurred.
Definition: client_types.h:107
__attribute__((__deprecated__("Use mir_connection_create_display_config()"))) void mir_connection_get_display_info(MirConnection *connection
void mir_connection_set_display_config_change_callback(MirConnection *connection, mir_display_config_callback callback, void *context)
Register a callback to be called when the hardware display configuration changes. ...
Definition: mir_connection_api.cpp:263
void * MirEGLNativeDisplayType
Definition: client_types.h:45

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015