Mir
|
Macros | |
#define | MIR_CLIENT_MAJOR_VERSION (1) |
MIR_CLIENT_MAJOR_VERSION. More... | |
#define | MIR_CLIENT_MINOR_VERSION (0) |
MIR_CLIENT_MINOR_VERSION. More... | |
#define | MIR_CLIENT_MICRO_VERSION (0) |
MIR_CLIENT_MICRO_VERSION. More... | |
#define | MIR_CLIENT_VERSION |
MIR_CLIENT_VERSION. More... | |
#define | MIR_BYTES_PER_PIXEL(f) (((f) == mir_pixel_format_bgr_888) ? 3 : 4) |
#define | MIR_INPUT_EVENT_MAX_POINTER_COUNT 16 |
Typedefs | |
typedef struct MirMesaEGLNativeDisplay | MirMesaEGLNativeDisplay |
typedef struct MirMesaEGLNativeSurface | MirMesaEGLNativeSurface |
typedef int(* | MirMesaEGLNativeDisplayIsValidFunc) (MirMesaEGLNativeDisplay *display) |
typedef void(* | mir_drm_auth_magic_callback) (int status, void *context) |
typedef enum MirBool | MirBool |
typedef void * | MirEGLNativeWindowType |
typedef void * | MirEGLNativeDisplayType |
typedef struct MirConnection | MirConnection |
typedef struct MirSurface | MirSurface |
typedef struct MirSurfaceSpec | MirSurfaceSpec |
typedef struct MirScreencast | MirScreencast |
typedef struct MirPromptSession | MirPromptSession |
typedef struct MirWaitHandle | MirWaitHandle |
Returned by asynchronous functions. More... | |
typedef struct MirPlatformMessage | MirPlatformMessage |
typedef void(* | mir_connected_callback) (MirConnection *connection, void *client_context) |
Callback to be passed when issuing a mir_connect request. More... | |
typedef void(* | mir_surface_callback) (MirSurface *surface, void *client_context) |
Callback to be passed when calling: More... | |
typedef void(* | mir_event_delegate_callback) (MirSurface *surface, MirEvent const *event, void *context) |
Callback member of MirEventDelegate for handling of events. More... | |
typedef void(* | mir_lifecycle_event_callback) (MirConnection *connection, MirLifecycleState state, void *context) |
Callback called when a lifecycle event/callback is requested from the running server. More... | |
typedef void(* | mir_display_config_callback) (MirConnection *connection, void *context) |
Callback called when a display config change has occurred. More... | |
typedef void(* | mir_client_fd_callback) (MirPromptSession *prompt_session, size_t count, int const *fds, void *context) |
Callback called when a request for client file descriptors completes. More... | |
typedef enum MirBufferUsage | MirBufferUsage |
MirBufferUsage specifies how a surface can and will be used. More... | |
typedef struct MirSurfaceParameters | MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface. More... | |
typedef enum MirPlatformType | MirPlatformType |
The native buffer type for the system the client is connected on. More... | |
typedef struct MirPlatformPackage | MirPlatformPackage |
typedef struct MirGraphicsRegion | MirGraphicsRegion |
Retrieved information about a MirSurface. More... | |
typedef struct MirDisplayInfo | MirDisplayInfo |
typedef struct MirDisplayCard | MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment. More... | |
typedef enum MirDisplayOutputType | MirDisplayOutputType |
typedef struct MirDisplayMode | MirDisplayMode |
typedef struct MirDisplayOutput | MirDisplayOutput |
typedef struct MirDisplayConfiguration | MirDisplayConfiguration |
typedef struct MirEventDelegate | MirEventDelegate |
MirEventDelegate may be used to specify (at surface creation time) callbacks for handling of events. More... | |
typedef struct MirRectangle | MirRectangle |
typedef struct MirScreencastParameters | MirScreencastParameters |
MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast. More... | |
typedef void(* | mir_screencast_callback) (MirScreencast *screencast, void *client_context) |
Callback to be passed when calling MirScreencast functions. More... | |
typedef void(* | mir_prompt_session_callback) (MirPromptSession *prompt_provider, void *context) |
Callback member of MirPromptSession for handling of prompt sessions. More... | |
typedef void(* | mir_prompt_session_state_change_callback) (MirPromptSession *prompt_provider, MirPromptSessionState state, void *context) |
Callback member of MirPromptSession for handling of prompt sessions events. More... | |
typedef void(* | mir_platform_operation_callback) (MirConnection *connection, MirPlatformMessage *reply, void *context) |
Callback called when a platform operation completes. More... | |
typedef enum MirSurfaceAttrib | MirSurfaceAttrib |
Attributes of a surface that the client and server/shell may wish to get or set over the wire. More... | |
typedef enum MirSurfaceType | MirSurfaceType |
typedef enum MirSurfaceState | MirSurfaceState |
typedef enum MirSurfaceFocusState | MirSurfaceFocusState |
typedef enum MirSurfaceVisibility | MirSurfaceVisibility |
typedef enum MirLifecycleState | MirLifecycleState |
typedef enum MirPowerMode | MirPowerMode |
typedef enum MirPromptSessionState | MirPromptSessionState |
typedef enum MirPixelFormat | MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format. More... | |
typedef enum MirOrientation | MirOrientation |
Direction relative to the "natural" orientation of the display. More... | |
typedef enum MirOrientationMode | MirOrientationMode |
typedef enum MirEdgeAttachment | MirEdgeAttachment |
typedef struct MirSurfaceEvent | MirSurfaceEvent |
typedef struct MirResizeEvent | MirResizeEvent |
typedef struct MirPromptSessionEvent | MirPromptSessionEvent |
typedef struct MirOrientationEvent | MirOrientationEvent |
typedef struct MirCloseSurfaceEvent | MirCloseSurfaceEvent |
typedef struct MirInputEvent | MirInputEvent |
typedef union MirEvent | MirEvent |
typedef int64_t | nsecs_t |
typedef int64_t | MirInputDeviceId |
typedef unsigned int | MirInputEventModifiers |
typedef struct MirKeyInputEvent | MirKeyInputEvent |
An event type describing a change in keyboard state. More... | |
typedef struct MirPointerInputEvent | MirPointerInputEvent |
An event type describing a change in pointer device state. More... | |
typedef struct MirTouchInputEvent | MirTouchInputEvent |
An event type describing a change in touch device state. More... | |
typedef int32_t | MirTouchInputEventTouchId |
An identifier for a touch-point. More... | |
Functions | |
MirWaitHandle * | mir_connection_drm_auth_magic (MirConnection *connection, unsigned int magic, mir_drm_auth_magic_callback callback, void *context) |
int | mir_connection_drm_set_gbm_device (MirConnection *connection, struct gbm_device *dev) |
Set the gbm_device to be used by the EGL implementation. More... | |
MirWaitHandle * | mir_connect (char const *server, char const *app_name, mir_connected_callback callback, void *context) |
Request a connection to the Mir server. More... | |
MirConnection * | mir_connect_sync (char const *server, char const *app_name) |
Perform a mir_connect() but also wait for and return the result. More... | |
bool | mir_connection_is_valid (MirConnection *connection) |
Test for a valid connection. More... | |
char const * | mir_connection_get_error_message (MirConnection *connection) |
Retrieve a text description of the last error. More... | |
void | mir_connection_release (MirConnection *connection) |
Release a connection to the Mir server. More... | |
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. More... | |
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. More... | |
__attribute__ ((__deprecated__("Use mir_connection_create_display_config()"))) void mir_connection_get_display_info(MirConnection *connection | |
MirDisplayConfiguration * | mir_connection_create_display_config (MirConnection *connection) |
Query the display. More... | |
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. More... | |
void | mir_display_config_destroy (MirDisplayConfiguration *display_configuration) |
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config. More... | |
MirWaitHandle * | mir_connection_apply_display_config (MirConnection *connection, MirDisplayConfiguration *display_configuration) |
Apply the display configuration. More... | |
MirEGLNativeDisplayType | mir_connection_get_egl_native_display (MirConnection *connection) |
Get a display type that can be used for OpenGL ES 2.0 acceleration. More... | |
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. More... | |
MirWaitHandle * | mir_connection_platform_operation (MirConnection *connection, MirPlatformMessage const *request, mir_platform_operation_callback callback, void *context) |
Perform a platform specific operation. More... | |
void | mir_cursor_configuration_destroy (MirCursorConfiguration *parameters) |
Release resources assosciated with cursor parameters. More... | |
MirCursorConfiguration * | mir_cursor_configuration_from_name (char const *name) |
Returns a new MirCursorConfiguration representing a named cursor from the system cursor theme. More... | |
MirPlatformMessage * | mir_platform_message_create (unsigned int opcode) |
Create a platform message to use with mir_connection_platform_operation(). More... | |
void | mir_platform_message_release (MirPlatformMessage const *message) |
Release a platform message. More... | |
void | mir_platform_message_set_data (MirPlatformMessage *message, void const *data, size_t data_size) |
Set the data associated with a message. More... | |
void | mir_platform_message_set_fds (MirPlatformMessage *message, int const *fds, size_t num_fds) |
Sets the fds associated with a message. More... | |
unsigned int | mir_platform_message_get_opcode (MirPlatformMessage const *message) |
Get the opcode of a message. More... | |
MirPlatformMessageData | mir_platform_message_get_data (MirPlatformMessage const *message) |
Get the data associated with a message. More... | |
MirPlatformMessageFds | mir_platform_message_get_fds (MirPlatformMessage const *message) |
Gets the fds associated with a message. More... | |
MirPromptSession * | mir_connection_create_prompt_session_sync (MirConnection *connection, pid_t application_pid, mir_prompt_session_state_change_callback state_change_callback, void *context) |
Create and start a new prompt session. More... | |
MirWaitHandle * | mir_prompt_session_new_fds_for_prompt_providers (MirPromptSession *prompt_session, unsigned int no_of_fds, mir_client_fd_callback callback, void *context) |
Allocate some FDs for prompt providers to connect on. More... | |
void | mir_prompt_session_release_sync (MirPromptSession *prompt_session) |
Stop and release the specified prompt session. More... | |
bool | mir_prompt_session_is_valid (MirPromptSession *prompt_session) |
Test for a valid prompt session. More... | |
char const * | mir_prompt_session_error_message (MirPromptSession *prompt_session) |
Retrieve a text description of the last error. More... | |
MirScreencast * | mir_connection_create_screencast_sync (MirConnection *connection, MirScreencastParameters *parameters) |
Create a screencast on the supplied connection. More... | |
void | mir_screencast_release_sync (MirScreencast *screencast) |
Release the specified screencast. More... | |
MirEGLNativeWindowType | mir_screencast_egl_native_window (MirScreencast *screencast) |
Get a window type that can be used by EGL. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_normal_surface (MirConnection *connection, int width, int height, MirPixelFormat format) |
Create a surface specification for a normal surface. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_menu (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge) |
Create a surface specification for a menu surface. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_tooltip (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *zone) |
Create a surface specification for a tooltip surface. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_modal_dialog (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent) |
Create a surface specification for a modal dialog surface. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_dialog (MirConnection *connection, int width, int height, MirPixelFormat format) |
Create a surface specification for a parentless dialog surface. More... | |
MirWaitHandle * | mir_surface_create (MirSurfaceSpec *requested_specification, mir_surface_callback callback, void *context) |
Create a surface from a given specification. More... | |
MirSurface * | mir_surface_create_sync (MirSurfaceSpec *requested_specification) |
Create a surface from a given specification and wait for the result. More... | |
bool | mir_surface_spec_set_name (MirSurfaceSpec *spec, char const *name) |
Set the requested name. More... | |
bool | mir_surface_spec_set_width (MirSurfaceSpec *spec, unsigned width) |
Set the requested width, in pixels. More... | |
bool | mir_surface_spec_set_height (MirSurfaceSpec *spec, unsigned height) |
Set the requested height, in pixels. More... | |
bool | mir_surface_spec_set_pixel_format (MirSurfaceSpec *spec, MirPixelFormat format) |
Set the requested pixel format. More... | |
bool | mir_surface_spec_set_buffer_usage (MirSurfaceSpec *spec, MirBufferUsage usage) |
Set the requested buffer usage. More... | |
bool | mir_surface_spec_set_fullscreen_on_output (MirSurfaceSpec *spec, uint32_t output_id) |
bool | mir_surface_spec_set_preferred_orientation (MirSurfaceSpec *spec, MirOrientationMode mode) |
Set the requested preferred orientation mode. More... | |
void | mir_surface_spec_release (MirSurfaceSpec *spec) |
Release the resources held by a MirSurfaceSpec. More... | |
MirWaitHandle * | mir_connection_create_surface (MirConnection *connection, MirSurfaceParameters const *surface_parameters, mir_surface_callback callback, void *context) |
Request a new Mir surface on the supplied connection with the supplied parameters. More... | |
MirSurface * | mir_connection_create_surface_sync (MirConnection *connection, MirSurfaceParameters const *params) |
Create a surface like in mir_connection_create_surface(), but also wait for creation to complete and return the resulting surface. More... | |
void | mir_surface_set_event_handler (MirSurface *surface, MirEventDelegate const *event_handler) |
Set the event handler to be called when events arrive for a surface. More... | |
MirEGLNativeWindowType | mir_surface_get_egl_native_window (MirSurface *surface) |
Get a window type that can be used for OpenGL ES 2.0 acceleration. More... | |
bool | mir_surface_is_valid (MirSurface *surface) |
Test for a valid surface. More... | |
char const * | mir_surface_get_error_message (MirSurface *surface) |
Retrieve a text description of the error. More... | |
void | mir_surface_get_parameters (MirSurface *surface, MirSurfaceParameters *parameters) |
Get a surface's parameters. More... | |
MirPlatformType | mir_surface_get_platform_type (MirSurface *surface) |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_surface_get_current_buffer() can be understood. More... | |
void | mir_surface_get_current_buffer (MirSurface *surface, MirNativeBuffer **buffer_package) |
Get a surface's buffer in "raw" representation. More... | |
void | mir_surface_get_graphics_region (MirSurface *surface, MirGraphicsRegion *graphics_region) |
Get a surface's graphics_region, i.e., map the graphics buffer to main memory. More... | |
MirWaitHandle * | mir_surface_swap_buffers (MirSurface *surface, mir_surface_callback callback, void *context) |
Advance a surface's buffer. More... | |
void | mir_surface_swap_buffers_sync (MirSurface *surface) |
Advance a surface's buffer as in mir_surface_swap_buffers(), but also wait for the operation to complete. More... | |
MirWaitHandle * | mir_surface_release (MirSurface *surface, mir_surface_callback callback, void *context) |
Release the supplied surface and any associated buffer. More... | |
void | mir_surface_release_sync (MirSurface *surface) |
Release the specified surface like in mir_surface_release(), but also wait for the operation to complete. More... | |
__attribute__ ((__deprecated__("Use mir_debug_surface_id()"))) int mir_surface_get_id(MirSurface *surface) | |
__attribute__ ((__deprecated__("Use mir_connection_create_spec_for_xxx()"))) MirWaitHandle *mir_surface_set_type(MirSurface *surface | |
MirSurfaceType | mir_surface_get_type (MirSurface *surface) |
Get the type (purpose) of a surface. More... | |
MirWaitHandle * | mir_surface_set_state (MirSurface *surface, MirSurfaceState state) |
Change the state of a surface. More... | |
MirSurfaceState | mir_surface_get_state (MirSurface *surface) |
Get the current state of a surface. More... | |
MirWaitHandle * | mir_surface_set_swapinterval (MirSurface *surface, int interval) |
Set the swapinterval for mir_surface_swap_buffers. More... | |
int | mir_surface_get_swapinterval (MirSurface *surface) |
Query the swapinterval that the surface is operating with. More... | |
int | mir_surface_get_dpi (MirSurface *surface) |
Query the DPI value of the surface (dots per inch). More... | |
MirSurfaceFocusState | mir_surface_get_focus (MirSurface *surface) |
Query the focus state for a surface. More... | |
MirSurfaceVisibility | mir_surface_get_visibility (MirSurface *surface) |
Query the visibility state for a surface. More... | |
MirWaitHandle * | mir_surface_configure_cursor (MirSurface *surface, MirCursorConfiguration const *parameters) |
Choose the cursor state for a surface: whether a cursor is shown, and which cursor if so. More... | |
MirOrientation | mir_surface_get_orientation (MirSurface *surface) |
Get the orientation of a surface. More... | |
MirWaitHandle * | mir_surface_set_preferred_orientation (MirSurface *surface, MirOrientationMode orientation) |
Request to set the preferred orientations of a surface. More... | |
MirOrientationMode | mir_surface_get_preferred_orientation (MirSurface *surface) |
Get the preferred orientation modes of a surface. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_input_method (MirConnection *connection, int width, int height, MirPixelFormat format) |
Create a surface specification for an input method surface. More... | |
void | mir_wait_for (MirWaitHandle *wait_handle) |
Wait on the supplied handle until all instances of the associated request have completed. More... | |
void | mir_wait_for_one (MirWaitHandle *wait_handle) |
Wait on the supplied handle until one instance of the associated request has completed. More... | |
MirEventType | mir_event_get_type (MirEvent const *ev) |
MirInputEvent const * | mir_event_get_input_event (MirEvent const *ev) |
MirSurfaceEvent const * | mir_event_get_surface_event (MirEvent const *ev) |
MirResizeEvent const * | mir_event_get_resize_event (MirEvent const *ev) |
MirPromptSessionEvent const * | mir_event_get_prompt_session_event (MirEvent const *ev) |
MirOrientationEvent const * | mir_event_get_orientation_event (MirEvent const *ev) |
MirCloseSurfaceEvent const * | mir_event_get_close_surface_event (MirEvent const *ev) |
MirEvent const * | mir_event_ref (MirEvent const *ev) __attribute__((warn_unused_result)) |
void | mir_event_unref (MirEvent const *ev) |
MirInputDeviceId | mir_input_event_get_device_id (MirInputEvent const *ev) |
int64_t | mir_input_event_get_event_time (MirInputEvent const *ev) |
MirInputEventType | mir_input_event_get_type (MirInputEvent const *ev) |
MirKeyInputEvent const * | mir_input_event_get_key_input_event (MirInputEvent const *ev) |
MirTouchInputEvent const * | mir_input_event_get_touch_input_event (MirInputEvent const *ev) |
MirPointerInputEvent const * | mir_input_event_get_pointer_input_event (MirInputEvent const *ev) |
MirKeyInputEventAction | mir_key_input_event_get_action (MirKeyInputEvent const *event) |
Retrieve the action which triggered a given key event. More... | |
xkb_keysym_t | mir_key_input_event_get_key_code (MirKeyInputEvent const *event) |
Retrieve the xkb mapped keycode associated with the key acted on. More... | |
int | mir_key_input_event_get_scan_code (MirKeyInputEvent const *event) |
Retrieve the raw hardware scan code associated with the key acted on. More... | |
MirInputEventModifiers | mir_key_input_event_get_modifiers (MirKeyInputEvent const *event) |
Retrieve the modifier keys pressed when the key action occured. More... | |
MirInputEventModifiers | mir_pointer_input_event_get_modifiers (MirPointerInputEvent const *event) |
Retrieve the modifier keys pressed when the pointer action occured. More... | |
MirPointerInputEventAction | mir_pointer_input_event_get_action (MirPointerInputEvent const *event) |
Retrieve the action which occured to generate a given pointer event. More... | |
bool | mir_pointer_input_event_get_button_state (MirPointerInputEvent const *event, MirPointerInputEventButton button) |
Retrieve the state of a given pointer button when the action occurred. More... | |
float | mir_pointer_input_event_get_axis_value (MirPointerInputEvent const *event, MirPointerInputEventAxis axis) |
Retrieve the axis value reported by a given pointer event. More... | |
MirInputEventModifiers | mir_touch_input_event_get_modifiers (MirTouchInputEvent const *event) |
Retrieve the modifier keys pressed when the touch action occured. More... | |
unsigned int | mir_touch_input_event_get_touch_count (MirTouchInputEvent const *event) |
Retrieve the number of touches reported for a given touch event. More... | |
MirTouchInputEventTouchId | mir_touch_input_event_get_touch_id (MirTouchInputEvent const *event, size_t touch_index) |
Retrieve the TouchID for a touch at given index. More... | |
MirTouchInputEventTouchAction | mir_touch_input_event_get_touch_action (MirTouchInputEvent const *event, size_t touch_index) |
Retrieve the action which occured for a touch at given index. More... | |
MirTouchInputEventTouchTooltype | mir_touch_input_event_get_touch_tooltype (MirTouchInputEvent const *event, size_t touch_index) |
Retrieve the tooltype for touch at given index. More... | |
float | mir_touch_input_event_get_touch_axis_value (MirTouchInputEvent const *event, size_t touch_index, MirTouchInputEventTouchAxis axis) |
Retrieve the axis value for a given axis on an indexed touch. More... | |
MirOrientation | mir_orientation_event_get_direction (MirOrientationEvent const *ev) |
MirPromptSessionState | mir_prompt_session_event_get_state (MirPromptSessionEvent const *ev) |
int | mir_resize_event_get_width (MirResizeEvent const *ev) |
int | mir_resize_event_get_height (MirResizeEvent const *ev) |
MirSurfaceAttrib | mir_surface_event_get_attribute (MirSurfaceEvent const *ev) |
int | mir_surface_event_get_attribute_value (MirSurfaceEvent const *ev) |
Variables | |
MirDisplayInfo * | display_info |
MirSurfaceType | type |
char const *const | mir_default_cursor_name |
A special cursor name for use with mir_cursor_configuration_from_name representing the system default cursor. More... | |
char const *const | mir_disabled_cursor_name |
A special cursor name for use with mir_cursor_configuration_from_name representing a disabled cursor image. More... | |
char const *const | mir_arrow_cursor_name |
The standard arrow cursor (typically the system default) More... | |
char const *const | mir_busy_cursor_name |
The "wait" cursor, typically an hourglass or watch used during operations which prevent the user from interacting. More... | |
char const *const | mir_caret_cursor_name |
The caret or ibeam cursor, indicating acceptance of text input. More... | |
char const *const | mir_pointing_hand_cursor_name |
The pointing hand cursor, typically used for clickable elements such as hyperlinks. More... | |
char const *const | mir_open_hand_cursor_name |
The open handed cursor, typically used to indicate that the area beneath the cursor may be clicked and dragged around. More... | |
char const *const | mir_closed_hand_cursor_name |
The close handed cursor, typically used to indicate that a drag operation is in process which involves scrolling. More... | |
char const *const | mir_horizontal_resize_cursor_name |
The cursor used to indicate a horizontal resize operation. More... | |
char const *const | mir_vertical_resize_cursor_name |
The cursor used to indicate a vertical resize operation. More... | |
char const *const | mir_diagonal_resize_bottom_to_top_cursor_name |
The cursor used to indicate diagonal resize from top-right and bottom-left corners. More... | |
char const *const | mir_diagonal_resize_top_to_bottom_cursor_name |
The cursor used to indicate diagonal resize from bottom-left and top-right corners. More... | |
char const *const | mir_omnidirectional_resize_cursor_name |
The cursor used to indicate resize with no directional constraint. More... | |
char const *const | mir_vsplit_resize_cursor_name |
The cursor used for vertical splitters, indicating that a handle may be dragged to adjust vertical space. More... | |
char const *const | mir_hsplit_resize_cursor_name |
The cursor used for horizontal splitters, indicating that a handle may be dragged to adjust horizontal space. More... | |
#define MIR_BYTES_PER_PIXEL | ( | f | ) | (((f) == mir_pixel_format_bgr_888) ? 3 : 4) |
#define MIR_CLIENT_MAJOR_VERSION (1) |
MIR_CLIENT_MAJOR_VERSION.
The major client API version. This will increase once per API incompatible release.
See also: http://semver.org/
#define MIR_CLIENT_MICRO_VERSION (0) |
MIR_CLIENT_MICRO_VERSION.
The micro client API version. This will increment each release. This is usually uninteresting for client code, but may be of use in selecting whether to use a feature that has previously been buggy.
This corresponds to the PATCH field of http://semver.org/
#define MIR_CLIENT_MINOR_VERSION (0) |
MIR_CLIENT_MINOR_VERSION.
The minor client API version. This will increase each time new backwards-compatible API is added, and will reset to 0 each time MIR_CLIENT_MAJOR_VERSION is incremented.
See also: http://semver.org/
#define MIR_CLIENT_VERSION |
MIR_CLIENT_VERSION.
The current version of the Mir client headers in use.
#define MIR_INPUT_EVENT_MAX_POINTER_COUNT 16 |
typedef void(* mir_client_fd_callback) (MirPromptSession *prompt_session, size_t count, int const *fds, void *context) |
Callback called when a request for client file descriptors completes.
[in] | prompt_session | The prompt session |
[in] | count | The number of FDs allocated |
[in] | fds | Array of FDs |
[in,out] | context | The context provided by client |
typedef void(* mir_connected_callback) (MirConnection *connection, void *client_context) |
Callback to be passed when issuing a mir_connect request.
[in] | connection | the new connection |
[in,out] | client_context | context provided by client in calling mir_connect |
typedef void(* mir_display_config_callback) (MirConnection *connection, void *context) |
Callback called when a display config change has occurred.
[in] | connection | The connection associated with the display change |
[in,out] | context | The context provided by client |
typedef void(* mir_drm_auth_magic_callback) (int status, void *context) |
typedef void(* mir_event_delegate_callback) (MirSurface *surface, MirEvent const *event, void *context) |
Callback member of MirEventDelegate for handling of events.
[in] | surface | The surface on which an event has occurred |
[in] | event | The event to be handled |
[in,out] | context | The context provided by client during delegate registration. |
typedef void(* mir_lifecycle_event_callback) (MirConnection *connection, MirLifecycleState state, void *context) |
Callback called when a lifecycle event/callback is requested from the running server.
[in] | connection | The connection associated with the lifecycle event |
[in] | cb | The callback requested |
[in,out] | context | The context provided by the client |
typedef void(* mir_platform_operation_callback) (MirConnection *connection, MirPlatformMessage *reply, void *context) |
Callback called when a platform operation completes.
[in] | connection | The connection associated with the platform operation |
[in] | reply | The platform operation reply |
[in,out] | context | The context provided by the client |
typedef void(* mir_prompt_session_callback) (MirPromptSession *prompt_provider, void *context) |
Callback member of MirPromptSession for handling of prompt sessions.
[in] | prompt_provider | The prompt session associated with the callback |
[in,out] | context | The context provided by the client |
typedef void(* mir_prompt_session_state_change_callback) (MirPromptSession *prompt_provider, MirPromptSessionState state, void *context) |
Callback member of MirPromptSession for handling of prompt sessions events.
[in] | prompt_provider | The prompt session associated with the callback |
[in] | state | The state of the prompt session |
[in,out] | context | The context provided by the client |
typedef void(* mir_screencast_callback) (MirScreencast *screencast, void *client_context) |
Callback to be passed when calling MirScreencast functions.
[in] | screencast | the screencast being updated |
[in,out] | client_context | context provided by the client |
typedef void(* mir_surface_callback) (MirSurface *surface, void *client_context) |
Callback to be passed when calling:
[in] | surface | the surface being updated |
[in,out] | client_context | context provided by client in calling mir_connect |
typedef enum MirBufferUsage MirBufferUsage |
MirBufferUsage specifies how a surface can and will be used.
A "hardware" surface can be used for OpenGL accelerated rendering. A "software" surface is one that can be addressed in main memory and blitted to directly.
typedef struct MirCloseSurfaceEvent MirCloseSurfaceEvent |
typedef struct MirConnection MirConnection |
typedef struct MirDisplayCard MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment.
typedef struct MirDisplayConfiguration MirDisplayConfiguration |
typedef struct MirDisplayInfo MirDisplayInfo |
typedef struct MirDisplayMode MirDisplayMode |
typedef struct MirDisplayOutput MirDisplayOutput |
typedef enum MirDisplayOutputType MirDisplayOutputType |
typedef enum MirEdgeAttachment MirEdgeAttachment |
typedef void* MirEGLNativeDisplayType |
typedef void* MirEGLNativeWindowType |
typedef struct MirEventDelegate MirEventDelegate |
MirEventDelegate may be used to specify (at surface creation time) callbacks for handling of events.
typedef struct MirGraphicsRegion MirGraphicsRegion |
Retrieved information about a MirSurface.
This is most useful for learning how and where to write to a 'mir_buffer_usage_software' surface.
typedef int64_t MirInputDeviceId |
typedef struct MirInputEvent MirInputEvent |
typedef unsigned int MirInputEventModifiers |
typedef struct MirKeyInputEvent MirKeyInputEvent |
An event type describing a change in keyboard state.
typedef enum MirLifecycleState MirLifecycleState |
typedef struct MirMesaEGLNativeDisplay MirMesaEGLNativeDisplay |
typedef int(* MirMesaEGLNativeDisplayIsValidFunc) (MirMesaEGLNativeDisplay *display) |
typedef struct MirMesaEGLNativeSurface MirMesaEGLNativeSurface |
typedef enum MirOrientation MirOrientation |
Direction relative to the "natural" orientation of the display.
typedef struct MirOrientationEvent MirOrientationEvent |
typedef enum MirOrientationMode MirOrientationMode |
typedef enum MirPixelFormat MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format.
For example, abgr_8888 corresponds to 0xAABBGGRR, which will end up as R,G,B,A in memory in a little endian system, and as A,B,G,R in memory in a big endian system.
typedef struct MirPlatformMessage MirPlatformMessage |
typedef struct MirPlatformPackage MirPlatformPackage |
typedef enum MirPlatformType MirPlatformType |
The native buffer type for the system the client is connected on.
typedef struct MirPointerInputEvent MirPointerInputEvent |
An event type describing a change in pointer device state.
typedef enum MirPowerMode MirPowerMode |
typedef struct MirPromptSession MirPromptSession |
typedef struct MirPromptSessionEvent MirPromptSessionEvent |
typedef enum MirPromptSessionState MirPromptSessionState |
typedef struct MirRectangle MirRectangle |
typedef struct MirResizeEvent MirResizeEvent |
typedef struct MirScreencast MirScreencast |
typedef struct MirScreencastParameters MirScreencastParameters |
MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast.
The width and height parameters can be used to down-scale the screencast For no scaling set them to the region width and height.
typedef struct MirSurface MirSurface |
typedef enum MirSurfaceAttrib MirSurfaceAttrib |
Attributes of a surface that the client and server/shell may wish to get or set over the wire.
typedef struct MirSurfaceEvent MirSurfaceEvent |
typedef enum MirSurfaceFocusState MirSurfaceFocusState |
typedef struct MirSurfaceParameters MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface.
typedef struct MirSurfaceSpec MirSurfaceSpec |
typedef enum MirSurfaceState MirSurfaceState |
typedef enum MirSurfaceType MirSurfaceType |
typedef enum MirSurfaceVisibility MirSurfaceVisibility |
typedef struct MirTouchInputEvent MirTouchInputEvent |
An event type describing a change in touch device state.
typedef int32_t MirTouchInputEventTouchId |
An identifier for a touch-point.
TouchId's are unique per-gesture. That is to say, once a touch has gone down at time T, no other touch will use that touch's ID until all touches at time T have come up.
typedef struct MirWaitHandle MirWaitHandle |
Returned by asynchronous functions.
Must not be free'd by callers. See the individual function documentation for information on the lifetime of wait handles.
typedef int64_t nsecs_t |
anonymous enum |
enum MirBool |
enum MirBufferUsage |
enum MirDisplayOutputType |
enum MirEdgeAttachment |
enum MirEventType |
Description of key modifier state.
enum MirInputEventType |
enum MirKeyAction |
enum MirKeyFlag |
enum MirKeyModifier |
enum MirLifecycleState |
enum MirMotionAction |
enum MirMotionButton |
enum MirMotionFlag |
enum MirMotionToolType |
enum MirOrientation |
enum MirOrientationMode |
enum MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format.
For example, abgr_8888 corresponds to 0xAABBGGRR, which will end up as R,G,B,A in memory in a little endian system, and as A,B,G,R in memory in a big endian system.
Enumerator | |
---|---|
mir_pixel_format_invalid | |
mir_pixel_format_abgr_8888 | |
mir_pixel_format_xbgr_8888 | |
mir_pixel_format_argb_8888 | |
mir_pixel_format_xrgb_8888 | |
mir_pixel_format_bgr_888 | |
mir_pixel_formats |
enum MirPlatformType |
enum MirPowerMode |
enum MirSurfaceAttrib |
Attributes of a surface that the client and server/shell may wish to get or set over the wire.
enum MirSurfaceFocusState |
enum MirSurfaceState |
enum MirSurfaceType |
Enumerator | |
---|---|
mir_surface_type_normal |
AKA "regular". |
mir_surface_type_utility |
AKA "floating". |
mir_surface_type_dialog | |
mir_surface_type_overlay |
|
mir_surface_type_gloss | |
mir_surface_type_freestyle | |
mir_surface_type_popover |
|
mir_surface_type_menu | |
mir_surface_type_inputmethod |
AKA "OSK" or handwriting etc. |
mir_surface_type_satellite |
AKA "toolbox"/"toolbar". |
mir_surface_type_tip |
AKA "tooltip". |
mir_surface_types |
enum MirSurfaceVisibility |
__attribute__ | ( | (__deprecated__("Use mir_connection_create_display_config()")) | ) |
__attribute__ | ( | (__deprecated__("Use mir_debug_surface_id()")) | ) |
__attribute__ | ( | (__deprecated__("Use mir_connection_create_spec_for_xxx()")) | ) |
MirWaitHandle* mir_connect | ( | char const * | server, |
char const * | app_name, | ||
mir_connected_callback | callback, | ||
void * | context | ||
) |
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.
[in] | server | File path of the server socket to connect to, or NULL to choose the default server (can be set by the $MIR_SOCKET environment variable) |
[in] | app_name | A name referring to the application |
[in] | callback | Callback function to be invoked when request completes |
[in,out] | context | User data passed to the callback function |
MirConnection* mir_connect_sync | ( | char const * | server, |
char const * | app_name | ||
) |
Perform a mir_connect() but also wait for and return the result.
[in] | server | File path of the server socket to connect to, or NULL to choose the default server |
[in] | app_name | A name referring to the application |
MirWaitHandle* mir_connection_apply_display_config | ( | MirConnection * | connection, |
MirDisplayConfiguration * | display_configuration | ||
) |
Apply the display configuration.
The display configuration is applied to this connection only (per-connection configuration) and is invalidated when a hardware change occurs. Clients should register a callback with mir_connection_set_display_config_change_callback() to get notified about hardware changes, so that the can apply a new configuration.
[in] | connection | The connection |
[in] | display_configuration | The display_configuration to apply |
MirDisplayConfiguration* mir_connection_create_display_config | ( | MirConnection * | connection | ) |
Query the display.
[in] | connection | The connection |
MirPromptSession* mir_connection_create_prompt_session_sync | ( | MirConnection * | connection, |
pid_t | application_pid, | ||
mir_prompt_session_state_change_callback | state_change_callback, | ||
void * | context | ||
) |
Create and start a new prompt session.
[in] | connection | The connection |
[in] | application_pid | The process id of the initiating application |
[in] | state_change_callback | The function to be called when a prompt session state change occurs |
[in,out] | context | User data passed to the callback functions |
MirScreencast* mir_connection_create_screencast_sync | ( | MirConnection * | connection, |
MirScreencastParameters * | parameters | ||
) |
Create a screencast on the supplied connection.
A screencast allows clients to read the contents of the screen.
[in] | connection | The connection |
[in] | parameters | The screencast parameters |
MirSurfaceSpec* mir_connection_create_spec_for_dialog | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
Create a surface specification for a parentless dialog surface.
A parentless dialog surface is similar to a normal surface, but it cannot be fullscreen and typically won't have any maximize/close button decorations.
A parentless dialog is not allowed to have other dialog children. The server may decide to close the parent and show the child dialog only.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
MirSurfaceSpec* mir_connection_create_spec_for_input_method | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
Create a surface specification for an input method surface.
Currently this is only appropriate for the Unity On-Screen-Keyboard.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
MirSurfaceSpec* mir_connection_create_spec_for_menu | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent, | ||
MirRectangle * | rect, | ||
MirEdgeAttachment | edge | ||
) |
Create a surface specification for a menu surface.
Positioning of the surface is specified with respect to the parent surface via an adjacency rectangle. The server will attempt to choose an edge of the adjacency rectangle on which to place the surface taking in to account screen-edge proximity or similar constraints. In addition, the server can use the edge affinity hint to consider only horizontal or only vertical adjacency edges in the given rectangle.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
[in] | parent | A valid parent surface for this menu. |
[in] | rect | The adjacency rectangle. The server is not guaranteed to create a surface at the requested location. |
[in] | edge | The preferred edge direction to attach to. Use mir_edge_attachment_any for no preference. |
MirSurfaceSpec* mir_connection_create_spec_for_modal_dialog | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent | ||
) |
Create a surface specification for a modal dialog surface.
The dialog surface will have input focus; the parent can still be moved, resized or hidden/minimized but no interaction is possible until the dialog is dismissed.
A dialog will typically have no close/maximize button decorations.
During surface creation, if the specified parent is another dialog surface the server may choose to close the specified parent in order to show this new dialog surface.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
[in] | parent | A valid parent surface. |
MirSurfaceSpec* mir_connection_create_spec_for_normal_surface | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
Create a surface specification for a normal surface.
A normal surface is suitable for most application windows. It has no special semantics. On a desktop shell it will typically have a title-bar, be movable, resizeable, etc.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
MirSurfaceSpec* mir_connection_create_spec_for_tooltip | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent, | ||
MirRectangle * | zone | ||
) |
Create a surface specification for a tooltip surface.
A tooltip surface becomes visible when the pointer hovers the specified target zone. A tooltip surface has no input focus and will be closed when the pointer moves out of the target zone or the parent closes, moves or hides
The tooltip parent cannot be another tooltip surface.
The tooltip position is decided by the server but typically it will appear near the pointer.
[in] | connection | Connection the surface will be created on |
[in] | width | Requested width. The server is not guaranteed to return a surface of this width. |
[in] | height | Requested height. The server is not guaranteed to return a surface of this height. |
[in] | format | Pixel format for the surface. |
[in] | parent | A valid parent surface for this tooltip. |
[in] | rect | A target zone relative to parent. |
MirWaitHandle* mir_connection_create_surface | ( | MirConnection * | connection, |
MirSurfaceParameters const * | surface_parameters, | ||
mir_surface_callback | callback, | ||
void * | context | ||
) |
Request a new Mir surface on the supplied connection with the supplied parameters.
The returned handle remains valid until the surface has been released.
[in] | connection | The connection |
[in] | surface_parameters | Request surface parameters |
[in] | callback | Callback function to be invoked when request completes |
[in,out] | context | User data passed to the callback function |
MirSurface* mir_connection_create_surface_sync | ( | MirConnection * | connection, |
MirSurfaceParameters const * | params | ||
) |
Create a surface like in mir_connection_create_surface(), but also wait for creation to complete and return the resulting surface.
[in] | connection | The connection |
[in] | params | Parameters describing the desired surface |
MirWaitHandle* mir_connection_drm_auth_magic | ( | MirConnection * | connection, |
unsigned int | magic, | ||
mir_drm_auth_magic_callback | callback, | ||
void * | context | ||
) |
int mir_connection_drm_set_gbm_device | ( | MirConnection * | connection, |
struct gbm_device * | dev | ||
) |
Set the gbm_device to be used by the EGL implementation.
This is required if the application needs to create EGLImages from gbm buffers objects created on that gbm device.
[in] | connection | The connection |
[in] | dev | The gbm_device to set |
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.
[in] | connection | The connection |
[out] | formats | List of valid formats to create surfaces with |
[in] | formats_size | size of formats list |
[out] | num_valid_formats | number of valid formats returned in formats |
MirEGLNativeDisplayType mir_connection_get_egl_native_display | ( | MirConnection * | connection | ) |
Get a display type that can be used for OpenGL ES 2.0 acceleration.
[in] | connection | The connection |
char const* mir_connection_get_error_message | ( | 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.
[in] | connection | The connection |
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.
[in] | connection | The connection |
[out] | platform_package | Structure to be populated |
bool mir_connection_is_valid | ( | MirConnection * | connection | ) |
Test for a valid connection.
[in] | connection | The connection |
MirWaitHandle* mir_connection_platform_operation | ( | MirConnection * | connection, |
MirPlatformMessage const * | request, | ||
mir_platform_operation_callback | callback, | ||
void * | context | ||
) |
Perform a platform specific operation.
The MirPlatformMessage used for the request needs to remain valid until this operation finishes.
[in] | connection | The connection |
[in] | request | The message used for this operation |
[in] | callback | The callback to call when the operation finishes |
[in,out] | context | User data passed to the callback function |
void mir_connection_release | ( | MirConnection * | connection | ) |
Release a connection to the Mir server.
[in] | connection | The 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.
Once a change has occurred, you can use mir_connection_create_display_config to see the new configuration.
[in] | connection | The connection |
[in] | callback | The function to be called when a display change occurs |
[in,out] | context | User data passed to the callback function |
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.
[in] | connection | The connection |
[in] | callback | The function to be called when the state change occurs |
[in,out] | context | User data passed to the callback function |
void mir_cursor_configuration_destroy | ( | MirCursorConfiguration * | parameters | ) |
Release resources assosciated with cursor parameters.
[in] | parameters | The operand |
MirCursorConfiguration* mir_cursor_configuration_from_name | ( | char const * | name | ) |
Returns a new MirCursorConfiguration representing a named cursor from the system cursor theme.
Symbolic cursor names, such as mir_default_cursor_name and mir_caret_cursor_name are available see (mir_toolkit/cursors.h). as input.
[in] | name | The cursor name |
void mir_display_config_destroy | ( | MirDisplayConfiguration * | display_configuration | ) |
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config.
[in] | display_configuration | The display_configuration information resource to be destroyed |
MirCloseSurfaceEvent const* mir_event_get_close_surface_event | ( | MirEvent const * | ev | ) |
MirInputEvent const* mir_event_get_input_event | ( | MirEvent const * | ev | ) |
MirOrientationEvent const* mir_event_get_orientation_event | ( | MirEvent const * | ev | ) |
MirPromptSessionEvent const* mir_event_get_prompt_session_event | ( | MirEvent const * | ev | ) |
MirResizeEvent const* mir_event_get_resize_event | ( | MirEvent const * | ev | ) |
MirSurfaceEvent const* mir_event_get_surface_event | ( | MirEvent const * | ev | ) |
MirEventType mir_event_get_type | ( | MirEvent const * | ev | ) |
void mir_event_unref | ( | MirEvent const * | ev | ) |
MirInputDeviceId mir_input_event_get_device_id | ( | MirInputEvent const * | ev | ) |
int64_t mir_input_event_get_event_time | ( | MirInputEvent const * | ev | ) |
MirKeyInputEvent const* mir_input_event_get_key_input_event | ( | MirInputEvent const * | ev | ) |
MirPointerInputEvent const* mir_input_event_get_pointer_input_event | ( | MirInputEvent const * | ev | ) |
MirTouchInputEvent const* mir_input_event_get_touch_input_event | ( | MirInputEvent const * | ev | ) |
MirInputEventType mir_input_event_get_type | ( | MirInputEvent const * | ev | ) |
MirKeyInputEventAction mir_key_input_event_get_action | ( | MirKeyInputEvent const * | event | ) |
Retrieve the action which triggered a given key event.
[in] | event | The key event |
xkb_keysym_t mir_key_input_event_get_key_code | ( | MirKeyInputEvent const * | event | ) |
Retrieve the xkb mapped keycode associated with the key acted on.
. May be interpreted as per <xkbcommon/xkb-keysyms.h>
[in] | event | The key event |
MirInputEventModifiers mir_key_input_event_get_modifiers | ( | MirKeyInputEvent const * | event | ) |
Retrieve the modifier keys pressed when the key action occured.
[in] | event | The key event |
int mir_key_input_event_get_scan_code | ( | MirKeyInputEvent const * | event | ) |
Retrieve the raw hardware scan code associated with the key acted on.
May be interpreted as per <linux/input.h>
[in] | event | The key event |
MirOrientation mir_orientation_event_get_direction | ( | MirOrientationEvent const * | ev | ) |
MirPlatformMessage* mir_platform_message_create | ( | unsigned int | opcode | ) |
Create a platform message to use with mir_connection_platform_operation().
Each call to mir_platform_message_create() should be matched by a call to mir_platform_message_release() to avoid memory leaks.
[in] | opcode | The platform message opcode |
MirPlatformMessageData mir_platform_message_get_data | ( | MirPlatformMessage const * | message | ) |
Get the data associated with a message.
The memory holding the returned data array is owned by the message and is valid only as long as the message is valid and mir_platform_set_data() is not called. You must not change or free the returned data array.
[in] | message | The MirPlatformMessage |
MirPlatformMessageFds mir_platform_message_get_fds | ( | MirPlatformMessage const * | message | ) |
Gets the fds associated with a message.
The memory of the returned fd array is owned by the message and is valid only as long as the message is valid and mir_platform_set_fds() is not called. You must not change or free the returned fd array.
Note that the fds associated with a message will not be closed when the message is released. Users are responsible for getting and closing the fds to avoid leaks.
[in] | message | The MirPlatformMessage |
unsigned int mir_platform_message_get_opcode | ( | MirPlatformMessage const * | message | ) |
Get the opcode of a message.
[in] | message | The MirPlatformMessage |
void mir_platform_message_release | ( | MirPlatformMessage const * | message | ) |
Release a platform message.
[in] | message | The MirPlatformMessage |
void mir_platform_message_set_data | ( | MirPlatformMessage * | message, |
void const * | data, | ||
size_t | data_size | ||
) |
Set the data associated with a message.
The data is copied into the message.
[in] | message | The MirPlatformMessage |
[in] | data | Pointer to the data |
[in] | data_size | The size of the data in bytes |
void mir_platform_message_set_fds | ( | MirPlatformMessage * | message, |
int const * | fds, | ||
size_t | num_fds | ||
) |
Sets the fds associated with a message.
The fd array is copied into the message, but the message does not take ownership of the fds, i.e., the caller is responsible for keeping the fds open for as long as this message needs to remain valid.
Note that the fds associated with a message are not closed when the message is released. The caller is responsible for closing the fds when the message doesn't need them anymore (see also mir_platform_message_get_fds()).
[in] | message | The MirPlatformMessage |
[in] | fds | Pointer to the array of fds |
[in] | num_fds | The number of fds |
MirPointerInputEventAction mir_pointer_input_event_get_action | ( | MirPointerInputEvent const * | event | ) |
Retrieve the action which occured to generate a given pointer event.
[in] | event | The pointer event |
float mir_pointer_input_event_get_axis_value | ( | MirPointerInputEvent const * | event, |
MirPointerInputEventAxis | axis | ||
) |
Retrieve the axis value reported by a given pointer event.
[in] | event | The pointer event |
[in] | axis | The axis to retreive a value from |
bool mir_pointer_input_event_get_button_state | ( | MirPointerInputEvent const * | event, |
MirPointerInputEventButton | button | ||
) |
Retrieve the state of a given pointer button when the action occurred.
[in] | event | The pointer event |
[in] | button | The button to check |
MirInputEventModifiers mir_pointer_input_event_get_modifiers | ( | MirPointerInputEvent const * | event | ) |
Retrieve the modifier keys pressed when the pointer action occured.
[in] | event | The pointer event |
char const* mir_prompt_session_error_message | ( | MirPromptSession * | prompt_session | ) |
Retrieve a text description of the last error.
The returned string is owned by the library and remains valid until the prompt session has been released.
[in] | prompt_session | The prompt session |
MirPromptSessionState mir_prompt_session_event_get_state | ( | MirPromptSessionEvent const * | ev | ) |
bool mir_prompt_session_is_valid | ( | MirPromptSession * | prompt_session | ) |
Test for a valid prompt session.
[in] | prompt_session | The prompt session |
MirWaitHandle* mir_prompt_session_new_fds_for_prompt_providers | ( | MirPromptSession * | prompt_session, |
unsigned int | no_of_fds, | ||
mir_client_fd_callback | callback, | ||
void * | context | ||
) |
Allocate some FDs for prompt providers to connect on.
Prompt helpers need to allocate connection FDs it will pass to prompt providers to use when connecting to the server. The server can then associate them with the prompt session.
[in] | prompt_session | The prompt session |
[in] | no_of_fds | The number of fds to allocate |
[in] | callback | Callback invoked when request completes |
[in,out] | context | User data passed to the callback function |
void mir_prompt_session_release_sync | ( | MirPromptSession * | prompt_session | ) |
Stop and release the specified prompt session.
[in] | prompt_session | The prompt session |
int mir_resize_event_get_height | ( | MirResizeEvent const * | ev | ) |
int mir_resize_event_get_width | ( | MirResizeEvent const * | ev | ) |
MirEGLNativeWindowType mir_screencast_egl_native_window | ( | MirScreencast * | screencast | ) |
Get a window type that can be used by EGL.
[in] | screencast | The screencast |
void mir_screencast_release_sync | ( | MirScreencast * | screencast | ) |
Release the specified screencast.
[in] | screencast | The screencast to be released |
MirWaitHandle* mir_surface_configure_cursor | ( | MirSurface * | surface, |
MirCursorConfiguration const * | parameters | ||
) |
Choose the cursor state for a surface: whether a cursor is shown, and which cursor if so.
[in] | surface | The surface to operate on |
[in] | parameters | The configuration parameters obtained from mir_cursor* family of functions. |
MirWaitHandle* mir_surface_create | ( | MirSurfaceSpec * | requested_specification, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
Create a surface from a given specification.
[in] | requested_specification | Specification of the attributes for the created surface |
[in] | callback | Callback function to be invoked when creation is complete |
[in,out] | context | User data passed to callback function. This callback is guaranteed to be called, and called with a non-null MirSurface*, but the surface may be invalid in case of an error. |
MirSurface* mir_surface_create_sync | ( | MirSurfaceSpec * | requested_specification | ) |
Create a surface from a given specification and wait for the result.
[in] | requested_specification | Specification of the attributes for the created surface |
MirSurfaceAttrib mir_surface_event_get_attribute | ( | MirSurfaceEvent const * | ev | ) |
int mir_surface_event_get_attribute_value | ( | MirSurfaceEvent const * | ev | ) |
void mir_surface_get_current_buffer | ( | MirSurface * | surface, |
MirNativeBuffer ** | buffer_package | ||
) |
Get a surface's buffer in "raw" representation.
[in] | surface | The surface |
[out] | buffer_package | Structure to be populated |
int mir_surface_get_dpi | ( | MirSurface * | surface | ) |
Query the DPI value of the surface (dots per inch).
This will vary depending on the physical display configuration and where the surface is within it.
MirEGLNativeWindowType mir_surface_get_egl_native_window | ( | MirSurface * | surface | ) |
Get a window type that can be used for OpenGL ES 2.0 acceleration.
[in] | surface | The surface |
char const* mir_surface_get_error_message | ( | 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.
[in] | surface | The surface |
MirSurfaceFocusState mir_surface_get_focus | ( | MirSurface * | surface | ) |
Query the focus state for a surface.
[in] | surface | The surface to operate on |
void mir_surface_get_graphics_region | ( | MirSurface * | surface, |
MirGraphicsRegion * | graphics_region | ||
) |
Get a surface's graphics_region, i.e., map the graphics buffer to main memory.
[in] | surface | The surface |
[out] | graphics_region | Structure to be populated |
MirOrientation mir_surface_get_orientation | ( | MirSurface * | surface | ) |
Get the orientation of a surface.
[in] | surface | The surface to query |
void mir_surface_get_parameters | ( | MirSurface * | surface, |
MirSurfaceParameters * | parameters | ||
) |
Get a surface's parameters.
[in] | surface | The surface |
[out] | parameters | Structure to be populated |
MirPlatformType mir_surface_get_platform_type | ( | MirSurface * | surface | ) |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_surface_get_current_buffer() can be understood.
[in] | surface | The surface |
MirOrientationMode mir_surface_get_preferred_orientation | ( | MirSurface * | surface | ) |
Get the preferred orientation modes of a surface.
[in] | surface | The surface to query |
MirSurfaceState mir_surface_get_state | ( | MirSurface * | surface | ) |
Get the current state of a surface.
[in] | surface | The surface to query |
int mir_surface_get_swapinterval | ( | MirSurface * | surface | ) |
Query the swapinterval that the surface is operating with.
The default interval is 1.
[in] | surface | The surface to operate on |
MirSurfaceType mir_surface_get_type | ( | MirSurface * | surface | ) |
Get the type (purpose) of a surface.
[in] | surface | The surface to query |
MirSurfaceVisibility mir_surface_get_visibility | ( | MirSurface * | surface | ) |
Query the visibility state for a surface.
[in] | surface | The surface to operate on |
bool mir_surface_is_valid | ( | MirSurface * | surface | ) |
Test for a valid surface.
[in] | surface | The surface |
MirWaitHandle* mir_surface_release | ( | MirSurface * | surface, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
Release the supplied surface and any associated buffer.
The returned wait handle remains valid until the connection to the server is released.
[in] | surface | The surface |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_surface_release_sync | ( | MirSurface * | surface | ) |
Release the specified surface like in mir_surface_release(), but also wait for the operation to complete.
[in] | surface | The surface to be released |
void mir_surface_set_event_handler | ( | MirSurface * | surface, |
MirEventDelegate const * | event_handler | ||
) |
Set the event handler to be called when events arrive for a surface.
[in] | surface | The surface |
[in] | event_handler | The event handler to call |
MirWaitHandle* mir_surface_set_preferred_orientation | ( | MirSurface * | surface, |
MirOrientationMode | orientation | ||
) |
Request to set the preferred orientations of a surface.
The request may be rejected by the server; to check wait on the result and check the applied value using mir_surface_get_preferred_orientation
[in] | surface | The surface to operate on |
[in] | orientation | The preferred orientation modes |
MirWaitHandle* mir_surface_set_state | ( | MirSurface * | surface, |
MirSurfaceState | state | ||
) |
Change the state of a surface.
[in] | surface | The surface to operate on |
[in] | state | The new state of the surface |
MirWaitHandle* mir_surface_set_swapinterval | ( | MirSurface * | surface, |
int | interval | ||
) |
Set the swapinterval for mir_surface_swap_buffers.
EGL users should use eglSwapInterval directly. At the time being, only swapinterval of 0 or 1 is supported.
[in] | surface | The surface to operate on |
[in] | interval | The number of vblank signals that mir_surface_swap_buffers will wait for |
void mir_surface_spec_release | ( | MirSurfaceSpec * | spec | ) |
Release the resources held by a MirSurfaceSpec.
[in] | spec | Specification to release |
bool mir_surface_spec_set_buffer_usage | ( | MirSurfaceSpec * | spec, |
MirBufferUsage | usage | ||
) |
Set the requested buffer usage.
[in] | spec | Specification to mutate |
[in] | usage | Requested buffer usage |
bool mir_surface_spec_set_fullscreen_on_output | ( | MirSurfaceSpec * | spec, |
uint32_t | output_id | ||
) |
[in] | spec | Specification to mutate |
[in] | output_id | ID of output to place surface on. From MirDisplayOutput.output_id |
bool mir_surface_spec_set_height | ( | MirSurfaceSpec * | spec, |
unsigned | height | ||
) |
Set the requested height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Requested height. |
bool mir_surface_spec_set_name | ( | MirSurfaceSpec * | spec, |
char const * | name | ||
) |
Set the requested name.
The surface name helps the user to distinguish between multiple surfaces from the same application. A typical desktop shell may use it to provide text in the window titlebar, in an alt-tab switcher, or equivalent.
[in] | spec | Specification to mutate |
[in] | name | Requested name. This must be valid UTF-8. Copied into spec; clients can free the buffer passed after this call. |
bool mir_surface_spec_set_pixel_format | ( | MirSurfaceSpec * | spec, |
MirPixelFormat | format | ||
) |
Set the requested pixel format.
[in] | spec | Specification to mutate |
[in] | format | Requested pixel format |
bool mir_surface_spec_set_preferred_orientation | ( | MirSurfaceSpec * | spec, |
MirOrientationMode | mode | ||
) |
Set the requested preferred orientation mode.
[in] | spec | Specification to mutate |
[in] | mode | Requested preferred orientation |
bool mir_surface_spec_set_width | ( | MirSurfaceSpec * | spec, |
unsigned | width | ||
) |
Set the requested width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Requested width. |
MirWaitHandle* mir_surface_swap_buffers | ( | MirSurface * | surface, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
Advance a surface's buffer.
The returned handle remains valid until the next call to mir_surface_swap_buffers, until the surface has been released or the connection to the server has been released.
[in] | surface | The surface |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_surface_swap_buffers_sync | ( | MirSurface * | surface | ) |
Advance a surface's buffer as in mir_surface_swap_buffers(), but also wait for the operation to complete.
[in] | surface | The surface whose buffer to advance |
MirInputEventModifiers mir_touch_input_event_get_modifiers | ( | MirTouchInputEvent const * | event | ) |
Retrieve the modifier keys pressed when the touch action occured.
[in] | event | The key event |
MirTouchInputEventTouchAction mir_touch_input_event_get_touch_action | ( | MirTouchInputEvent const * | event, |
size_t | touch_index | ||
) |
Retrieve the action which occured for a touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
float mir_touch_input_event_get_touch_axis_value | ( | MirTouchInputEvent const * | event, |
size_t | touch_index, | ||
MirTouchInputEventTouchAxis | axis | ||
) |
Retrieve the axis value for a given axis on an indexed touch.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
[in] | axis | The axis to retreive a value from |
unsigned int mir_touch_input_event_get_touch_count | ( | MirTouchInputEvent const * | event | ) |
Retrieve the number of touches reported for a given touch event.
Each touch is said to be index in the event and may be accessed by index 0, 1, ... , (touch_count - 1)
[in] | event | The touch event |
MirTouchInputEventTouchId mir_touch_input_event_get_touch_id | ( | MirTouchInputEvent const * | event, |
size_t | touch_index | ||
) |
Retrieve the TouchID for a touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
MirTouchInputEventTouchTooltype mir_touch_input_event_get_touch_tooltype | ( | MirTouchInputEvent const * | event, |
size_t | touch_index | ||
) |
Retrieve the tooltype for touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
void mir_wait_for | ( | MirWaitHandle * | wait_handle | ) |
Wait on the supplied handle until all instances of the associated request have completed.
[in] | wait_handle | Handle returned by an asynchronous request |
void mir_wait_for_one | ( | MirWaitHandle * | wait_handle | ) |
Wait on the supplied handle until one instance of the associated request has completed.
Use this instead of mir_wait_for in a threaded environment to ensure that the act of waiting does not clear all results associated with the wait handle; only one.
[in] | wait_handle | Handle returned by an asynchronous request |
MirDisplayInfo* display_info |
char const* const mir_arrow_cursor_name |
The standard arrow cursor (typically the system default)
char const* const mir_busy_cursor_name |
The "wait" cursor, typically an hourglass or watch used during operations which prevent the user from interacting.
char const* const mir_caret_cursor_name |
The caret or ibeam cursor, indicating acceptance of text input.
char const* const mir_closed_hand_cursor_name |
The close handed cursor, typically used to indicate that a drag operation is in process which involves scrolling.
char const* const mir_default_cursor_name |
A special cursor name for use with mir_cursor_configuration_from_name representing the system default cursor.
char const* const mir_diagonal_resize_bottom_to_top_cursor_name |
The cursor used to indicate diagonal resize from top-right and bottom-left corners.
char const* const mir_diagonal_resize_top_to_bottom_cursor_name |
The cursor used to indicate diagonal resize from bottom-left and top-right corners.
char const* const mir_disabled_cursor_name |
A special cursor name for use with mir_cursor_configuration_from_name representing a disabled cursor image.
char const* const mir_horizontal_resize_cursor_name |
The cursor used to indicate a horizontal resize operation.
char const* const mir_hsplit_resize_cursor_name |
The cursor used for horizontal splitters, indicating that a handle may be dragged to adjust horizontal space.
char const* const mir_omnidirectional_resize_cursor_name |
The cursor used to indicate resize with no directional constraint.
char const* const mir_open_hand_cursor_name |
The open handed cursor, typically used to indicate that the area beneath the cursor may be clicked and dragged around.
char const* const mir_pointing_hand_cursor_name |
The pointing hand cursor, typically used for clickable elements such as hyperlinks.
char const* const mir_vertical_resize_cursor_name |
The cursor used to indicate a vertical resize operation.
char const* const mir_vsplit_resize_cursor_name |
The cursor used for vertical splitters, indicating that a handle may be dragged to adjust vertical space.
MirSurfaceType type |
Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015