Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 #ifdef __cplusplus
25 
29 extern "C" {
30 #endif
31 
49  char const *server,
50  char const *app_name,
51  mir_connected_callback callback,
52  void *context);
53 
61 MirConnection *mir_connect_sync(char const *server, char const *app_name);
62 
70 
79 char const *mir_connection_get_error_message(MirConnection *connection);
80 
85 void mir_connection_release(MirConnection *connection);
86 
93 void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package);
94 
102  mir_lifecycle_event_callback callback, void* context);
103 
107 __attribute__((__deprecated__("Use mir_connection_create_display_config()")))
109 
118 
130  MirConnection* connection,
131  mir_display_config_callback callback, void* context);
132 
137 void mir_display_config_destroy(MirDisplayConfiguration* display_configuration);
138 
153 
160 
169  MirConnection* connection, MirPixelFormat* formats,
170  unsigned const int format_size, unsigned int *num_valid_formats);
171 
172 #ifdef __cplusplus
173 }
175 #endif
176 
177 #endif /* MIR_TOOLKIT_MIR_CONNECTION_H_ */
MirDisplayConfiguration * mir_connection_create_display_config(MirConnection *connection)
Query the display.
Definition: mir_connection_api.cpp:241
Definition: client_types.h:164
Definition: client_types.h:266
void(* mir_connected_callback)(MirConnection *connection, void *client_context)
Callback to be passed when issuing a mir_connect request.
Definition: client_types.h:64
char const * mir_connection_get_error_message(MirConnection *connection)
Retrieve a text description of the last error.
Definition: mir_connection_api.cpp:160
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:183
void mir_connection_release(MirConnection *connection)
Release a connection to the Mir server.
Definition: mir_connection_api.cpp:165
MirBool
Definition: client_types.h:37
Definition: mir_wait_handle.h:31
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:127
MirDisplayInfo * display_info
Definition: mir_connection.h:108
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:283
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:143
MirWaitHandle * mir_connection_apply_display_config(MirConnection *connection, MirDisplayConfiguration *display_configuration)
Apply the display configuration.
Definition: mir_connection_api.cpp:263
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:176
Definition: client_types.h:192
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition: common.h:119
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:95
MirBool mir_connection_is_valid(MirConnection *connection)
Test for a valid connection.
Definition: mir_connection_api.cpp:155
void(* mir_display_config_callback)(MirConnection *connection, void *context)
Callback called when a display config change has occurred.
Definition: client_types.h:104
void mir_display_config_destroy(MirDisplayConfiguration *display_configuration)
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config.
Definition: mir_connection_api.cpp:258
Definition: mir_connection.h:72
void mir_connection_get_display_info(MirConnection *connection, MirDisplayInfo *display_info)
Definition: mir_connection_api.cpp:193
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:277
__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:249
void * MirEGLNativeDisplayType
Definition: client_types.h:45

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014