Mir
|
Classes | |
struct | MirWaitHandle |
struct | MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface. More... | |
struct | MirPlatformPackage |
struct | MirModuleProperties |
Retrieved information about a loadable module. More... | |
struct | MirGraphicsRegion |
Retrieved information about a MirSurface. More... | |
struct | MirDisplayInfo |
struct | MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment. More... | |
struct | MirDisplayMode |
struct | MirDisplayOutput |
struct | MirDisplayConfiguration |
struct | MirBufferStreamInfo |
The displacement from the top-left corner of the surface. More... | |
struct | MirRectangle |
struct | MirScreencastParameters |
MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast. More... | |
struct | MirPlatformMessageData |
struct | MirPlatformMessageFds |
struct | MirMesaEGLNativeDisplay |
struct | MirMesaEGLNativeSurface |
struct | MirMesaAuthMagicRequest |
struct | MirMesaAuthMagicResponse |
struct | MirMesaSetGBMDeviceRequest |
struct | MirMesaSetGBMDeviceResponse |
Macros | |
#define | MIR_CLIENT_MAJOR_VERSION (3) |
MIR_CLIENT_MAJOR_VERSION. More... | |
#define | MIR_CLIENT_MINOR_VERSION (3) |
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) |
Typedefs | |
typedef struct MirPresentationChain | MirPresentationChain |
typedef struct MirBuffer | MirBuffer |
typedef void * | MirNativeFence |
typedef void(* | mir_buffer_callback) (MirBuffer *, void *context) |
typedef void(* | mir_presentation_chain_callback) (MirPresentationChain *, void *context) |
typedef enum MirBufferAccess | MirBufferAccess |
typedef void * | MirEGLNativeWindowType |
typedef void * | MirEGLNativeDisplayType |
typedef struct MirConnection | MirConnection |
typedef struct MirSurface | MirSurface |
typedef struct MirSurfaceSpec | MirSurfaceSpec |
typedef struct MirScreencast | MirScreencast |
typedef struct MirScreencastSpec | MirScreencastSpec |
typedef struct MirPromptSession | MirPromptSession |
typedef struct MirBufferStream | MirBufferStream |
typedef struct MirPersistentId | MirPersistentId |
typedef struct MirBlob | MirBlob |
typedef struct MirDisplayConfig | MirDisplayConfig |
typedef struct MirError | MirError |
typedef struct MirOutput | MirOutput |
Descriptor for an output connection. More... | |
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_buffer_stream_callback) (MirBufferStream *stream, void *client_context) |
Callback to be passed when calling: More... | |
typedef void(* | mir_surface_event_callback) (MirSurface *surface, MirEvent const *event, void *context) |
Callback for handling of surface 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_ping_event_callback) (MirConnection *connection, int32_t serial, void *context) |
Callback called when the server pings for responsiveness testing. 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 void(* | mir_surface_id_callback) (MirSurface *surface, MirPersistentId *id, void *context) |
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 MirModuleProperties | MirModuleProperties |
Retrieved information about a loadable module. More... | |
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 enum MirOutputType | MirOutputType |
typedef enum MirOutputConnectionState | MirOutputConnectionState |
typedef struct MirDisplayMode | MirDisplayMode |
typedef struct MirDisplayOutput | MirDisplayOutput |
typedef struct MirDisplayConfiguration | MirDisplayConfiguration |
typedef struct MirBufferStreamInfo | MirBufferStreamInfo |
The displacement from the top-left corner of the surface. More... | |
typedef struct MirRectangle | MirRectangle |
typedef struct MirInputConfig | MirInputConfig |
typedef struct MirInputDevice | MirInputDevice |
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 void(* | mir_input_config_callback) (MirConnection *connection, void *context) |
Callback called when a change of input devices has occurred. More... | |
typedef enum MirErrorDomain | MirErrorDomain |
Specifies the origin of an error. More... | |
typedef enum MirDisplayConfigurationError | MirDisplayConfigurationError |
Errors from the mir_error_domain_display_configuration MirErrorDomain. More... | |
typedef void(* | mir_error_callback) (MirConnection *connection, MirError const *error, void *context) |
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 struct MirKeymapEvent | MirKeymapEvent |
typedef struct MirInputConfigurationEvent | MirInputConfigurationEvent |
typedef struct MirSurfaceOutputEvent | MirSurfaceOutputEvent |
typedef struct MirInputDeviceStateEvent | MirInputDeviceStateEvent |
typedef struct MirCookie | MirCookie |
typedef struct MirEvent | MirEvent |
typedef int64_t | MirInputDeviceId |
typedef unsigned int | MirInputEventModifiers |
typedef struct MirKeyboardEvent | MirKeyboardEvent |
An event type describing a change in keyboard state. More... | |
typedef struct MirPointerEvent | MirPointerEvent |
An event type describing a change in pointer device state. More... | |
typedef unsigned int | MirPointerButtons |
typedef struct MirTouchEvent | MirTouchEvent |
An event type describing a change in touch device state. More... | |
typedef int32_t | MirTouchId |
An identifier for a touch-point. More... | |
typedef struct MirOutputMode | MirOutputMode |
A descriptor for a display mode. More... | |
typedef enum MirPointerHandedness | MirPointerHandedness |
typedef enum MirPointerAcceleration | MirPointerAcceleration |
MirPointerAcceleration describes the way pointer movement is filtered: More... | |
typedef enum MirTouchpadClickMode | MirTouchpadClickMode |
typedef unsigned int | MirTouchpadClickModes |
typedef enum MirTouchpadScrollMode | MirTouchpadScrollMode |
typedef unsigned int | MirTouchpadScrollModes |
typedef unsigned int | MirInputDeviceCapabilities |
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 |
32-bit pixel formats (8888): The order of components in the 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 MirMirrorMode | MirMirrorMode |
Mirroring axis relative to the "natural" orientation of the display. More... | |
typedef enum MirOrientationMode | MirOrientationMode |
typedef enum MirEdgeAttachment | MirEdgeAttachment |
typedef enum MirFormFactor | MirFormFactor |
Form factor associated with a physical output. More... | |
typedef enum MirShellChrome | MirShellChrome |
Shell chrome. More... | |
typedef enum MirPointerConfinementState | MirPointerConfinementState |
Pointer Confinement. More... | |
typedef struct MirMesaEGLNativeDisplay | MirMesaEGLNativeDisplay |
typedef struct MirMesaEGLNativeSurface | MirMesaEGLNativeSurface |
typedef struct MirBufferPackage | MirBufferPackage |
Functions | |
void | mir_connection_allocate_buffer (MirConnection *connection, int width, int height, MirPixelFormat format, MirBufferUsage buffer_usage, mir_buffer_callback available_callback, void *available_context) |
Allocate a MirBuffer and do not wait for the server to return it. More... | |
bool | mir_buffer_is_valid (MirBuffer *buffer) |
Test for a valid buffer. More... | |
char const * | mir_buffer_get_error_message (MirBuffer *buffer) |
Retrieve a text description an error associated with a MirBuffer. More... | |
void | mir_buffer_set_callback (MirBuffer *buffer, mir_buffer_callback available_callback, void *available_context) |
Reassign the callback that the MirBuffer will call when the buffer is available for use again. More... | |
void | mir_buffer_release (MirBuffer *buffer) |
release a MirBuffer More... | |
bool | mir_presentation_chain_is_valid (MirPresentationChain *presentation_chain) |
Test for a valid presentation chain. More... | |
char const * | mir_presentation_chain_get_error_message (MirPresentationChain *presentation_chain) |
Retrieve a text description of the error. More... | |
void | mir_connection_create_presentation_chain (MirConnection *connection, mir_presentation_chain_callback callback, void *context) |
Create a new presentation chain. More... | |
MirPresentationChain * | mir_connection_create_presentation_chain_sync (MirConnection *connection) |
Create a new presentation chain and wait for the result. More... | |
void | mir_presentation_chain_release (MirPresentationChain *presentation_chain) |
Release the specified presentation chain. More... | |
void | mir_presentation_chain_submit_buffer (MirPresentationChain *presentation_chain, MirBuffer *buffer) |
Submit a buffer to the server so the server can display it. More... | |
void | mir_surface_spec_add_presentation_chain (MirSurfaceSpec *spec, int width, int height, int displacement_x, int displacement_y, MirPresentationChain *chain) |
Set the MirSurfaceContent to display a MirPresentationChain. More... | |
void | mir_surface_spec_add_buffer_stream (MirSurfaceSpec *spec, int displacement_x, int displacement_y, MirBufferStream *stream) |
Set the MirSurfaceContent to display a MirBufferStream. More... | |
MirEventType | mir_event_get_type (MirEvent const *ev) |
Retrieves the type of a MirEvent. More... | |
MirInputEvent const * | mir_event_get_input_event (MirEvent const *ev) |
Retrieve the MirInputEvent associated with a MirEvent of type mir_event_type_input. More... | |
MirSurfaceEvent const * | mir_event_get_surface_event (MirEvent const *ev) |
Retrieve the MirSurfaceEvent associated with a MirEvent of type mir_event_type_surface. More... | |
MirResizeEvent const * | mir_event_get_resize_event (MirEvent const *ev) |
Retrieve the MirResizeEvent associated with a MirEvent of type mir_event_type_resize. More... | |
MirPromptSessionEvent const * | mir_event_get_prompt_session_event (MirEvent const *ev) |
Retrieve the MirPromptSessionEvent associated with a MirEvent of type mir_event_type_prompt_session_state_change. More... | |
MirOrientationEvent const * | mir_event_get_orientation_event (MirEvent const *ev) |
Retrieve the MirOrientationEvent associated with a MirEvent of type mir_event_type_orientation. More... | |
__attribute__ ((deprecated)) MirCloseSurfaceEvent const *mir_event_get_close_surface_event(MirEvent const *ev) | |
Retrieve the MirCloseSurfaceEvent associated with a MirEvent of type mir_event_type_close_surface. More... | |
MirKeymapEvent const * | mir_event_get_keymap_event (MirEvent const *ev) |
Retrieve the MirKeymapEvent associated with a MirEvent of type mir_event_type_keymap. More... | |
MirInputConfigurationEvent const * | mir_event_get_input_configuration_event (MirEvent const *ev) |
Retrieve the MirInputConfiguration associated with a MirEvent of type mir_event_type_input_configuration. More... | |
MirSurfaceOutputEvent const * | mir_event_get_surface_output_event (MirEvent const *ev) |
Retrieve the MirSurfaceOutputEvent associated with a MirEvent of type mir_event_type_surface_output. More... | |
MirInputDeviceStateEvent const * | mir_event_get_input_device_state_event (MirEvent const *ev) |
Retrieve the MirInputDeviceStateEvent associated with a MirEvent of type mir_event_type_input_device_state. More... | |
MirEvent const * | mir_event_ref (MirEvent const *ev) __attribute__((warn_unused_result)) |
Reference this MirEvent and return a pointer to the newly referenced instance. More... | |
void | mir_event_unref (MirEvent const *ev) |
Release a reference to a MirEvent. More... | |
MirInputDeviceId | mir_input_event_get_device_id (MirInputEvent const *ev) |
Retrieves the device id responsible for generating an input event. More... | |
int64_t | mir_input_event_get_event_time (MirInputEvent const *ev) |
Retrieve the time at which an input event occurred. More... | |
MirInputEventType | mir_input_event_get_type (MirInputEvent const *ev) |
Retrieve the type of an input event. More... | |
MirKeyboardEvent const * | mir_input_event_get_keyboard_event (MirInputEvent const *ev) |
Retrieve the MirKeyboardEvent associated with a given input event. More... | |
MirTouchEvent const * | mir_input_event_get_touch_event (MirInputEvent const *ev) |
Retrieve the MirTouchEvent associated with a given input event. More... | |
MirPointerEvent const * | mir_input_event_get_pointer_event (MirInputEvent const *ev) |
Retrieve the MirPointerEvent associated with a given input event. More... | |
bool | mir_input_event_has_cookie (MirInputEvent const *ev) |
Query if an input event contains a cookie. More... | |
MirCookie const * | mir_input_event_get_cookie (MirInputEvent const *ev) |
Returns the cookie associated with an input event. More... | |
MirKeyboardAction | mir_keyboard_event_action (MirKeyboardEvent const *event) |
Retrieve the action which triggered a given key event. More... | |
xkb_keysym_t | mir_keyboard_event_key_code (MirKeyboardEvent const *event) |
Retrieve the xkb mapped keycode associated with the key acted on. More... | |
int | mir_keyboard_event_scan_code (MirKeyboardEvent const *event) |
Retrieve the raw hardware scan code associated with the key acted on. More... | |
MirInputEventModifiers | mir_keyboard_event_modifiers (MirKeyboardEvent const *event) |
Retrieve the modifier keys pressed when the key action occured. More... | |
MirInputEvent const * | mir_keyboard_event_input_event (MirKeyboardEvent const *event) |
Retrieve the corresponding input event. More... | |
MirInputEventModifiers | mir_pointer_event_modifiers (MirPointerEvent const *event) |
Retrieve the modifier keys pressed when the pointer action occured. More... | |
MirPointerAction | mir_pointer_event_action (MirPointerEvent const *event) |
Retrieve the action which occured to generate a given pointer event. More... | |
bool | mir_pointer_event_button_state (MirPointerEvent const *event, MirPointerButton button) |
Retrieve the state of a given pointer button when the action occurred. More... | |
MirPointerButtons | mir_pointer_event_buttons (MirPointerEvent const *event) |
Retreive the pointer button state as a masked set of values. More... | |
float | mir_pointer_event_axis_value (MirPointerEvent const *event, MirPointerAxis axis) |
Retrieve the axis value reported by a given pointer event. More... | |
MirInputEvent const * | mir_pointer_event_input_event (MirPointerEvent const *event) |
Retrieve the corresponding input event. More... | |
MirInputEventModifiers | mir_touch_event_modifiers (MirTouchEvent const *event) |
Retrieve the modifier keys pressed when the touch action occured. More... | |
unsigned int | mir_touch_event_point_count (MirTouchEvent const *event) |
Retrieve the number of touches reported for a given touch event. More... | |
MirTouchId | mir_touch_event_id (MirTouchEvent const *event, size_t touch_index) |
Retrieve the TouchID for a touch at given index. More... | |
MirTouchAction | mir_touch_event_action (MirTouchEvent const *event, size_t touch_index) |
Retrieve the action which occured for a touch at given index. More... | |
MirTouchTooltype | mir_touch_event_tooltype (MirTouchEvent const *event, size_t touch_index) |
Retrieve the tooltype for touch at given index. More... | |
float | mir_touch_event_axis_value (MirTouchEvent const *event, size_t touch_index, MirTouchAxis axis) |
Retrieve the axis value for a given axis on an indexed touch. More... | |
MirInputEvent const * | mir_touch_event_input_event (MirTouchEvent const *event) |
Retrieve the corresponding input event. More... | |
MirInputConfigurationAction | mir_input_configuration_event_get_action (MirInputConfigurationEvent const *ev) |
Retrieve the input configuration action which occurred. More... | |
int64_t | mir_input_configuration_event_get_time (MirInputConfigurationEvent const *ev) |
Retreive the time associated with a MirInputConfiguration event. More... | |
MirInputDeviceId | mir_input_configuration_event_get_device_id (MirInputConfigurationEvent const *ev) |
Retreive the device id associated with a MirInputConfiguration event. More... | |
MirPointerButtons | mir_input_device_state_event_pointer_buttons (MirInputDeviceStateEvent const *ev) |
MirInputDeviceStateEvent informs clients about the current state of the input devices. More... | |
float | mir_input_device_state_event_pointer_axis (MirInputDeviceStateEvent const *ev, MirPointerAxis axis) |
Retrieve the pointer position. More... | |
int64_t | mir_input_device_state_event_time (MirInputDeviceStateEvent const *ev) |
Retrieve the time associated with a MirInputDeviceStateEvent. More... | |
MirInputEventModifiers | mir_input_device_state_event_modifiers (MirInputDeviceStateEvent const *ev) |
Retrieve the modifier keys pressed on all input devices. More... | |
uint32_t | mir_input_device_state_event_device_count (MirInputDeviceStateEvent const *ev) |
Retrieve the number of attached input devices. More... | |
MirInputDeviceId | mir_input_device_state_event_device_id (MirInputDeviceStateEvent const *ev, uint32_t index) |
Retrieve the device id. More... | |
uint32_t const * | mir_input_device_state_event_device_pressed_keys (MirInputDeviceStateEvent const *ev, uint32_t index) |
Retrieve an array of pressed keys on the device identified by the index. More... | |
uint32_t | mir_input_device_state_event_device_pressed_keys_count (MirInputDeviceStateEvent const *ev, uint32_t index) |
Retrieve the size of scan code array of the device identified by the index. More... | |
MirPointerButtons | mir_input_device_state_event_device_pointer_buttons (MirInputDeviceStateEvent const *ev, uint32_t index) |
Retrieve the pointer button state of the device identified by the index. More... | |
void | mir_keymap_event_get_rules (MirKeymapEvent const *ev, struct xkb_rule_names *names) __attribute__((deprecated)) |
Retrieve the new keymap reported by this MirKeymapEvent. More... | |
void | mir_keymap_event_get_keymap_buffer (MirKeymapEvent const *ev, char const **buffer, size_t *length) |
Retrieve the new keymap reported by this MirKeymapEvent. More... | |
MirInputDeviceId | mir_keymap_event_get_device_id (MirKeymapEvent const *ev) |
Retrieve the device id the keymap reported by this MirKeymapEvent applies to. More... | |
MirOrientation | mir_orientation_event_get_direction (MirOrientationEvent const *ev) |
Retrieve the new orientation reported by this MirOrientationEvent. More... | |
MirPromptSessionState | mir_prompt_session_event_get_state (MirPromptSessionEvent const *ev) |
Retrieve the new prompt session state reported by a given MirPromptSessionEvent. More... | |
int | mir_resize_event_get_width (MirResizeEvent const *ev) |
Retrieve the new width reported by a given MirResizeEvent. More... | |
int | mir_resize_event_get_height (MirResizeEvent const *ev) |
Retrieve the new height reported by a given MirResizeEvent. More... | |
MirSurfaceAttrib | mir_surface_event_get_attribute (MirSurfaceEvent const *ev) |
Retrieve the attribute index configured with a given MirSurfaceEvent. More... | |
int | mir_surface_event_get_attribute_value (MirSurfaceEvent const *ev) |
Retrieve the new value of the associated attribute for a given MirSurfaceEvent. More... | |
int | mir_surface_output_event_get_dpi (MirSurfaceOutputEvent const *ev) |
Retrieve the DPI of the new output configuration of a MirSurfaceOutputEvent. More... | |
MirFormFactor | mir_surface_output_event_get_form_factor (MirSurfaceOutputEvent const *ev) |
Retrieve the form factor of the new output configuration of a MirSurfaceOutputEvent. More... | |
float | mir_surface_output_event_get_scale (MirSurfaceOutputEvent const *ev) |
Retrieve the suggested scaling factor of the new output configuration of a MirSurfaceOutputEvent. More... | |
uint32_t | mir_surface_output_event_get_output_id (MirSurfaceOutputEvent const *ev) |
Retrieve the ID of the output this surface is on from a MirSurfaceOutputEvent. More... | |
MirBlob * | mir_blob_from_display_configuration (MirDisplayConfiguration *configuration) |
Create a blob from a display configuration. More... | |
MirBlob * | mir_blob_onto_buffer (void const *buffer, size_t buffer_size) |
Create a blob from a buffer. More... | |
MirDisplayConfiguration * | mir_blob_to_display_configuration (MirBlob *blob) |
Create a blob from a display configuration. More... | |
size_t | mir_blob_size (MirBlob *blob) |
Get the size of a blob. More... | |
void const * | mir_blob_data (MirBlob *blob) |
Get the data of a blob. More... | |
void | mir_blob_release (MirBlob *blob) |
Release a blob object. More... | |
bool | mir_buffer_stream_is_valid (MirBufferStream *buffer_stream) |
Test for a valid buffer stream. More... | |
char const * | mir_buffer_stream_get_error_message (MirBufferStream *surface) |
Retrieve a text description of the error. More... | |
MirWaitHandle * | mir_connection_create_buffer_stream (MirConnection *connection, int width, int height, MirPixelFormat format, MirBufferUsage buffer_usage, mir_buffer_stream_callback callback, void *context) |
Create a new buffer stream. More... | |
MirBufferStream * | mir_connection_create_buffer_stream_sync (MirConnection *connection, int width, int height, MirPixelFormat format, MirBufferUsage buffer_usage) |
Create a new buffer stream unattached to a surface and wait for the result. More... | |
MirWaitHandle * | mir_buffer_stream_release (MirBufferStream *buffer_stream, mir_buffer_stream_callback callback, void *context) |
Release the supplied stream and any associated buffer. More... | |
void | mir_buffer_stream_release_sync (MirBufferStream *buffer_stream) |
Release the specified buffer stream like in mir,_buffer_stream_release(), but also wait for the operation to complete. More... | |
void | mir_buffer_stream_get_current_buffer (MirBufferStream *buffer_stream, MirNativeBuffer **buffer_package) |
Retrieve the current buffer in "raw" representation. More... | |
MirWaitHandle * | mir_buffer_stream_swap_buffers (MirBufferStream *buffer_stream, mir_buffer_stream_callback callback, void *context) |
Advance a buffer stream's buffer. More... | |
void | mir_buffer_stream_swap_buffers_sync (MirBufferStream *buffer_stream) |
Advance a buffer stream's buffer as in mir_buffer stream_swap_buffers(), but also wait for the operation to complete. More... | |
void | mir_buffer_stream_get_graphics_region (MirBufferStream *buffer_stream, MirGraphicsRegion *graphics_region) |
Retrieve a buffer stream's graphics region. More... | |
MirEGLNativeWindowType | mir_buffer_stream_get_egl_native_window (MirBufferStream *buffer_stream) |
Retrieve a window type which may be used by EGL. More... | |
MirWaitHandle * | mir_buffer_stream_set_scale (MirBufferStream *stream, float scale) |
Set the scale associated with all buffers in the stream. More... | |
void | mir_buffer_stream_set_scale_sync (MirBufferStream *stream, float scale) |
Set the scale as in mir_buffer_stream_set_scale(), but also wait for the operation to complete. 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_get_graphics_module (MirConnection *connection, MirModuleProperties *properties) |
Query graphics platform module. 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... | |
void | mir_connection_set_ping_event_callback (MirConnection *connection, mir_ping_event_callback callback, void *context) |
Register a callback for server ping events. More... | |
void | mir_connection_pong (MirConnection *connection, int32_t serial) |
Respond to a ping event. More... | |
MirDisplayConfiguration * | mir_connection_create_display_config (MirConnection *connection) |
Query the display. More... | |
MirDisplayConfig * | mir_connection_create_display_configuration (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... | |
MirWaitHandle * | mir_connection_set_base_display_config (MirConnection *connection, MirDisplayConfiguration const *display_configuration) |
Set the base display configuration. More... | |
void | mir_connection_preview_base_display_configuration (MirConnection *connection, MirDisplayConfig const *configuration, int timeout_seconds) |
Preview a new base display configuration. More... | |
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() 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... | |
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. 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... | |
MirInputConfig * | mir_connection_create_input_config (MirConnection *connection) |
Create a snapshot of the attached input devices and device configurations. More... | |
void | mir_input_config_destroy (MirInputConfig const *config) |
Release this snapshot of the input configuration. More... | |
void | mir_connection_set_input_config_change_callback (MirConnection *connection, mir_input_config_callback callback, void *context) |
Register a callback to be called when the input devices change. More... | |
void | mir_connection_set_error_callback (MirConnection *connection, mir_error_callback callback, void *context) |
Register a callback to be called on non-fatal errors. More... | |
size_t | mir_cookie_buffer_size (MirCookie const *cookie) |
Queries the size needed to serialize a given cookie. More... | |
void | mir_cookie_to_buffer (MirCookie const *cookie, void *buffer, size_t size) |
Serializes a cookie into the given buffer. More... | |
MirCookie const * | mir_cookie_from_buffer (void const *buffer, size_t size) |
Create a cookie from a serialized representation. More... | |
void | mir_cookie_release (MirCookie const *cookie) |
Release the MirCookie. 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... | |
MirCursorConfiguration * | mir_cursor_configuration_from_buffer_stream (MirBufferStream const *stream, int hotspot_x, int hotspot_y) |
Returns a new cursor configuration tied to a given buffer stream. More... | |
void | mir_display_config_release (MirDisplayConfig *config) |
Release resources associated with a MirDisplayConfig handle. More... | |
int | mir_display_config_get_max_simultaneous_outputs (MirDisplayConfig const *config) |
Get the maximum possible number of simultaneously active outputs this system supports. More... | |
int | mir_display_config_get_num_outputs (MirDisplayConfig const *config) |
Get the number of outputs available in this display configuration. More... | |
MirOutput const * | mir_display_config_get_output (MirDisplayConfig const *config, size_t index) |
Get a read-only handle to the index 'th output of this configuration. More... | |
MirOutput * | mir_display_config_get_mutable_output (MirDisplayConfig *config, size_t index) |
Get a modifyable handle to the index 'th output of this configuration. More... | |
int | mir_output_get_num_modes (MirOutput const *output) |
Get the number of modes in the supported mode list of this output. More... | |
MirOutputMode const * | mir_output_get_mode (MirOutput const *output, size_t index) |
Get a handle for a mode descriptor from the list of supported modes. More... | |
MirOutputMode const * | mir_output_get_preferred_mode (MirOutput const *output) |
Get a handle to the output's preferred mode. More... | |
MirOutputMode const * | mir_output_get_current_mode (MirOutput const *output) |
Get a handle to the output's current mode. More... | |
void | mir_output_set_current_mode (MirOutput *output, MirOutputMode const *mode) |
Set the current mode of an output. More... | |
int | mir_output_get_num_pixel_formats (MirOutput const *output) |
Get the number of pixel formats supported by this output. More... | |
MirPixelFormat | mir_output_get_pixel_format (MirOutput const *output, size_t index) |
Get a pixel format from the list of supported formats. More... | |
MirPixelFormat | mir_output_get_current_pixel_format (MirOutput const *output) |
Get the current pixel format. More... | |
void | mir_output_set_pixel_format (MirOutput *output, MirPixelFormat format) |
Set the output format. More... | |
int | mir_output_get_id (MirOutput const *output) |
Get the ID of an output. More... | |
MirOutputType | mir_output_get_type (MirOutput const *output) |
Get the physical connection type of an output. More... | |
int | mir_output_get_position_x (MirOutput const *output) |
Get the x coordinate of the top-left point of the output in the virtual display space. More... | |
int | mir_output_get_position_y (MirOutput const *output) |
Get the y coordinate of the top-left point of the output in the virtual display space. More... | |
void | mir_output_set_position (MirOutput *output, int x, int y) |
Set the coordinates of the top-left point of the output in the virtual display space. More... | |
MirOutputConnectionState | mir_output_get_connection_state (MirOutput const *output) |
Get whether there is a display physically connected to the output. More... | |
bool | mir_output_is_enabled (MirOutput const *output) |
Get whether this output is enabled in the current configuration. More... | |
void | mir_output_enable (MirOutput *output) |
Enable this output. More... | |
void | mir_output_disable (MirOutput *output) |
Disable this output. More... | |
int | mir_output_get_physical_width_mm (MirOutput const *output) |
Get the physical width of the connected display, in millimetres. More... | |
int | mir_output_get_physical_height_mm (MirOutput const *output) |
Get the physical height of the connected display, in millimetres. More... | |
MirPowerMode | mir_output_get_power_mode (MirOutput const *output) |
Get the power state of a connected display. More... | |
void | mir_output_set_power_mode (MirOutput *output, MirPowerMode mode) |
Set the power state of a connected display. More... | |
MirOrientation | mir_output_get_orientation (MirOutput const *output) |
Get the orientation of a display. More... | |
void | mir_output_set_orientation (MirOutput *output, MirOrientation orientation) |
Set the orientation of a display. More... | |
float | mir_output_get_scale_factor (MirOutput const *output) |
Get the scale-factor of a display. More... | |
MirFormFactor | mir_output_get_form_factor (MirOutput const *output) |
Get the form-factor of a connected output. More... | |
int | mir_output_mode_get_width (MirOutputMode const *mode) |
Get the width, in pixels, of a MirOutputMode. More... | |
int | mir_output_mode_get_height (MirOutputMode const *mode) |
Get the height, in pixels, of a MirOutputMode. More... | |
double | mir_output_mode_get_refresh_rate (MirOutputMode const *mode) |
Get the refresh rate, in Hz, of a MirOutputMode. More... | |
MirErrorDomain | mir_error_get_domain (MirError const *error) |
Get the domain of a MirError. More... | |
uint32_t | mir_error_get_code (MirError const *error) |
Get the domain-specific error code of a MirError. More... | |
size_t | mir_input_config_device_count (MirInputConfig const *config) |
Retrieve the number of available input devices. More... | |
MirInputDevice const * | mir_input_config_get_device (MirInputConfig const *config, size_t index) |
Retrieve the input device at given index. More... | |
MirInputDevice const * | mir_input_config_get_device_by_id (MirInputConfig const *config, MirInputDeviceId id) |
Retrieve the input device by id. More... | |
MirInputDevice * | mir_input_config_get_mutable_device (MirInputConfig *config, size_t index) |
Retrieve the input device at given index. More... | |
MirInputDevice * | mir_input_config_get_mutable_device_by_id (MirInputConfig *config, MirInputDeviceId id) |
Retrieve the input device by id. More... | |
MirInputDeviceCapabilities | mir_input_device_get_capabilities (MirInputDevice const *device) |
Retrieve the capabilities of the input device at the given index. More... | |
MirInputDeviceId | mir_input_device_get_id (MirInputDevice const *device) |
Retrieve the device id of the input device. More... | |
char const * | mir_input_device_get_name (MirInputDevice const *device) |
Retrieve the name of the input device. More... | |
char const * | mir_input_device_get_unique_id (MirInputDevice const *device) |
Retrieve the unique id of the input device. 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... | |
MirScreencastSpec * | mir_create_screencast_spec (MirConnection *connection) |
Create a screencast specification. More... | |
void | mir_screencast_spec_set_width (MirScreencastSpec *spec, unsigned int width) |
Set the requested width, in pixels. More... | |
void | mir_screencast_spec_set_height (MirScreencastSpec *spec, unsigned int height) |
Set the requested height, in pixels. More... | |
void | mir_screencast_spec_set_pixel_format (MirScreencastSpec *spec, MirPixelFormat format) |
Set the requested pixel format. More... | |
void | mir_screencast_spec_set_capture_region (MirScreencastSpec *spec, MirRectangle const *region) |
Set the rectangular region to capture. More... | |
void | mir_screencast_spec_set_mirror_mode (MirScreencastSpec *spec, MirMirrorMode mode) |
Set the requested mirror mode. More... | |
void | mir_screencast_spec_set_number_of_buffers (MirScreencastSpec *spec, unsigned int nbuffers) |
Set the requested number of buffers to use. More... | |
void | mir_screencast_spec_release (MirScreencastSpec *spec) |
Release the resources held by a MirScreencastSpec. More... | |
MirScreencast * | mir_screencast_create_sync (MirScreencastSpec *spec) |
Create a screencast from a given specification. More... | |
bool | mir_screencast_is_valid (MirScreencast *screencast) |
Test for a valid screencast. More... | |
char const * | mir_screencast_get_error_message (MirScreencast *screencast) |
Retrieve a text description of the 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... | |
MirBufferStream * | mir_screencast_get_buffer_stream (MirScreencast *screencast) |
Retrieve the MirBufferStream associated with a screencast (to advance buffers, obtain EGLNativeWindowType, etc...) 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... | |
MirSurfaceSpec * | mir_create_surface_spec (MirConnection *connection) |
Create a surface specification. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_changes (MirConnection *connection) |
Create a surface specification for updating a 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... | |
void | mir_surface_spec_set_parent (MirSurfaceSpec *spec, MirSurface *parent) |
Set the requested parent. More... | |
void | mir_surface_spec_set_type (MirSurfaceSpec *spec, MirSurfaceType type) |
Update a surface specification with a surface type. More... | |
void | mir_surface_spec_set_name (MirSurfaceSpec *spec, char const *name) |
Set the requested name. More... | |
void | mir_surface_spec_set_width (MirSurfaceSpec *spec, unsigned width) |
Set the requested width, in pixels. More... | |
void | mir_surface_spec_set_height (MirSurfaceSpec *spec, unsigned height) |
Set the requested height, in pixels. More... | |
void | mir_surface_spec_set_width_increment (MirSurfaceSpec *spec, unsigned width_inc) |
Set the requested width increment, in pixels. More... | |
void | mir_surface_spec_set_height_increment (MirSurfaceSpec *spec, unsigned height_inc) |
Set the requested height increment, in pixels Defines an arithmetic progression of sizes starting with min_height (if set, otherwise 0) into which the surface prefers to be resized. More... | |
void | mir_surface_spec_set_min_width (MirSurfaceSpec *spec, unsigned min_width) |
Set the minimum width, in pixels. More... | |
void | mir_surface_spec_set_min_height (MirSurfaceSpec *spec, unsigned min_height) |
Set the minimum height, in pixels. More... | |
void | mir_surface_spec_set_max_width (MirSurfaceSpec *spec, unsigned max_width) |
Set the maximum width, in pixels. More... | |
void | mir_surface_spec_set_max_height (MirSurfaceSpec *spec, unsigned max_height) |
Set the maximum height, in pixels. More... | |
void | mir_surface_spec_set_min_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height) |
Set the minimum aspect ratio. More... | |
void | mir_surface_spec_set_max_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height) |
Set the maximum aspect ratio. More... | |
void | mir_surface_spec_set_pixel_format (MirSurfaceSpec *spec, MirPixelFormat format) |
Set the requested pixel format. More... | |
void | mir_surface_spec_set_buffer_usage (MirSurfaceSpec *spec, MirBufferUsage usage) |
Set the requested buffer usage. More... | |
void | mir_surface_spec_set_fullscreen_on_output (MirSurfaceSpec *spec, uint32_t output_id) |
void | mir_surface_spec_set_preferred_orientation (MirSurfaceSpec *spec, MirOrientationMode mode) |
Set the requested preferred orientation mode. More... | |
bool | mir_surface_spec_attach_to_foreign_parent (MirSurfaceSpec *spec, MirPersistentId *parent, MirRectangle *attachment_rect, MirEdgeAttachment edge) |
Request that the created surface be attached to a surface of a different client. More... | |
void | mir_surface_spec_set_state (MirSurfaceSpec *spec, MirSurfaceState state) |
Set the requested state. More... | |
void | mir_surface_spec_release (MirSurfaceSpec *spec) |
Release the resources held by a MirSurfaceSpec. More... | |
void | mir_surface_spec_set_streams (MirSurfaceSpec *spec, MirBufferStreamInfo *streams, unsigned int num_streams) |
Set the streams associated with the spec. More... | |
void | mir_surface_spec_set_input_shape (MirSurfaceSpec *spec, MirRectangle const *rectangles, size_t n_rects) |
Set a collection of input rectangles assosciated with the spec. More... | |
void | mir_surface_spec_set_event_handler (MirSurfaceSpec *spec, mir_surface_event_callback callback, void *context) |
Set the event handler to be called when events arrive for a surface. More... | |
void | mir_surface_spec_set_shell_chrome (MirSurfaceSpec *spec, MirShellChrome style) |
Ask the shell to customize "chrome" for this surface. More... | |
void | mir_surface_spec_set_pointer_confinement (MirSurfaceSpec *spec, MirPointerConfinementState state) |
Attempts to set the pointer confinement spec for this surface. More... | |
void | mir_surface_set_event_handler (MirSurface *surface, mir_surface_event_callback callback, void *context) |
Set the event handler to be called when events arrive for a surface. More... | |
MirBufferStream * | mir_surface_get_buffer_stream (MirSurface *surface) |
Retrieve the primary MirBufferStream associated with a surface (to advance buffers, obtain EGLNativeWindow, etc...) 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... | |
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... | |
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 the default stream. 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_surface_apply_spec (MirSurface *surface, MirSurfaceSpec *spec) |
Request changes to the specification of a surface. More... | |
MirWaitHandle * | mir_surface_request_persistent_id (MirSurface *surface, mir_surface_id_callback callback, void *context) |
Request an ID for the surface that can be shared cross-process and across restarts. More... | |
MirPersistentId * | mir_surface_request_persistent_id_sync (MirSurface *surface) |
Request a persistent ID for a surface and wait for the result. More... | |
bool | mir_persistent_id_is_valid (MirPersistentId *id) |
Check the validity of a MirPersistentId. More... | |
void | mir_persistent_id_release (MirPersistentId *id) |
Free a MirPersistentId. More... | |
char const * | mir_persistent_id_as_string (MirPersistentId *id) |
Get a string representation of a MirSurfaceId. More... | |
MirPersistentId * | mir_persistent_id_from_string (char const *string_representation) |
Deserialise a string representation of a MirSurfaceId. More... | |
void | mir_surface_raise (MirSurface *surface, MirCookie const *cookie) |
Attempts to raise the surface to the front. 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... | |
Variables | |
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... | |
char const *const | mir_crosshair_cursor_name |
The cursor used for crosshair, which may be used for picking colors or finer precision. More... | |
Fenced Buffer content access functions. | |
These functions will wait until it is safe to access the buffer for the given purpose. If used with mir_none, the buffer will be given the buffer immediately, and without synchronization. It is then up to the user to ensure that the buffer contents are not accessed at inapproprate times.
| |
MirNativeBuffer * | mir_buffer_get_native_buffer (MirBuffer *, MirBufferAccess access) |
Access the native buffer associated with MirBuffer for a given purpose. More... | |
MirGraphicsRegion | mir_buffer_get_graphics_region (MirBuffer *buffer, MirBufferAccess access) |
Access a CPU-mapped region associated with a given buffer for the given purpose. More... | |
MirNativeFence * | mir_buffer_get_fence (MirBuffer *) |
Retrieve the native fence associated with this buffer. More... | |
void | mir_buffer_associate_fence (MirBuffer *buffer, MirNativeFence *native_fence, MirBufferAccess access) |
Protect the buffer's contents by associating a native fence with it. More... | |
int | mir_buffer_wait_for_access (MirBuffer *buffer, MirBufferAccess access, int timeout) |
Wait for the fence associated with the buffer to signal. More... | |
unsigned int | mir_buffer_get_width (MirBuffer *buffer) |
Retrieve the width of the buffer in pixels. More... | |
unsigned int | mir_buffer_get_height (MirBuffer *buffer) |
Retrieve the height of the buffer in pixels. More... | |
MirPixelFormat | mir_buffer_get_pixel_format (MirBuffer *buffer) |
Retrieve the pixel format of the buffer. More... | |
MirBufferUsage | mir_buffer_get_buffer_usage (MirBuffer *buffer) |
Retrieve the buffer usage of the buffer. More... | |
#define MIR_BYTES_PER_PIXEL | ( | f | ) |
#define MIR_CLIENT_MAJOR_VERSION (3) |
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 (3) |
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.
typedef void(* mir_buffer_callback) (MirBuffer *, void *context) |
typedef void(* mir_buffer_stream_callback) (MirBufferStream *stream, void *client_context) |
Callback to be passed when calling:
[in] | stream | the buffer stream being updated |
[in,out] | client_context | context provided by client in calling mir_connect |
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_error_callback) (MirConnection *connection, MirError const *error, void *context) |
typedef void(* mir_input_config_callback) (MirConnection *connection, void *context) |
Callback called when a change of input devices has occurred.
[in] | connection | The connection associated with the input device change |
[in,out] | context | The context provided by client |
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_ping_event_callback) (MirConnection *connection, int32_t serial, void *context) |
Callback called when the server pings for responsiveness testing.
[in] | connection | The connection associated with this ping |
[in] | serial | Identifier of this ping, to be passed to mir_connection_pong() |
[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_presentation_chain_callback) (MirPresentationChain *, void *context) |
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 void(* mir_surface_event_callback) (MirSurface *surface, MirEvent const *event, void *context) |
Callback for handling of surface 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 |
typedef void(* mir_surface_id_callback) (MirSurface *surface, MirPersistentId *id, void *context) |
typedef struct MirBlob MirBlob |
typedef enum MirBufferAccess MirBufferAccess |
typedef struct MirBufferPackage MirBufferPackage |
typedef struct MirBufferStream MirBufferStream |
typedef struct MirBufferStreamInfo MirBufferStreamInfo |
The displacement from the top-left corner of the surface.
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 MirDisplayConfig MirDisplayConfig |
typedef struct MirDisplayConfiguration MirDisplayConfiguration |
typedef enum MirDisplayConfigurationError MirDisplayConfigurationError |
Errors from the mir_error_domain_display_configuration MirErrorDomain.
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 enum MirErrorDomain MirErrorDomain |
Specifies the origin of an error.
This is required to interpret the other aspects of a MirError.
typedef enum MirFormFactor MirFormFactor |
Form factor associated with a physical output.
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 struct MirInputConfig MirInputConfig |
typedef struct MirInputConfigurationEvent MirInputConfigurationEvent |
typedef struct MirInputDevice MirInputDevice |
typedef unsigned int MirInputDeviceCapabilities |
typedef int64_t MirInputDeviceId |
typedef struct MirInputDeviceStateEvent MirInputDeviceStateEvent |
typedef struct MirInputEvent MirInputEvent |
typedef unsigned int MirInputEventModifiers |
typedef struct MirKeyboardEvent MirKeyboardEvent |
An event type describing a change in keyboard state.
Apology #1: Keyboard events almost always come from a keyboard, except they can also come from system buttons (power, volume, home). This is an issue we've inherited from the Linux kernel and Android, but could be solved in future by giving such system switch events their own input group such as MirSwitchEvent.
typedef struct MirKeymapEvent MirKeymapEvent |
typedef enum MirLifecycleState MirLifecycleState |
typedef struct MirMesaEGLNativeDisplay MirMesaEGLNativeDisplay |
typedef struct MirMesaEGLNativeSurface MirMesaEGLNativeSurface |
typedef enum MirMirrorMode MirMirrorMode |
Mirroring axis relative to the "natural" orientation of the display.
typedef struct MirModuleProperties MirModuleProperties |
Retrieved information about a loadable module.
This allows clients to identify the underlying platform. E.g. whether the graphics are "mir:android" or "mir:mesa". Third party graphics platforms do not currently exist but should be named according to the vendor and platform. Vis: "<vendor>:<platform>"
typedef void* MirNativeFence |
typedef enum MirOrientation MirOrientation |
Direction relative to the "natural" orientation of the display.
typedef struct MirOrientationEvent MirOrientationEvent |
typedef enum MirOrientationMode MirOrientationMode |
Descriptor for an output connection.
Each MirOutput corresponds to a video output. This may be a physical connection on the system, like HDMI or DisplayPort, or may be a virtual output such as a remote display or screencast display.
typedef enum MirOutputConnectionState MirOutputConnectionState |
typedef struct MirOutputMode MirOutputMode |
A descriptor for a display mode.
A display mode contains all the information necessary to drive a display. It includes resolution and refresh rate, but also pixel clock, vsync and hsync timings, and so on.
typedef enum MirOutputType MirOutputType |
typedef struct MirPersistentId MirPersistentId |
typedef enum MirPixelFormat MirPixelFormat |
32-bit pixel formats (8888): The order of components in the 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 should be coded as 0xAABBGGRR, which will end up as R,G,B,A in memory on a little endian system, and as A,B,G,R on a big endian system.
24-bit pixel formats (888): These are in literal byte order, regardless of CPU architecture it's always the same. Writing these 3-byte pixels is typically slower than other formats but uses less memory than 32-bit and is endian-independent.
16-bit pixel formats (565/5551/4444): Always interpreted as one 16-bit integer per pixel with components in high-to-low bit order following the format name. These are the fastest formats, however colour quality is visibly lower.
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 enum MirPointerAcceleration MirPointerAcceleration |
MirPointerAcceleration describes the way pointer movement is filtered:
typedef unsigned int MirPointerButtons |
typedef enum MirPointerConfinementState MirPointerConfinementState |
Pointer Confinement.
typedef struct MirPointerEvent MirPointerEvent |
An event type describing a change in pointer device state.
typedef enum MirPointerHandedness MirPointerHandedness |
typedef enum MirPowerMode MirPowerMode |
typedef struct MirPresentationChain MirPresentationChain |
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 MirScreencastSpec MirScreencastSpec |
typedef enum MirShellChrome MirShellChrome |
Shell chrome.
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 MirSurfaceOutputEvent MirSurfaceOutputEvent |
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 MirTouchEvent MirTouchEvent |
An event type describing a change in touch device state.
typedef int32_t MirTouchId |
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 enum MirTouchpadClickMode MirTouchpadClickMode |
typedef unsigned int MirTouchpadClickModes |
typedef enum MirTouchpadScrollMode MirTouchpadScrollMode |
typedef unsigned int MirTouchpadScrollModes |
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.
anonymous enum |
enum MirBufferAccess |
enum MirBufferUsage |
Errors from the mir_error_domain_display_configuration MirErrorDomain.
Enumerator | |
---|---|
mir_display_configuration_error_unauthorized |
Client is not permitted to change global display configuration. |
enum MirDisplayOutputType |
enum MirEdgeAttachment |
enum MirErrorDomain |
Specifies the origin of an error.
This is required to interpret the other aspects of a MirError.
Enumerator | |
---|---|
mir_error_domain_display_configuration |
Errors relating to display configuration. Associated error codes are found in MirDisplayConfigurationError. |
enum MirEventType |
enum MirFormFactor |
MirInputConfigurationEvent indicates a configuration change in the input device subsystem. Eventually it's usage will be required to properly interpret MirInputEvent, for example: If we receive a button down, and then a device reset, we should not expect to receive the button up.
Another example, the maximum/minimum axis values for a device may have been reconfigured and need to be required.
Of course as things stand there is no client input-device introspection API so these events are difficult to use.
Enumerator | |
---|---|
mir_input_configuration_action_configuration_changed | |
mir_input_configuration_action_device_reset |
Description of key modifier state.
enum MirInputEventType |
enum MirKeyboardAction |
enum MirLifecycleState |
enum MirMirrorMode |
enum MirOrientation |
enum MirOrientationMode |
enum MirOutputType |
enum MirPixelFormat |
32-bit pixel formats (8888): The order of components in the 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 should be coded as 0xAABBGGRR, which will end up as R,G,B,A in memory on a little endian system, and as A,B,G,R on a big endian system.
24-bit pixel formats (888): These are in literal byte order, regardless of CPU architecture it's always the same. Writing these 3-byte pixels is typically slower than other formats but uses less memory than 32-bit and is endian-independent.
16-bit pixel formats (565/5551/4444): Always interpreted as one 16-bit integer per pixel with components in high-to-low bit order following the format name. These are the fastest formats, however colour quality is visibly lower.
enum MirPlatformType |
The native buffer type for the system the client is connected on.
Enumerator | |
---|---|
mir_platform_type_gbm | |
mir_platform_type_android | |
mir_platform_type_eglstream |
MirPointerAcceleration describes the way pointer movement is filtered:
Enumerator | |
---|---|
mir_pointer_acceleration_none | |
mir_pointer_acceleration_adaptive |
enum MirPointerAction |
enum MirPointerAxis |
enum MirPointerButton |
enum MirPointerHandedness |
enum MirPowerMode |
enum MirShellChrome |
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 |
enum MirTouchAction |
enum MirTouchAxis |
enum MirTouchpadClickMode |
enum MirTouchTooltype |
__attribute__ | ( | (deprecated) | ) | const |
Retrieve the MirCloseSurfaceEvent associated with a MirEvent of type mir_event_type_close_surface.
Get the underlying platform type so the buffer obtained in "raw" representation in mir_buffer_stream_get_current_buffer() may be understood.
The event is a request to close the surface it is delivered to and has no accessors.
[in] | event | The event |
[in] | surface | The surface |
void const* mir_blob_data | ( | MirBlob * | blob | ) |
Get the data of a blob.
[in] | blob | The blob |
MirBlob* mir_blob_from_display_configuration | ( | MirDisplayConfiguration * | configuration | ) |
Create a blob from a display configuration.
[in] | configuration | The display configuration |
MirBlob* mir_blob_onto_buffer | ( | void const * | buffer, |
size_t | buffer_size | ||
) |
Create a blob from a buffer.
[in] | buffer | the buffer |
[in] | buffer_size | the buffer size |
void mir_blob_release | ( | MirBlob * | blob | ) |
Release a blob object.
[in] | blob | The blob |
size_t mir_blob_size | ( | MirBlob * | blob | ) |
Get the size of a blob.
[in] | blob | The blob |
MirDisplayConfiguration* mir_blob_to_display_configuration | ( | MirBlob * | blob | ) |
Create a blob from a display configuration.
[in] | blob | The blob |
void mir_buffer_associate_fence | ( | MirBuffer * | buffer, |
MirNativeFence * | native_fence, | ||
MirBufferAccess | access | ||
) |
Protect the buffer's contents by associating a native fence with it.
[in] | buffer | The buffer |
[in] | native_fence | The fence that will be associated with buffer. If nullptr, this will remove the fence associated with this buffer. |
[in] | access | The ongoing access that is represented by native_fence. If mir_none is set, this will remove the fence protecting the buffer content. |
MirBufferUsage mir_buffer_get_buffer_usage | ( | MirBuffer * | buffer | ) |
Retrieve the buffer usage of the buffer.
[in] | buffer | The buffer |
char const* mir_buffer_get_error_message | ( | MirBuffer * | buffer | ) |
Retrieve a text description an error associated with a MirBuffer.
The returned string is owned by the library and remains valid until the buffer or the associated connection has been released.
[in] | buffer | The buffer |
MirNativeFence* mir_buffer_get_fence | ( | MirBuffer * | ) |
Retrieve the native fence associated with this buffer.
[in] | buffer | The buffer |
MirGraphicsRegion mir_buffer_get_graphics_region | ( | MirBuffer * | buffer, |
MirBufferAccess | access | ||
) |
Access a CPU-mapped region associated with a given buffer for the given purpose.
This will synchronize the buffer for the given purpose.
[in] | buffer | The buffer |
[in] | type | The type of fence to clear before returning. |
unsigned int mir_buffer_get_height | ( | MirBuffer * | buffer | ) |
Retrieve the height of the buffer in pixels.
[in] | buffer | The buffer |
MirNativeBuffer* mir_buffer_get_native_buffer | ( | MirBuffer * | , |
MirBufferAccess | access | ||
) |
Access the native buffer associated with MirBuffer for a given purpose.
This will synchronize the buffer for the given purpose.
[in] | buffer | The buffer |
[in] | access | The access that is needed for the native buffers content. |
MirPixelFormat mir_buffer_get_pixel_format | ( | MirBuffer * | buffer | ) |
Retrieve the pixel format of the buffer.
[in] | buffer | The buffer |
unsigned int mir_buffer_get_width | ( | MirBuffer * | buffer | ) |
Retrieve the width of the buffer in pixels.
[in] | buffer | The buffer |
bool mir_buffer_is_valid | ( | MirBuffer * | buffer | ) |
Test for a valid buffer.
[in] | buffer | The buffer |
void mir_buffer_release | ( | MirBuffer * | buffer | ) |
release a MirBuffer
[in] | buffer | The buffer to be released |
void mir_buffer_set_callback | ( | MirBuffer * | buffer, |
mir_buffer_callback | available_callback, | ||
void * | available_context | ||
) |
Reassign the callback that the MirBuffer will call when the buffer is available for use again.
[in] | buffer | The buffer |
[in] | available_callback | The callback called when the buffer is available |
[in] | available_context | The context for the available_callback |
void mir_buffer_stream_get_current_buffer | ( | MirBufferStream * | buffer_stream, |
MirNativeBuffer ** | buffer_package | ||
) |
Retrieve the current buffer in "raw" representation.
[in] | surface | The buffer stream |
[out] | buffer_package | Structure to be populated |
MirEGLNativeWindowType mir_buffer_stream_get_egl_native_window | ( | MirBufferStream * | buffer_stream | ) |
Retrieve a window type which may be used by EGL.
[in] | buffer_stream | The buffer stream |
char const* mir_buffer_stream_get_error_message | ( | MirBufferStream * | surface | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the stream or the associated connection has been released.
[in] | buffer_stream | The buffer stream |
void mir_buffer_stream_get_graphics_region | ( | MirBufferStream * | buffer_stream, |
MirGraphicsRegion * | graphics_region | ||
) |
Retrieve a buffer stream's graphics region.
[in] | buffer | stream The buffer stream |
[out] | graphics_region | Structure to be populated |
bool mir_buffer_stream_is_valid | ( | MirBufferStream * | buffer_stream | ) |
Test for a valid buffer stream.
[in] | buffer_stream | The buffer stream |
MirWaitHandle* mir_buffer_stream_release | ( | MirBufferStream * | buffer_stream, |
mir_buffer_stream_callback | callback, | ||
void * | context | ||
) |
Release the supplied stream and any associated buffer.
The returned wait handle remains valid until the connection to the server is released.
[in] | stream | The stream |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_buffer_stream_release_sync | ( | MirBufferStream * | buffer_stream | ) |
Release the specified buffer stream like in mir,_buffer_stream_release(), but also wait for the operation to complete.
[in] | buffer | stream The buffer stream to be released |
MirWaitHandle* mir_buffer_stream_set_scale | ( | MirBufferStream * | stream, |
float | scale | ||
) |
Set the scale associated with all buffers in the stream.
[in] | buffer_stream | The buffer stream |
[in] | scale | The scale |
void mir_buffer_stream_set_scale_sync | ( | MirBufferStream * | stream, |
float | scale | ||
) |
Set the scale as in mir_buffer_stream_set_scale(), but also wait for the operation to complete.
[in] | buffer_stream | The buffer stream |
[in] | scale | The scale |
MirWaitHandle* mir_buffer_stream_swap_buffers | ( | MirBufferStream * | buffer_stream, |
mir_buffer_stream_callback | callback, | ||
void * | context | ||
) |
Advance a buffer stream's buffer.
The returned handle remains valid until the next call to mir_buffer_stream_swap_buffers, until the buffer stream has been released or the connection to the server has been released.
[in] | buffer_stream | The buffer stream |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_buffer_stream_swap_buffers_sync | ( | MirBufferStream * | buffer_stream | ) |
Advance a buffer stream's buffer as in mir_buffer stream_swap_buffers(), but also wait for the operation to complete.
[in] | buffer | stream The buffer stream whose buffer to advance |
int mir_buffer_wait_for_access | ( | MirBuffer * | buffer, |
MirBufferAccess | access, | ||
int | timeout | ||
) |
Wait for the fence associated with the buffer to signal.
After returning, it is permissible to access the buffer's content for the designated purpose in access.
[in] | buffer | The buffer |
[in] | access | The access to wait for. |
[in] | timeout | The amount of time to wait for the fence in nanoseconds, or -1 for infinite timeout. |
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 |
void mir_connection_allocate_buffer | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirBufferUsage | buffer_usage, | ||
mir_buffer_callback | available_callback, | ||
void * | available_context | ||
) |
Allocate a MirBuffer and do not wait for the server to return it.
The callback will be called when the buffer is available for use. It will be called once when created, and once per every mir_presentation_chain_submit_buffer.
[in] | presentation_chain | The presentation chain |
[in] | width | Requested buffer width |
[in] | height | Requested buffer height |
[in] | buffer_usage | Requested buffer usage |
[in] | available_callback | The callback called when the buffer is available |
[in] | available_context | The context for the available_callback |
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 |
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()
The base display configuration is the configuration the server applies when there is no active per-connection configuration.
If this request succeeds a second configuration change event is sent to the client, identical to the one sent after mir_connection_preview_base_display_configuration(). Clients should register a callback with mir_connection_set_display_config_change_callback() in order to determine when this call succeeds.
The MirDisplayConfig must be the same as the one passed to mir_connection_preview_base_display_configuration().
[in] | connection | The connection |
[in] | configuration | The MirDisplayConfig to confirm as base configuration. |
MirWaitHandle* mir_connection_create_buffer_stream | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirBufferUsage | buffer_usage, | ||
mir_buffer_stream_callback | callback, | ||
void * | context | ||
) |
Create a new buffer stream.
For example, the resulting buffer stream may be used with mir_cursor_configuration_from_buffer_stream, in order to post images to the system cursor.
[in] | connection | A valid connection |
[in] | width | Requested buffer width |
[in] | height | Requested buffer height |
[in] | buffer_usage | Requested buffer usage, use mir_buffer_usage_software for cursor image streams |
[in] | callback | Callback to be invoked when the request completes The callback is guaranteed to be called and called with a non-null MirBufferStream*, but the stream may be invalid in case of an error. |
[in] | context | Userdata to pass to callback function |
MirBufferStream* mir_connection_create_buffer_stream_sync | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirBufferUsage | buffer_usage | ||
) |
Create a new buffer stream unattached to a surface and wait for the result.
The resulting buffer stream may be used with mir_cursor_configuration_from_buffer_stream in order to post images to the system cursor.
[in] | connection | A valid connection |
[in] | width | Requested buffer width |
[in] | height | Requested buffer height |
[in] | buffer_usage | Requested buffer usage, use mir_buffer_usage_software for cursor image streams |
MirDisplayConfiguration* mir_connection_create_display_config | ( | MirConnection * | connection | ) |
Query the display.
[in] | connection | The connection |
MirDisplayConfig* mir_connection_create_display_configuration | ( | MirConnection * | connection | ) |
Query the display.
[in] | connection | The connection |
MirInputConfig* mir_connection_create_input_config | ( | MirConnection * | connection | ) |
Create a snapshot of the attached input devices and device configurations.
[in] | connection | The connection |
void mir_connection_create_presentation_chain | ( | MirConnection * | connection, |
mir_presentation_chain_callback | callback, | ||
void * | context | ||
) |
Create a new presentation chain.
[in] | connection | A valid connection |
[in] | callback | Callback to be invoked when the request completes. The callback is guaranteed to be called and called with a non-null MirPresentationChain*, but the chain may be invalid in case of an error. |
[in] | presentation_chain | Userdata to pass to callback function |
MirPresentationChain* mir_connection_create_presentation_chain_sync | ( | MirConnection * | connection | ) |
Create a new presentation chain and wait for the result.
[in] | connection | A valid 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_changes | ( | MirConnection * | connection | ) |
Create a surface specification for updating a surface.
This can be applied to one or more target surfaces using mir_surface_apply_spec(...).
[in] | connection | a valid mir connection |
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. |
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 |
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.
[in] | connection | The connection |
[in] | egldisplay | The EGLDisplay for the given config |
[in] | eglconfig | The EGLConfig you have chosen to use |
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_graphics_module | ( | MirConnection * | connection, |
MirModuleProperties * | properties | ||
) |
Query graphics platform module.
[in] | connection | The connection |
[out] | properties | Structure to be populated |
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_pong | ( | MirConnection * | connection, |
int32_t | serial | ||
) |
Respond to a ping event.
[in] | connection | The connection |
[in] | serial | Serial from the ping event |
void mir_connection_preview_base_display_configuration | ( | MirConnection * | connection, |
MirDisplayConfig const * | configuration, | ||
int | timeout_seconds | ||
) |
Preview a new base display configuration.
The base display configuration is the configuration the server applies when there is no active per-connection configuration.
The display configuration will automatically revert to the previous settings after timeout_seconds unless confirmed by a call to mir_connection_confirm_base_display_configuration().
If this request succeeds a configuration change event is sent to the client. Clients should register a callback with mir_connection_set_display_config_change_callback() in order to determine when this call succeeds.
If the configuration is not confirmed before timeout_seconds have elapsed a second configuration change event is sent, with the old config.
[in] | connection | The connection |
[in] | configuration | The MirDisplayConfig to set as base |
[in] | timeout_seconds | The time the server should wait, in seconds, for the change to be confirmed before reverting to the previous configuration. |
void mir_connection_release | ( | MirConnection * | connection | ) |
Release a connection to the Mir server.
[in] | connection | The connection |
MirWaitHandle* mir_connection_set_base_display_config | ( | MirConnection * | connection, |
MirDisplayConfiguration const * | display_configuration | ||
) |
Set the base display configuration.
The base display configuration is the configuration the server applies when there is no active per-connection configuration.
When the wait handle returned by this function becomes ready, clients can use mir_connection_get_error_message() to check if an authorization error occurred. Only authorization errors are guaranteed to return an error message for this operation.
A successful result (i.e. no error) does not guarantee that the base display configuration has been changed to the desired value. Clients should register a callback with mir_connection_set_display_config_change_callback() to monitor actual base display configuration changes.
[in] | connection | The connection |
[in] | display_configuration | The display_configuration to set as base |
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_configuration 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_error_callback | ( | MirConnection * | connection, |
mir_error_callback | callback, | ||
void * | context | ||
) |
Register a callback to be called on non-fatal errors.
[in] | connection | The connection |
[in] | callback | The function to be called when an error occurs |
[in,out] | context | User data passed to the callback function |
void mir_connection_set_input_config_change_callback | ( | MirConnection * | connection, |
mir_input_config_callback | callback, | ||
void * | context | ||
) |
Register a callback to be called when the input devices change.
Once a change has occurred, you can use mir_connection_create_input_config to get an updated snapshot of the input device configuration.
[in] | connection | The connection |
[in] | callback | The function to be called when a 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_connection_set_ping_event_callback | ( | MirConnection * | connection, |
mir_ping_event_callback | callback, | ||
void * | context | ||
) |
Register a callback for server ping events.
The server may send ping requests to detect unresponsive applications. Clients should process this with their regular event handling, and call mir_connection_pong() in response.
The shell may treat a client which fails to pong in a timely fashion differently; a common response is to overlay the surface with an unresponsive application message.
A default implementation that immediately calls pong is provided; toolkits SHOULD override this default implementation to more accurately reflect the state of their event processing loop.
[in] | connection | The connection |
[in] | callback | The function to be called on ping events. |
[in] | context | User data passed to the callback function |
size_t mir_cookie_buffer_size | ( | MirCookie const * | cookie | ) |
Queries the size needed to serialize a given cookie.
[in] cookie A cookie instance
MirCookie const* mir_cookie_from_buffer | ( | void const * | buffer, |
size_t | size | ||
) |
Create a cookie from a serialized representation.
[in] buffer The buffer containing a serialized cookie. The buffer may be freed immediately after this call.
void mir_cookie_release | ( | MirCookie const * | cookie | ) |
Release the MirCookie.
[in] cookie The cookie to release
void mir_cookie_to_buffer | ( | MirCookie const * | cookie, |
void * | buffer, | ||
size_t | size | ||
) |
Serializes a cookie into the given buffer.
MirScreencastSpec* mir_create_screencast_spec | ( | MirConnection * | connection | ) |
Create a screencast specification.
[in] | connection | a valid mir connection |
MirSurfaceSpec* mir_create_surface_spec | ( | MirConnection * | connection | ) |
Create a surface specification.
This can be used with mir_surface_create() to create a surface or with mir_surface_apply_spec() to change an existing surface.
[in] | connection | a valid mir connection |
void mir_cursor_configuration_destroy | ( | MirCursorConfiguration * | parameters | ) |
Release resources assosciated with cursor parameters.
[in] | parameters | The operand |
MirCursorConfiguration* mir_cursor_configuration_from_buffer_stream | ( | MirBufferStream const * | stream, |
int | hotspot_x, | ||
int | hotspot_y | ||
) |
Returns a new cursor configuration tied to a given buffer stream.
If the configuration is successfully applied buffers from the stream will be used to fill the system cursor.
[in] | name | The buffer stream |
[in] | hotspot_x | The x-coordinate to use as the cursor's hotspot. |
[in] | hotspot_y | The y-coordinate to use as the cursor's hotspot. |
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 |
int mir_display_config_get_max_simultaneous_outputs | ( | MirDisplayConfig const * | config | ) |
Get the maximum possible number of simultaneously active outputs this system supports.
[in] | config | The configuration to query |
MirOutput* mir_display_config_get_mutable_output | ( | MirDisplayConfig * | config, |
size_t | index | ||
) |
Get a modifyable handle to the index 'th output of this configuration.
[in] | config | The configuration to query |
[in] | index | The index of the output to get |
int mir_display_config_get_num_outputs | ( | MirDisplayConfig const * | config | ) |
Get the number of outputs available in this display configuration.
This returns the total number of outputs the system has. This includes both enabled and disabled output connections, and is typically larger than the value returned from mir_display_config_get_max_simultaneous_outputs().
Typically this will be constant over the lifetime of a client as devices usually do not gain extra physical ports at runtime. However, hotpluggable display devices exist and the number of virtual outputs may change at runtime, so this should always be called to determine the number of outputs to iterate over.
[in] | config | The configuration to query |
MirOutput const* mir_display_config_get_output | ( | MirDisplayConfig const * | config, |
size_t | index | ||
) |
Get a read-only handle to the index 'th output of this configuration.
[in] | config | The configuration to query |
[in] | index | The index of the output to get |
void mir_display_config_release | ( | MirDisplayConfig * | config | ) |
Release resources associated with a MirDisplayConfig handle.
[in] | config | The handle to release |
uint32_t mir_error_get_code | ( | MirError const * | error | ) |
MirErrorDomain mir_error_get_domain | ( | MirError const * | error | ) |
MirInputConfigurationEvent const* mir_event_get_input_configuration_event | ( | MirEvent const * | ev | ) |
Retrieve the MirInputConfiguration associated with a MirEvent of type mir_event_type_input_configuration.
The event signifies that the input device configuration has changed.
[in] | event | The event |
MirInputDeviceStateEvent const* mir_event_get_input_device_state_event | ( | MirEvent const * | ev | ) |
Retrieve the MirInputDeviceStateEvent associated with a MirEvent of type mir_event_type_input_device_state.
The event signifies that the client has not received the most recent input events, and thus receives a state update for all attached devices.
[in] | event | The event |
MirInputEvent const* mir_event_get_input_event | ( | MirEvent const * | ev | ) |
Retrieve the MirInputEvent associated with a MirEvent of type mir_event_type_input.
See <mir_toolkit/events/input/input_event.h> for accessors.
[in] | event | The event |
MirKeymapEvent const* mir_event_get_keymap_event | ( | MirEvent const * | ev | ) |
Retrieve the MirKeymapEvent associated with a MirEvent of type mir_event_type_keymap.
The event signifies that the keymap applied for the relevant surface has changed.
[in] | event | The event |
MirOrientationEvent const* mir_event_get_orientation_event | ( | MirEvent const * | ev | ) |
Retrieve the MirOrientationEvent associated with a MirEvent of type mir_event_type_orientation.
See <mir_toolkit/events/orientation_event.h> for accessors.
[in] | event | The event |
MirPromptSessionEvent const* mir_event_get_prompt_session_event | ( | MirEvent const * | ev | ) |
Retrieve the MirPromptSessionEvent associated with a MirEvent of type mir_event_type_prompt_session_state_change.
See <mir_toolkits/events/prompt_session_event.h> for accessors.
[in] | event | The event |
MirResizeEvent const* mir_event_get_resize_event | ( | MirEvent const * | ev | ) |
Retrieve the MirResizeEvent associated with a MirEvent of type mir_event_type_resize.
See <mir_toolkits/events/resize_event.h> for accessors.
[in] | event | The event |
MirSurfaceEvent const* mir_event_get_surface_event | ( | MirEvent const * | ev | ) |
Retrieve the MirSurfaceEvent associated with a MirEvent of type mir_event_type_surface.
See <mir_toolkit/events/surface_event.h> for accessors.
[in] | event | The event |
MirSurfaceOutputEvent const* mir_event_get_surface_output_event | ( | MirEvent const * | ev | ) |
Retrieve the MirSurfaceOutputEvent associated with a MirEvent of type mir_event_type_surface_output.
The event signifies that the properties of the output the surface is displayed upon have changed.
A MirSurfaceOutputEvent is generated either when the properties of the output the surface is primarily on change (for example: by user configuration of resolution) or when the output the surface is primarily on changes (for example: when a user moves the surface from one monitor to another).
[in] | event | The event |
MirEventType mir_event_get_type | ( | MirEvent const * | ev | ) |
Retrieves the type of a MirEvent.
Now preferred over direct access to ev->type. In particular ev->type will never be mir_event_type_input and mir_event_get_type is the only way to ensure mir_event_get_input_event will succeed.
[in] | event | The event |
Reference this MirEvent and return a pointer to the newly referenced instance.
[in] | The | event to reference |
void mir_event_unref | ( | MirEvent const * | ev | ) |
Release a reference to a MirEvent.
[in] | The | event to un-reference |
void mir_input_config_destroy | ( | MirInputConfig const * | config | ) |
Release this snapshot of the input configuration.
This invalidates any pointers retrieved from this structure.
[in] | devices | The input configuration |
size_t mir_input_config_device_count | ( | MirInputConfig const * | config | ) |
Retrieve the number of available input devices.
[in] | config | The input configuration snapshot |
MirInputDevice const* mir_input_config_get_device | ( | MirInputConfig const * | config, |
size_t | index | ||
) |
Retrieve the input device at given index.
The pointer returned stays valid until mir_input_config_destroy is called with config.
[in] | config | The input configuration snapshot |
[in] | index | The index of the input device to return. |
MirInputDevice const* mir_input_config_get_device_by_id | ( | MirInputConfig const * | config, |
MirInputDeviceId | id | ||
) |
Retrieve the input device by id.
The MirInputDevice returned stays valid until mir_input_config_destroy is called with config. If no device with the given id is found NULL will be returned.
[in] | config | The input configuration snapshot |
[in] | id | The input device id to search for |
MirInputDevice* mir_input_config_get_mutable_device | ( | MirInputConfig * | config, |
size_t | index | ||
) |
Retrieve the input device at given index.
The pointer returned stays valid until mir_input_config_destroy is called with config.
[in] | config | The input configuration snapshot |
[in] | index | The index of the input device to return. |
MirInputDevice* mir_input_config_get_mutable_device_by_id | ( | MirInputConfig * | config, |
MirInputDeviceId | id | ||
) |
Retrieve the input device by id.
The MirInputDevice returned stays valid until mir_input_config_destroy is called with config. If no device with the given id is found NULL will be returned.
[in] | config | The input configuration snapshot |
[in] | id | The input device id to search for |
MirInputConfigurationAction mir_input_configuration_event_get_action | ( | MirInputConfigurationEvent const * | ev | ) |
Retrieve the input configuration action which occurred.
[in] | ev | The input configuration event |
MirInputDeviceId mir_input_configuration_event_get_device_id | ( | MirInputConfigurationEvent const * | ev | ) |
Retreive the device id associated with a MirInputConfiguration event.
[in] | ev | The input configuration event |
int64_t mir_input_configuration_event_get_time | ( | MirInputConfigurationEvent const * | ev | ) |
Retreive the time associated with a MirInputConfiguration event.
[in] | ev | The input configuration event |
MirInputDeviceCapabilities mir_input_device_get_capabilities | ( | MirInputDevice const * | device | ) |
Retrieve the capabilities of the input device at the given index.
[in] | device | The input device |
MirInputDeviceId mir_input_device_get_id | ( | MirInputDevice const * | device | ) |
Retrieve the device id of the input device.
The device id is a unique integer value, only valid while the device is attached. The device id matches the device id attached every input event.
[in] | device | The input device |
char const* mir_input_device_get_name | ( | MirInputDevice const * | device | ) |
Retrieve the name of the input device.
The string pointed to will be valid as long as MirInputDevice is valid. The name may be empty but never NULL.
[in] | device | The input device |
char const* mir_input_device_get_unique_id | ( | MirInputDevice const * | device | ) |
Retrieve the unique id of the input device.
The string pointed to will be valid as long as device is valid. The value of the unique id of a given device should be valid across mir connections session and servers of the same version.
[in] | device | The input device |
uint32_t mir_input_device_state_event_device_count | ( | MirInputDeviceStateEvent const * | ev | ) |
Retrieve the number of attached input devices.
[in] | ev | The input device state event |
MirInputDeviceId mir_input_device_state_event_device_id | ( | MirInputDeviceStateEvent const * | ev, |
uint32_t | index | ||
) |
Retrieve the device id.
[in] | ev | The input device state event |
[in] | index | The index of the input device |
MirPointerButtons mir_input_device_state_event_device_pointer_buttons | ( | MirInputDeviceStateEvent const * | ev, |
uint32_t | index | ||
) |
Retrieve the pointer button state of the device identified by the index.
[in] | ev | The input device state event |
[in] | index | The index of the input device |
uint32_t const* mir_input_device_state_event_device_pressed_keys | ( | MirInputDeviceStateEvent const * | ev, |
uint32_t | index | ||
) |
Retrieve an array of pressed keys on the device identified by the index.
The keys are encoded as scan codes.
[in] | ev | The input device state event |
[in] | index | The index of the input device |
uint32_t mir_input_device_state_event_device_pressed_keys_count | ( | MirInputDeviceStateEvent const * | ev, |
uint32_t | index | ||
) |
Retrieve the size of scan code array of the device identified by the index.
[in] | ev | The input device state event |
[in] | index | The index of the input device |
MirInputEventModifiers mir_input_device_state_event_modifiers | ( | MirInputDeviceStateEvent const * | ev | ) |
Retrieve the modifier keys pressed on all input devices.
[in] | ev | The input device state event |
float mir_input_device_state_event_pointer_axis | ( | MirInputDeviceStateEvent const * | ev, |
MirPointerAxis | axis | ||
) |
Retrieve the pointer position.
[in] | ev | The input device state event |
[in] | axis | The pointer axis: mir_pointer_axis_x or mir_pointer_axis_y |
MirPointerButtons mir_input_device_state_event_pointer_buttons | ( | MirInputDeviceStateEvent const * | ev | ) |
MirInputDeviceStateEvent informs clients about the current state of the input devices.
This is necessary when the client did not receive the most recent input events. The event is sent when the server was resumed after a pause, or when the client just received the input focus.
The event contains a single pointer button state and the current cursor position and the pressed modifier keys. Additionally for key and pointer devices the pressed keys and buttons are supplied individually. Retrieve the button state.
[in] | ev | The input device state event |
int64_t mir_input_device_state_event_time | ( | MirInputDeviceStateEvent const * | ev | ) |
Retrieve the time associated with a MirInputDeviceStateEvent.
[in] | ev | The input device state event |
MirCookie const* mir_input_event_get_cookie | ( | MirInputEvent const * | ev | ) |
Returns the cookie associated with an input event.
MirInputDeviceId mir_input_event_get_device_id | ( | MirInputEvent const * | ev | ) |
Retrieves the device id responsible for generating an input event.
[in] | event | The input event |
int64_t mir_input_event_get_event_time | ( | MirInputEvent const * | ev | ) |
Retrieve the time at which an input event occurred.
[in] | event | The input event |
MirKeyboardEvent const* mir_input_event_get_keyboard_event | ( | MirInputEvent const * | ev | ) |
Retrieve the MirKeyboardEvent associated with a given input event.
[in] | event | The input event |
MirPointerEvent const* mir_input_event_get_pointer_event | ( | MirInputEvent const * | ev | ) |
Retrieve the MirPointerEvent associated with a given input event.
[in] | event | The input event |
MirTouchEvent const* mir_input_event_get_touch_event | ( | MirInputEvent const * | ev | ) |
Retrieve the MirTouchEvent associated with a given input event.
[in] | event | The input event |
MirInputEventType mir_input_event_get_type | ( | MirInputEvent const * | ev | ) |
Retrieve the type of an input event.
E.g. key, touch...
[in] | event | The input event |
bool mir_input_event_has_cookie | ( | MirInputEvent const * | ev | ) |
Query if an input event contains a cookie.
[in] ev The input event
MirKeyboardAction mir_keyboard_event_action | ( | MirKeyboardEvent const * | event | ) |
Retrieve the action which triggered a given key event.
[in] | event | The key event |
MirInputEvent const* mir_keyboard_event_input_event | ( | MirKeyboardEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The keyboard event |
xkb_keysym_t mir_keyboard_event_key_code | ( | MirKeyboardEvent 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_keyboard_event_modifiers | ( | MirKeyboardEvent const * | event | ) |
Retrieve the modifier keys pressed when the key action occured.
[in] | event | The key event |
int mir_keyboard_event_scan_code | ( | MirKeyboardEvent 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 |
MirInputDeviceId mir_keymap_event_get_device_id | ( | MirKeymapEvent const * | ev | ) |
Retrieve the device id the keymap reported by this MirKeymapEvent applies to.
[in] | ev | The keymap event |
[out] | rules | XKB rules describing the new keymap. |
void mir_keymap_event_get_keymap_buffer | ( | MirKeymapEvent const * | ev, |
char const ** | buffer, | ||
size_t * | length | ||
) |
Retrieve the new keymap reported by this MirKeymapEvent.
The keymap buffer is only valid while the MirKeymapEvent is valid. The buffer can be used via xkb_keymap_new_from_buffer
[in] | ev | The keymap event |
[out] | buffer | the xkbcommon keymap |
[out] | length | of the buffer |
void mir_keymap_event_get_rules | ( | MirKeymapEvent const * | ev, |
struct xkb_rule_names * | names | ||
) |
Retrieve the new keymap reported by this MirKeymapEvent.
[in] | ev | The keymap event |
[out] | rules | XKB rules describing the new keymap. |
MirOrientation mir_orientation_event_get_direction | ( | MirOrientationEvent const * | ev | ) |
Retrieve the new orientation reported by this MirOrientationEvent.
[in] | ev | The orientation event |
void mir_output_disable | ( | MirOutput * | output | ) |
Disable this output.
[in] | output | the MirOutput to disable |
void mir_output_enable | ( | MirOutput * | output | ) |
Enable this output.
[in] | output | the MirOutput to enable |
MirOutputConnectionState mir_output_get_connection_state | ( | MirOutput const * | output | ) |
Get whether there is a display physically connected to the output.
This gives a best-effort determination of whether or not enabling this output will result in an image being displayed to the user.
The accuracy of this determination varies with connection type - for example, for DisplayPort and HDMI connections a return value of mir_output_connection_state_connected is usually a reliable indicator that there is a powered-on display connected.
VGA and DVI connectors can usually determine whether or not there is a physically connected display, but cannot distinguish between a powered or unpowered display.
It is not always possible to determine whether or not there is a display connected; in such cases mir_output_connection_state_unknown is returned.
[in] | output | The MirOutput to query |
MirOutputMode const* mir_output_get_current_mode | ( | MirOutput const * | output | ) |
Get a handle to the output's current mode.
An output may not have a current mode (for example, if it is disabled), in which case this call will return NULL.
[in] | output | The MirOutput to query |
MirPixelFormat mir_output_get_current_pixel_format | ( | MirOutput const * | output | ) |
Get the current pixel format.
[in] | output | The MirOutput to query |
MirFormFactor mir_output_get_form_factor | ( | MirOutput const * | output | ) |
Get the form-factor of a connected output.
This call succeeds even if the output is not connected, but may return nonsense values.
[in] | output | The MirOutput to query |
int mir_output_get_id | ( | MirOutput const * | output | ) |
Get the ID of an output.
This can be used to refer to the output in other parts of the API, such as mir_surface_spec_set_fullscreen_on_output().
[in] | output | The MirOutput to query. |
MirOutputMode const* mir_output_get_mode | ( | MirOutput const * | output, |
size_t | index | ||
) |
Get a handle for a mode descriptor from the list of supported modes.
The list of supported modes is retrieved from the hardware, possibly modified by any applicable quirk tables, and may not be exhaustive.
[in] | output | The MirOutput to query |
[in] | index | The index of the mode to retrieve. |
int mir_output_get_num_modes | ( | MirOutput const * | output | ) |
Get the number of modes in the supported mode list of this output.
The list of supported modes is retrieved from the hardware, possibly modified by any applicable quirk tables, and may not be exhaustive.
[in] | output | The MirOutput to query |
int mir_output_get_num_pixel_formats | ( | MirOutput const * | output | ) |
Get the number of pixel formats supported by this output.
[in] | output | The MirOutput to query |
MirOrientation mir_output_get_orientation | ( | MirOutput const * | output | ) |
Get the orientation of a display.
[in] | output | The MirOutput to query |
int mir_output_get_physical_height_mm | ( | MirOutput const * | output | ) |
Get the physical height of the connected display, in millimetres.
A best-effort report of the physical height of the display connected to this output. This is retrieved from the display hardware, possibly modified by any applicable quirk tables.
Where this information is unavailable or inapplicable (for example, projectors), 0 is returned.
[in] | output | the MirOutput to query |
int mir_output_get_physical_width_mm | ( | MirOutput const * | output | ) |
Get the physical width of the connected display, in millimetres.
A best-effort report of the physical width of the display connected to this output. This is retrieved from the display hardware, possibly modified by any applicable quirk tables.
Where this information is unavailable or inapplicable (for example, projectors), 0 is returned.
[in] | output | the MirOutput to query |
MirPixelFormat mir_output_get_pixel_format | ( | MirOutput const * | output, |
size_t | index | ||
) |
Get a pixel format from the list of supported formats.
[in] | output | The MirOutput to query |
[in] | index | The index of the format to query |
int mir_output_get_position_x | ( | MirOutput const * | output | ) |
Get the x coordinate of the top-left point of the output in the virtual display space.
Outputs can be thought of as viewports into a virtual display space. They may freely overlap, coincide, or be disjoint as desired.
Output orientation changes the orientation of the output rectangle in virtual display space, but does not change its top-left corner.
[in] | output | The MirOutput to query |
int mir_output_get_position_y | ( | MirOutput const * | output | ) |
Get the y coordinate of the top-left point of the output in the virtual display space.
Outputs can be thought of as viewports into a virtual display space. They may freely overlap, coincide, or be disjoint as desired.
Output orientation changes the orientation of the output rectangle in virtual display space, but does not change its top-left corner.
[in] | output | The MirOutput to query |
MirPowerMode mir_output_get_power_mode | ( | MirOutput const * | output | ) |
Get the power state of a connected display.
It is undefined which power state is returned for an output which is not connected.
[in] | output | The MirOutput to query |
MirOutputMode const* mir_output_get_preferred_mode | ( | MirOutput const * | output | ) |
Get a handle to the output's preferred mode.
This is provided by the output itself. For modern displays (LCD, OLED, etc) it is typically a mode with the native resolution.
An output may not have a preferred mode, in which case this call will return NULL.
[in] | output | The MirOutput to query |
float mir_output_get_scale_factor | ( | MirOutput const * | output | ) |
Get the scale-factor of a display.
The scale-factor specifies the conversion between logical pixels and physical pixels on this output.
A surface with dimensions 200×100 on an output with scale-factor 2.0 will display 400x200 pixels on this output, will display 300x150 pixels on an output with scale-factor 1.5, and so on.
Where this calculation would result in a fractional number of pixels the floor is used, so a surface with dimensions 101x100 on an output with scale-factor of 1.5 will display 151x150 pixels, not 152x150.
[in] | output | The MirOutput to query |
MirOutputType mir_output_get_type | ( | MirOutput const * | output | ) |
Get the physical connection type of an output.
This is a best-effort determination, and may be incorrect.
[in] | output | The MirOutput to query |
bool mir_output_is_enabled | ( | MirOutput const * | output | ) |
Get whether this output is enabled in the current configuration.
[in] | output | the MirOutput to query |
int mir_output_mode_get_height | ( | MirOutputMode const * | mode | ) |
Get the height, in pixels, of a MirOutputMode.
[in] | mode | The MirOutputMode to query |
double mir_output_mode_get_refresh_rate | ( | MirOutputMode const * | mode | ) |
Get the refresh rate, in Hz, of a MirOutputMode.
[in] | mode | The MirOutputMode to query |
int mir_output_mode_get_width | ( | MirOutputMode const * | mode | ) |
Get the width, in pixels, of a MirOutputMode.
[in] | mode | The MirOutputMode to query |
void mir_output_set_current_mode | ( | MirOutput * | output, |
MirOutputMode const * | mode | ||
) |
Set the current mode of an output.
[in] | output | The MirOutput to mutate |
[in] | mode | The MirOutputMode to set as the current mode. |
void mir_output_set_orientation | ( | MirOutput * | output, |
MirOrientation | orientation | ||
) |
Set the orientation of a display.
[in] | output | The MirOutput to mutate |
[in] | orientation | The new MirOrientation for output |
void mir_output_set_pixel_format | ( | MirOutput * | output, |
MirPixelFormat | format | ||
) |
Set the output format.
[in] | output | The MirOutput to modify |
[in] | format | The MirPixelFormat to set |
void mir_output_set_position | ( | MirOutput * | output, |
int | x, | ||
int | y | ||
) |
Set the coordinates of the top-left point of the output in the virtual display space.
Outputs can be thought of as viewports into a virtual display space. They may freely overlap, coincide, or be disjoint as desired.
Output orientation changes the orientation of the output rectangle in virtual display space, but does not change its top-left corner.
[in] | output | The MirOutput to mutate |
[in] | x | The new x coordinate of the top-left point of the output in virtual display space. |
[in] | y | The new y coordinate of the top-left point of the output in virtual display space. |
void mir_output_set_power_mode | ( | MirOutput * | output, |
MirPowerMode | mode | ||
) |
Set the power state of a connected display.
It is undefined what power state is set if the output is not connected.
[in] | output | The MirOutput to mutate |
[in] | mode | The new MirPowerMode for output |
char const* mir_persistent_id_as_string | ( | MirPersistentId * | id | ) |
Get a string representation of a MirSurfaceId.
[in] | id | The ID to serialise |
MirPersistentId* mir_persistent_id_from_string | ( | char const * | string_representation | ) |
Deserialise a string representation of a MirSurfaceId.
[in] | string_representation | Serialised representation of the ID |
bool mir_persistent_id_is_valid | ( | MirPersistentId * | id | ) |
Check the validity of a MirPersistentId.
[in] | id | The MirPersistentId |
void mir_persistent_id_release | ( | MirPersistentId * | id | ) |
Free a MirPersistentId.
[in] | id | The MirPersistentId to free |
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 |
MirPointerAction mir_pointer_event_action | ( | MirPointerEvent const * | event | ) |
Retrieve the action which occured to generate a given pointer event.
[in] | event | The pointer event |
float mir_pointer_event_axis_value | ( | MirPointerEvent const * | event, |
MirPointerAxis | 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_event_button_state | ( | MirPointerEvent const * | event, |
MirPointerButton | button | ||
) |
Retrieve the state of a given pointer button when the action occurred.
[in] | event | The pointer event |
[in] | button | The button to check |
MirPointerButtons mir_pointer_event_buttons | ( | MirPointerEvent const * | event | ) |
Retreive the pointer button state as a masked set of values.
[in] | event | The pointer event |
MirInputEvent const* mir_pointer_event_input_event | ( | MirPointerEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The pointer event |
MirInputEventModifiers mir_pointer_event_modifiers | ( | MirPointerEvent const * | event | ) |
Retrieve the modifier keys pressed when the pointer action occured.
[in] | event | The pointer event |
char const* mir_presentation_chain_get_error_message | ( | MirPresentationChain * | presentation_chain | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the chain or the associated connection has been released.
[in] | presentation_chain | The presentation chain |
bool mir_presentation_chain_is_valid | ( | MirPresentationChain * | presentation_chain | ) |
Test for a valid presentation chain.
[in] | presentation_chain | The presentation chain |
void mir_presentation_chain_release | ( | MirPresentationChain * | presentation_chain | ) |
Release the specified presentation chain.
[in] | presentation_chain | The presentation chain to be released |
void mir_presentation_chain_submit_buffer | ( | MirPresentationChain * | presentation_chain, |
MirBuffer * | buffer | ||
) |
Submit a buffer to the server so the server can display it.
The server will notify the client when the buffer is available again via the callback registered during buffer creation.
[in] | presentation_chain | The presentation chain |
[in] | buffer | The buffer to be submitted |
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 | ) |
Retrieve the new prompt session state reported by a given MirPromptSessionEvent.
[in] | event | The prompt session event |
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 | ) |
Retrieve the new height reported by a given MirResizeEvent.
[in] | ev | The resize event |
int mir_resize_event_get_width | ( | MirResizeEvent const * | ev | ) |
Retrieve the new width reported by a given MirResizeEvent.
[in] | ev | The resize event |
MirScreencast* mir_screencast_create_sync | ( | MirScreencastSpec * | spec | ) |
Create a screencast from a given specification.
[in] | spec | Specification of the screencast attributes |
MirBufferStream* mir_screencast_get_buffer_stream | ( | MirScreencast * | screencast | ) |
Retrieve the MirBufferStream associated with a screencast (to advance buffers, obtain EGLNativeWindowType, etc...)
[in] | screencast | The screencast |
char const* mir_screencast_get_error_message | ( | MirScreencast * | screencast | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the screencast or the associated connection has been released.
[in] | screencast | The screencast |
bool mir_screencast_is_valid | ( | MirScreencast * | screencast | ) |
Test for a valid screencast.
[in] | screencast | The screencast to verify |
void mir_screencast_release_sync | ( | MirScreencast * | screencast | ) |
Release the specified screencast.
[in] | screencast | The screencast to be released |
void mir_screencast_spec_release | ( | MirScreencastSpec * | spec | ) |
Release the resources held by a MirScreencastSpec.
[in] | spec | Specification to release |
void mir_screencast_spec_set_capture_region | ( | MirScreencastSpec * | spec, |
MirRectangle const * | region | ||
) |
Set the rectangular region to capture.
[in] | spec | Specification to mutate |
[in] | region | The rectangular region of the screen to capture specified in virtual screen space coordinates |
void mir_screencast_spec_set_height | ( | MirScreencastSpec * | spec, |
unsigned int | height | ||
) |
Set the requested height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Requested height. |
void mir_screencast_spec_set_mirror_mode | ( | MirScreencastSpec * | spec, |
MirMirrorMode | mode | ||
) |
Set the requested mirror mode.
[in] | spec | Specification to mutate |
[in] | mode | The mirroring mode to apply when screencasting |
void mir_screencast_spec_set_number_of_buffers | ( | MirScreencastSpec * | spec, |
unsigned int | nbuffers | ||
) |
Set the requested number of buffers to use.
[in] | spec | Specification to mutate |
[in] | nbuffers | The number of buffers to allocate for screencasting |
void mir_screencast_spec_set_pixel_format | ( | MirScreencastSpec * | spec, |
MirPixelFormat | format | ||
) |
Set the requested pixel format.
[in] | spec | Specification to mutate |
[in] | format | Requested pixel format |
void mir_screencast_spec_set_width | ( | MirScreencastSpec * | spec, |
unsigned int | width | ||
) |
Set the requested width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Requested width. |
void mir_surface_apply_spec | ( | MirSurface * | surface, |
MirSurfaceSpec * | spec | ||
) |
Request changes to the specification of a surface.
The server will decide whether and how the request can be honoured.
[in] | surface | The surface to rename |
[in] | spec | Spec with the requested changes applied |
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 | ) |
Retrieve the attribute index configured with a given MirSurfaceEvent.
[in] | Event | The event |
int mir_surface_event_get_attribute_value | ( | MirSurfaceEvent const * | ev | ) |
Retrieve the new value of the associated attribute for a given MirSurfaceEvent.
[in] | Event | The event |
MirBufferStream* mir_surface_get_buffer_stream | ( | MirSurface * | surface | ) |
Retrieve the primary MirBufferStream associated with a surface (to advance buffers, obtain EGLNativeWindow, etc...)
[in] | surface | The surface |
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.
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 |
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 |
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 |
int mir_surface_output_event_get_dpi | ( | MirSurfaceOutputEvent const * | ev | ) |
Retrieve the DPI of the new output configuration of a MirSurfaceOutputEvent.
[in] | ev | The event |
MirFormFactor mir_surface_output_event_get_form_factor | ( | MirSurfaceOutputEvent const * | ev | ) |
Retrieve the form factor of the new output configuration of a MirSurfaceOutputEvent.
[in] | ev | The event |
uint32_t mir_surface_output_event_get_output_id | ( | MirSurfaceOutputEvent const * | ev | ) |
Retrieve the ID of the output this surface is on from a MirSurfaceOutputEvent.
[in] | ev | The event |
float mir_surface_output_event_get_scale | ( | MirSurfaceOutputEvent const * | ev | ) |
Retrieve the suggested scaling factor of the new output configuration of a MirSurfaceOutputEvent.
[in] | ev | The event |
void mir_surface_raise | ( | MirSurface * | surface, |
MirCookie const * | cookie | ||
) |
Attempts to raise the surface to the front.
[in] | surface | The surface to raise |
[in] | cookie | A cookie instance obtained from an input event. An invalid cookie will terminate the client connection. |
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 |
MirWaitHandle* mir_surface_request_persistent_id | ( | MirSurface * | surface, |
mir_surface_id_callback | callback, | ||
void * | context | ||
) |
Request an ID for the surface that can be shared cross-process and across restarts.
This call acquires a MirPersistentId for this MirSurface. This MirPersistentId can be serialized to a string, stored or sent to another process, and then later deserialized to refer to the same surface.
[in] | surface | The surface to acquire a persistent reference to. |
[in] | callback | Callback to invoke when the request completes. |
[in,out] | context | User data passed to completion callback. |
MirPersistentId* mir_surface_request_persistent_id_sync | ( | MirSurface * | surface | ) |
Request a persistent ID for a surface and wait for the result.
[in] | surface | The surface to acquire a persistent ID for. |
void mir_surface_set_event_handler | ( | MirSurface * | surface, |
mir_surface_event_callback | callback, | ||
void * | context | ||
) |
Set the event handler to be called when events arrive for a surface.
[in] | surface | The surface |
[in] | callback | The callback function |
[in] | context | Additional argument to be passed to callback |
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 the default stream.
[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_add_buffer_stream | ( | MirSurfaceSpec * | spec, |
int | displacement_x, | ||
int | displacement_y, | ||
MirBufferStream * | stream | ||
) |
Set the MirSurfaceContent to display a MirBufferStream.
The initial call to mir_surface_spec_add_presentation_chain or mir_surface_spec_add_buffer_stream will set the bottom-most content, and subsequent calls to either will stack the content on top.
spec | The surface_spec to be updated. |
displacement_x | The x displacement from the top-left corner of the MirSurface. |
displacement_y | The y displacement from the top-left corner of the MirSurface. |
stream | The stream containing the content to be displayed. |
void mir_surface_spec_add_presentation_chain | ( | MirSurfaceSpec * | spec, |
int | width, | ||
int | height, | ||
int | displacement_x, | ||
int | displacement_y, | ||
MirPresentationChain * | chain | ||
) |
Set the MirSurfaceContent to display a MirPresentationChain.
The width and height can be different from the physical dimensions of the MirBuffer's in the MirPresentationChain. If the two differ, the content will be scaled to fit width and height.
The initial call to mir_surface_spec_add_presentation_chain or mir_surface_spec_add_buffer_stream will set the bottom-most content, and subsequent calls to either will stack the content on top.
spec | The surface_spec to be updated. |
width | The width that the content will displayed at. |
height | The height that the content will be displayed at. |
displacement_x | The x displacement from the top-left corner of the MirSurface. |
displacement_y | The y displacement from the top-left corner of the MirSurface. |
chain | The chain containing the content to be displayed. |
bool mir_surface_spec_attach_to_foreign_parent | ( | MirSurfaceSpec * | spec, |
MirPersistentId * | parent, | ||
MirRectangle * | attachment_rect, | ||
MirEdgeAttachment | edge | ||
) |
Request that the created surface be attached to a surface of a different client.
This is restricted to input methods, which need to attach their suggestion surface to text entry widgets of other processes.
[in] | spec | Specification to mutate |
[in] | parent | A MirPersistentId reference to the parent surface |
[in] | attachment_rect | A rectangle specifying the region (in parent surface coordinates) that the created surface should be attached to. |
[in] | edge | The preferred edge direction to attach to. Use mir_edge_attachment_any for no preference. |
void mir_surface_spec_release | ( | MirSurfaceSpec * | spec | ) |
Release the resources held by a MirSurfaceSpec.
[in] | spec | Specification to release |
void 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 |
void mir_surface_spec_set_event_handler | ( | MirSurfaceSpec * | spec, |
mir_surface_event_callback | callback, | ||
void * | context | ||
) |
Set the event handler to be called when events arrive for a surface.
[in] | spec | The spec to accumulate the request in. |
[in] | callback | The callback function |
[in] | context | Additional argument to be passed to callback |
void 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 |
void mir_surface_spec_set_height | ( | MirSurfaceSpec * | spec, |
unsigned | height | ||
) |
Set the requested height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Requested height. |
void mir_surface_spec_set_height_increment | ( | MirSurfaceSpec * | spec, |
unsigned | height_inc | ||
) |
Set the requested height increment, in pixels Defines an arithmetic progression of sizes starting with min_height (if set, otherwise 0) into which the surface prefers to be resized.
[in] | spec | Specification to mutate |
[in] | height_inc | Requested height increment. |
void mir_surface_spec_set_input_shape | ( | MirSurfaceSpec * | spec, |
MirRectangle const * | rectangles, | ||
size_t | n_rects | ||
) |
Set a collection of input rectangles assosciated with the spec.
Rectangles are specified as a list of regions relative to the top left of the specified surface. If the server applies this specification to a surface input which would normally go to the surface but is not contained within any of the input rectangles instead passes on to the next client.
[in] | spec | The spec to accumulate the request in. |
[in] | rectangles | An array of MirRectangles specifying the input shape. |
[in] | num_streams | The number of elements in the rectangles array. |
void mir_surface_spec_set_max_aspect_ratio | ( | MirSurfaceSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
Set the maximum aspect ratio.
This is the maximum ratio of surface width to height. It is independent of orientation changes and/or preferences.
[in] | spec | Specification to mutate |
[in] | width | numerator |
[in] | height | denominator |
void mir_surface_spec_set_max_height | ( | MirSurfaceSpec * | spec, |
unsigned | max_height | ||
) |
Set the maximum height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Maximum height. |
void mir_surface_spec_set_max_width | ( | MirSurfaceSpec * | spec, |
unsigned | max_width | ||
) |
Set the maximum width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Maximum width. |
void mir_surface_spec_set_min_aspect_ratio | ( | MirSurfaceSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
Set the minimum aspect ratio.
This is the minimum ratio of surface width to height. It is independent of orientation changes and/or preferences.
[in] | spec | Specification to mutate |
[in] | width | numerator |
[in] | height | denominator |
void mir_surface_spec_set_min_height | ( | MirSurfaceSpec * | spec, |
unsigned | min_height | ||
) |
Set the minimum height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Minimum height. |
void mir_surface_spec_set_min_width | ( | MirSurfaceSpec * | spec, |
unsigned | min_width | ||
) |
Set the minimum width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Minimum width. |
void 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. |
void mir_surface_spec_set_parent | ( | MirSurfaceSpec * | spec, |
MirSurface * | parent | ||
) |
Set the requested parent.
[in] | spec | Specification to mutate |
[in] | parent | A valid parent surface. |
void 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 |
void mir_surface_spec_set_pointer_confinement | ( | MirSurfaceSpec * | spec, |
MirPointerConfinementState | state | ||
) |
Attempts to set the pointer confinement spec for this surface.
This will request the window manager to confine the pointer to the surfaces region.
[in] | spec | The spec to accumulate the request in. |
[in] | state | The state you would like the pointer confinement to be in. |
void 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 |
void mir_surface_spec_set_shell_chrome | ( | MirSurfaceSpec * | spec, |
MirShellChrome | style | ||
) |
Ask the shell to customize "chrome" for this surface.
For example, on the phone hide indicators when this surface is active.
[in] | spec | The spec to accumulate the request in. |
[in] | style | The requested level of "chrome" |
void mir_surface_spec_set_state | ( | MirSurfaceSpec * | spec, |
MirSurfaceState | state | ||
) |
Set the requested state.
[in] | spec | Specification to mutate |
[in] | mode | Requested state |
void mir_surface_spec_set_streams | ( | MirSurfaceSpec * | spec, |
MirBufferStreamInfo * | streams, | ||
unsigned int | num_streams | ||
) |
Set the streams associated with the spec.
streams[0] is the bottom-most stream, and streams[size-1] is the topmost. On application of the spec, a stream that is present in the surface, but is not in the list will be disassociated from the surface. On application of the spec, a stream that is not present in the surface, but is in the list will be associated with the surface. Streams set a displacement from the top-left corner of the surface.
[in] | spec | The spec to accumulate the request in. |
[in] | streams | An array of non-null streams info. |
[in] | num_streams | The number of elements in the streams array. |
void mir_surface_spec_set_type | ( | MirSurfaceSpec * | spec, |
MirSurfaceType | type | ||
) |
Update a surface specification with a surface type.
This can be used with mir_surface_create() to create a surface or with mir_surface_apply_spec() to change an existing surface.
[in] | spec | Specification to mutate |
[in] | type | the target type of the surface |
void mir_surface_spec_set_width | ( | MirSurfaceSpec * | spec, |
unsigned | width | ||
) |
Set the requested width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Requested width. |
void mir_surface_spec_set_width_increment | ( | MirSurfaceSpec * | spec, |
unsigned | width_inc | ||
) |
Set the requested width increment, in pixels.
Defines an arithmetic progression of sizes starting with min_width (if set, otherwise 0) into which the surface prefers to be resized.
[in] | spec | Specification to mutate |
[in] | width_inc | Requested width increment. |
MirTouchAction mir_touch_event_action | ( | MirTouchEvent 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_event_axis_value | ( | MirTouchEvent const * | event, |
size_t | touch_index, | ||
MirTouchAxis | 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 |
MirTouchId mir_touch_event_id | ( | MirTouchEvent 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). |
MirInputEvent const* mir_touch_event_input_event | ( | MirTouchEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The touch event |
MirInputEventModifiers mir_touch_event_modifiers | ( | MirTouchEvent const * | event | ) |
Retrieve the modifier keys pressed when the touch action occured.
[in] | event | The key event |
unsigned int mir_touch_event_point_count | ( | MirTouchEvent 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 |
MirTouchTooltype mir_touch_event_tooltype | ( | MirTouchEvent 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 |
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_crosshair_cursor_name |
The cursor used for crosshair, which may be used for picking colors or finer precision.
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.
Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Sep 8 14:50:19 UTC 2016