Mir
|
Classes | |
struct | MirSurfaceParameters |
MirWindowParameters is the structure of minimum required information that you must provide to Mir in order to create a window. More... | |
struct | MirPlatformPackage |
struct | MirModuleProperties |
Retrieved information about a loadable module. More... | |
struct | MirGraphicsRegion |
Retrieved information about a MirWindow. 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 |
Macros | |
#define | MIR_BYTES_PER_PIXEL(f) |
#define | MIR_CLIENT_API_VERSION_MAJOR (1) |
#define | MIR_CLIENT_API_VERSION_MINOR (7) |
#define | MIR_CLIENT_API_VERSION_PATCH (2) |
#define | MIR_CLIENT_API_VERSION |
The current version of the Mir client headers in use. More... | |
#define | MIR_CLIENT_MAJOR_VERSION (3) |
#define | MIR_CLIENT_MINOR_VERSION (5) |
#define | MIR_CLIENT_MICRO_VERSION (0) |
#define | MIR_CLIENT_VERSION |
Typedefs | |
typedef enum MirWindowAttrib | MirWindowAttrib |
Attributes of a window that the client and server/shell may wish to get or set over the wire. More... | |
typedef enum MirWindowType | MirWindowType |
typedef enum MirWindowState | MirWindowState |
typedef enum MirWindowFocusState | MirWindowFocusState |
typedef enum MirWindowVisibility | MirWindowVisibility |
typedef enum MirLifecycleState | MirLifecycleState |
typedef enum MirPowerMode | MirPowerMode |
typedef enum MirOutputType | MirOutputType |
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 MirPlacementGravity | MirPlacementGravity |
Reference point for aligning a surface relative to a rectangle. More... | |
typedef enum MirPlacementHints | MirPlacementHints |
Positioning hints for aligning a window relative to a rectangle. More... | |
typedef enum MirResizeEdge | MirResizeEdge |
Hints for resizing a window. More... | |
typedef enum MirFormFactor | MirFormFactor |
Form factor associated with a physical output. More... | |
typedef enum MirSubpixelArrangement | MirSubpixelArrangement |
Physical arrangement of subpixels on the physical output. More... | |
typedef enum MirShellChrome | MirShellChrome |
Shell chrome. More... | |
typedef enum MirPointerConfinementState | MirPointerConfinementState |
Pointer Confinement. More... | |
typedef enum MirOutputGammaSupported | MirOutputGammaSupported |
Supports gamma correction. More... | |
typedef enum MirDepthLayer | MirDepthLayer |
Depth layer controls Z ordering of surfaces. More... | |
typedef int64_t | MirInputDeviceId |
typedef enum MirPointerHandedness | MirPointerHandedness |
typedef enum MirPointerAcceleration | MirPointerAcceleration |
MirPointerAcceleration describes the way pointer movement is filtered: More... | |
typedef enum MirTouchpadClickMode | MirTouchpadClickMode |
MirTouchpadClickMode configures how the touchpad itself should generate pointer button events. More... | |
typedef unsigned int | MirTouchpadClickModes |
typedef enum MirTouchpadScrollMode | MirTouchpadScrollMode |
MirTouchpadScrollMode configures how the touchpad should generate scroll events. More... | |
typedef unsigned int | MirTouchpadScrollModes |
typedef unsigned int | MirInputDeviceCapabilities |
typedef enum MirTouchscreenMappingMode | MirTouchscreenMappingMode |
Mapping modes for touchscreen devices. More... | |
typedef void * | MirEGLNativeWindowType |
typedef void * | MirEGLNativeDisplayType |
typedef struct MirConnection | MirConnection |
typedef struct MirSurface | MirWindow |
typedef struct MirSurfaceSpec | MirWindowSpec |
typedef struct MirScreencast | MirScreencast |
typedef struct MirScreencastSpec | MirScreencastSpec |
typedef struct MirPromptSession | MirPromptSession |
typedef struct MirBufferStream | MirBufferStream |
typedef struct MirPersistentId | MirWindowId |
typedef struct MirBlob | MirBlob |
typedef struct MirDisplayConfig | MirDisplayConfig |
typedef struct MirError | MirError |
typedef struct MirPresentationChain | MirPresentationChain |
typedef struct MirBuffer | MirBuffer |
typedef struct MirRenderSurface | MirRenderSurface |
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(* | MirConnectedCallback) (MirConnection *connection, void *client_context) |
Callback to be passed when issuing a mir_connect request. More... | |
typedef MirConnectedCallback mir_connected_callback | MIR_FOR_REMOVAL_IN_VERSION_1("Use MirConnectedCallback instead") |
typedef void(* | MirWindowCallback) (MirWindow *window, void *client_context) |
Callback to be passed when calling window functions : More... | |
typedef void(* | MirBufferStreamCallback) (MirBufferStream *stream, void *client_context) |
Callback to be passed when calling: More... | |
typedef void(* | MirWindowEventCallback) (MirWindow *window, MirEvent const *event, void *context) |
Callback for handling of window events. More... | |
typedef void(* | MirLifecycleEventCallback) (MirConnection *connection, MirLifecycleState state, void *context) |
Callback called when a lifecycle event/callback is requested from the running server. More... | |
typedef void(* | MirPingEventCallback) (MirConnection *connection, int32_t serial, void *context) |
Callback called when the server pings for responsiveness testing. More... | |
typedef void(* | MirDisplayConfigCallback) (MirConnection *connection, void *context) |
Callback called when a display config change has occurred. More... | |
typedef void(* | MirClientFdCallback) (MirPromptSession *prompt_session, size_t count, int const *fds, void *context) |
Callback called when a request for client file descriptors completes. More... | |
typedef void(* | MirWindowIdCallback) (MirWindow *window, MirPersistentId *id, void *context) |
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 enum MirBufferLayout | MirBufferLayout |
typedef enum MirPresentMode | MirPresentMode |
typedef struct MirGraphicsRegion | MirGraphicsRegion |
Retrieved information about a MirWindow. More... | |
typedef struct MirDisplayInfo | MirDisplayInfo |
typedef struct MirDisplayCard | MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment. More... | |
typedef enum MirDisplayOutputType | MirDisplayOutputType |
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 MirKeyboardConfig | MirKeyboardConfig |
typedef struct MirPointerConfig | MirPointerConfig |
typedef struct MirTouchpadConfig | MirTouchpadConfig |
typedef struct MirTouchscreenConfig | MirTouchscreenConfig |
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(* | MirScreencastCallback) (MirScreencast *screencast, void *client_context) |
Callback to be passed when calling MirScreencast functions. More... | |
typedef void(* | MirPromptSessionCallback) (MirPromptSession *prompt_provider, void *context) |
Callback member of MirPromptSession for handling of prompt sessions. More... | |
typedef void(* | MirPromptSessionStateChangeCallback) (MirPromptSession *prompt_provider, MirPromptSessionState state, void *context) |
Callback member of MirPromptSession for handling of prompt sessions events. More... | |
typedef void(* | MirPlatformOperationCallback) (MirConnection *connection, MirPlatformMessage *reply, void *context) |
Callback called when a platform operation completes. More... | |
typedef void(* | MirInputConfigCallback) (MirConnection *connection, void *context) |
Callback called when a change of input devices has occurred. More... | |
typedef void(* | MirBufferCallback) (MirBuffer *, void *context) |
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 enum MirInputConfigurationError | MirInputConfigurationError |
Errors from the mir_error_domain_input_configuration MirErrorDomain. More... | |
typedef void(* | MirErrorCallback) (MirConnection *connection, MirError const *error, void *context) |
typedef void(* | mir_surface_callback) (MirSurface *surface, void *client_context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowCallback instead") |
typedef void(* | mir_surface_event_callback) (MirSurface *surface, MirEvent const *event, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowEventCallback instead") |
typedef void(* | mir_surface_id_callback) (MirSurface *surface, MirPersistentId *id, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowIdCallback instead") |
typedef struct MirSurfaceEvent | MirWindowEvent |
typedef struct MirResizeEvent | MirResizeEvent |
typedef struct MirPromptSessionEvent | MirPromptSessionEvent |
typedef struct MirOrientationEvent | MirOrientationEvent |
typedef struct MirCloseSurfaceEvent | MirCloseWindowEvent |
typedef struct MirInputEvent | MirInputEvent |
typedef struct MirKeymapEvent | MirKeymapEvent |
typedef struct MirSurfaceOutputEvent | MirWindowOutputEvent |
typedef struct MirInputDeviceStateEvent | MirInputDeviceStateEvent |
typedef struct MirSurfacePlacementEvent | MirWindowPlacementEvent |
typedef struct MirCookie | MirCookie |
typedef struct MirEvent | MirEvent |
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 MirSurfacePlacementEvent | MirSurfacePlacementEvent |
typedef struct MirOutputMode | MirOutputMode |
A descriptor for a display mode. More... | |
typedef enum MirScreencastResult | MirScreencastResult |
typedef void(* | MirScreencastBufferCallback) (MirScreencastResult status, MirBuffer *buffer, void *context) |
typedef void(* | MirRenderSurfaceCallback) (MirRenderSurface *, void *context) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Functions | |
enum MirSurfaceAttrib | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowAttrib") |
Attributes of a surface that the client and server/shell may wish to get or set over the wire. More... | |
enum MirSurfaceType | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowType") |
enum MirSurfaceState | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowState") |
enum MirSurfaceFocusState | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowFocusState") |
struct MirSurface MirSurface | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use MirWindow instead") |
struct MirSurfaceSpec MirSurfaceSpec | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use MirWindowSpec instead") |
struct MirPersistentId MirPersistentId | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use MirWindowId instead") |
struct MirCursorConfiguration MirCursorConfiguration | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use mir_window_spec_set_cursor_name/mir_window_spec_set_cursor_render_surface instead") |
Opaque structure containing cursor parameterization. More... | |
enum MirBufferUsage | MIR_FOR_REMOVAL_IN_VERSION_1 ("No longer applicable when using MirRenderSurface") |
MirBufferUsage specifies how a surface can and will be used. More... | |
struct MirSurfaceParameters | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use mir_window_get apis or listen for attribute events instead") |
MirWindowParameters is the structure of minimum required information that you must provide to Mir in order to create a window. More... | |
struct MirSurfaceEvent MirSurfaceEvent | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowEvent instead") |
struct MirCloseSurfaceEvent MirCloseSurfaceEvent | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirCloseWindowEvent instead") |
struct MirInputConfigurationEvent MirInputConfigurationEvent | MIR_FOR_REMOVAL_IN_VERSION_1 ("Use MirInputDeviceStateEvent and the MirInputConfig callback instead") |
struct MirSurfaceOutputEvent MirSurfaceOutputEvent | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowOutputEvent instead") |
struct MirSurfacePlacementEvent MirSurfacePlacementEvent | MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowPlacementEvent instead") |
MirEventType | mir_event_get_type (MirEvent const *event) |
Retrieves the type of a MirEvent. More... | |
MirInputEvent const * | mir_event_get_input_event (MirEvent const *event) |
Retrieve the MirInputEvent associated with a MirEvent of type mir_event_type_input. More... | |
MirSurfaceEvent const * | mir_event_get_surface_event (MirEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_event instead") |
Retrieve the MirSurfaceEvent associated with a MirEvent of type mir_event_type_surface. More... | |
MirWindowEvent const * | mir_event_get_window_event (MirEvent const *event) |
Retrieve the MirWindowEvent associated with a MirEvent of type mir_event_type_window. More... | |
MirResizeEvent const * | mir_event_get_resize_event (MirEvent const *event) |
Retrieve the MirResizeEvent associated with a MirEvent of type mir_event_type_resize. More... | |
MirPromptSessionEvent const * | mir_event_get_prompt_session_event (MirEvent const *event) |
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 *event) |
Retrieve the MirOrientationEvent associated with a MirEvent of type mir_event_type_orientation. More... | |
MirCloseSurfaceEvent const * | mir_event_get_close_surface_event (MirEvent const *event) |
Retrieve the MirCloseSurfaceEvent associated with a MirEvent of type mir_event_type_close_surface. More... | |
MirKeymapEvent const * | mir_event_get_keymap_event (MirEvent const *event) |
Retrieve the MirKeymapEvent associated with a MirEvent of type mir_event_type_keymap. More... | |
MirInputConfigurationEvent const * | mir_event_get_input_configuration_event (MirEvent const *event) |
Retrieve the MirInputConfig associated with a MirEvent of type mir_event_type_input_configuration. More... | |
MirSurfaceOutputEvent const * | mir_event_get_surface_output_event (MirEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_output_event") |
Retrieve the MirSurfaceOutputEvent associated with a MirEvent of type mir_event_type_surface_output. More... | |
MirWindowOutputEvent const * | mir_event_get_window_output_event (MirEvent const *event) |
Retrieve the MirWindowOutputEvent associated with a MirEvent of type mir_event_type_window_output. More... | |
MirInputDeviceStateEvent const * | mir_event_get_input_device_state_event (MirEvent const *event) |
Retrieve the MirInputDeviceStateEvent associated with a MirEvent of type mir_event_type_input_device_state. More... | |
MirSurfacePlacementEvent const * | mir_event_get_surface_placement_event (MirEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_placement_event") |
Retrieve the MirSurfacePlacementEvent associated with a MirEvent of type mir_event_type_surface_placement. More... | |
MirWindowPlacementEvent const * | mir_event_get_window_placement_event (MirEvent const *event) |
Retrieve the MirWindowPlacementEvent associated with a MirEvent of type mir_event_type_window_placement. More... | |
MirEvent const * | mir_event_ref (MirEvent const *event) __attribute__((warn_unused_result)) |
Reference this MirEvent and return a pointer to the newly referenced instance. More... | |
void | mir_event_unref (MirEvent const *event) |
Release a reference to a MirEvent. More... | |
MirInputDeviceId | mir_input_event_get_device_id (MirInputEvent const *event) |
Retrieves the device id responsible for generating an input event. More... | |
int64_t | mir_input_event_get_event_time (MirInputEvent const *event) |
Retrieve the time at which an input event occurred. More... | |
MirInputEventType | mir_input_event_get_type (MirInputEvent const *event) |
Retrieve the type of an input event. More... | |
MirKeyboardEvent const * | mir_input_event_get_keyboard_event (MirInputEvent const *event) |
Retrieve the MirKeyboardEvent associated with a given input event. More... | |
MirTouchEvent const * | mir_input_event_get_touch_event (MirInputEvent const *event) |
Retrieve the MirTouchEvent associated with a given input event. More... | |
MirPointerEvent const * | mir_input_event_get_pointer_event (MirInputEvent const *event) |
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... | |
MirEvent const * | mir_input_event_get_event (MirInputEvent const *event) |
Retrieve the MirEvent associated with a given 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... | |
char const * | mir_keyboard_event_key_text (MirKeyboardEvent const *event) |
Retrieve the text the key press would emit as null terminated utf8 string. 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) MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback") |
Retrieve the input configuration action which occurred. More... | |
int64_t | mir_input_configuration_event_get_time (MirInputConfigurationEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback") |
Retreive the time associated with a MirInputConfiguration event. More... | |
MirInputDeviceId | mir_input_configuration_event_get_device_id (MirInputConfigurationEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback") |
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 | mir_input_device_state_event_device_pressed_keys_for_index (MirInputDeviceStateEvent const *ev, uint32_t index, uint32_t pressed_index) |
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 *rules) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_keymap_event_get_keymap_buffer() instead") |
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 *event) |
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 *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute instead") |
Retrieve the attribute index configured with a given MirSurfaceEvent. More... | |
int | mir_surface_event_get_attribute_value (MirSurfaceEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute_value with MirWindowEvent instead") |
Retrieve the new value of the associated attribute for a given MirSurfaceEvent. More... | |
int | mir_surface_output_event_get_dpi (MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_dpi instead") |
Retrieve the DPI of the new output configuration of a MirSurfaceOutputEvent. More... | |
MirFormFactor | mir_surface_output_event_get_form_factor (MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_form_factor instead") |
Retrieve the form factor of the new output configuration of a MirSurfaceOutputEvent. More... | |
float | mir_surface_output_event_get_scale (MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_scale instead") |
Retrieve the suggested scaling factor of the new output configuration of a MirSurfaceOutputEvent. More... | |
double | mir_surface_output_event_get_refresh_rate (MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_refresh_rate instead") |
Retrieve the maximum refresh rate of the output(s) associated with a MirSurfaceOutputEvent. More... | |
uint32_t | mir_surface_output_event_get_output_id (MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_output_id instead") |
Retrieve the ID of the output this surface is on from a MirSurfaceOutputEvent. More... | |
MirRectangle | mir_surface_placement_get_relative_position (MirSurfacePlacementEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_placement_get_relative_position instead") |
Retrieve the relative position from a placement notification. More... | |
MirWindowAttrib | mir_window_event_get_attribute (MirWindowEvent const *event) |
Retrieve the attribute index configured with a given MirWindowEvent. More... | |
int | mir_window_event_get_attribute_value (MirWindowEvent const *event) |
Retrieve the new value of the associated attribute for a given MirWindowEvent. More... | |
int | mir_window_output_event_get_dpi (MirWindowOutputEvent const *ev) |
Retrieve the DPI of the new output configuration of a MirWindowOutputEvent. More... | |
MirFormFactor | mir_window_output_event_get_form_factor (MirWindowOutputEvent const *ev) |
Retrieve the form factor of the new output configuration of a MirWindowOutputEvent. More... | |
float | mir_window_output_event_get_scale (MirWindowOutputEvent const *ev) |
Retrieve the suggested scaling factor of the new output configuration of a MirWindowOutputEvent. More... | |
double | mir_window_output_event_get_refresh_rate (MirWindowOutputEvent const *ev) |
Retrieve the maximum refresh rate of the output(s) associated with a MirWindowOutputEvent. More... | |
uint32_t | mir_window_output_event_get_output_id (MirWindowOutputEvent const *ev) |
Retrieve the ID of the output this window is on from a MirWindowOutputEvent. More... | |
MirRectangle | mir_window_placement_get_relative_position (MirWindowPlacementEvent const *event) |
Retrieve the relative position from a placement notification. More... | |
MirBlob * | mir_blob_from_display_configuration (MirDisplayConfiguration *configuration) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_blob_from_display_config instead") |
Create a blob from a display configuration. More... | |
MirBlob * | mir_blob_from_display_config (MirDisplayConfig *config) |
Create a blob from a display config. 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) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_blob_to_display_config instead") |
Create a blob from a display configuration. More... | |
MirDisplayConfig * | mir_blob_to_display_config (MirBlob *blob) |
Create a blob from a display config. 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... | |
void | mir_connection_allocate_buffer (MirConnection *connection, int width, int height, MirPixelFormat format, MirBufferCallback available_callback, void *available_context) |
Allocate a MirBuffer and do not wait for the server to return it. More... | |
MirBuffer * | mir_connection_allocate_buffer_sync (MirConnection *connection, int width, int height, MirPixelFormat format) |
Allocate a MirBuffer and wait for the server to return it. More... | |
bool | mir_buffer_is_valid (MirBuffer const *buffer) |
Test for a valid buffer. More... | |
char const * | mir_buffer_get_error_message (MirBuffer const *buffer) |
Retrieve a text description an error associated with a MirBuffer. More... | |
MirBufferPackage * | mir_buffer_get_buffer_package (MirBuffer *buffer) |
Access the MirBufferPackage. More... | |
bool | mir_buffer_map (MirBuffer *buffer, MirGraphicsRegion *region, MirBufferLayout *layout) |
Access a CPU-mapped region associated with a given buffer. More... | |
void | mir_buffer_unmap (MirBuffer *buffer) |
Flush the CPU caches for the buffer. More... | |
unsigned int | mir_buffer_get_width (MirBuffer const *buffer) |
Retrieve the width of the buffer in pixels. More... | |
unsigned int | mir_buffer_get_height (MirBuffer const *buffer) |
Retrieve the height of the buffer in pixels. More... | |
MirPixelFormat | mir_buffer_get_pixel_format (MirBuffer const *buffer) |
Retrieve the pixel format of the buffer. 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 *buffer_stream) |
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, MirBufferStreamCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_render_surface_get_buffer_stream instead") |
Create a new buffer stream. More... | |
MirBufferStream * | mir_connection_create_buffer_stream_sync (MirConnection *connection, int width, int height, MirPixelFormat format, MirBufferUsage buffer_usage) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_render_surface_get_buffer_stream instead") |
Create a new buffer stream unattached to a surface and wait for the result. More... | |
MirWaitHandle * | mir_buffer_stream_release (MirBufferStream *buffer_stream, MirBufferStreamCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("A stream obtained through mir_render_surface_get_buffer_stream() does not need to be released.") |
Release the supplied stream and any associated buffer. More... | |
void | mir_buffer_stream_release_sync (MirBufferStream *buffer_stream) MIR_FOR_REMOVAL_IN_VERSION_1("A stream obtained through mir_render_surface_get_buffer_stream() does not need to be released.") |
Release the specified buffer stream like in mir,_buffer_stream_release(), but also wait for the operation to complete. More... | |
MirPlatformType | mir_buffer_stream_get_platform_type (MirBufferStream *stream) MIR_FOR_REMOVAL_IN_VERSION_1("To identify the graphics platform use mir_connection_get_graphics_module(). \n" "To safely interpret the buffer contents use mir_buffer_stream_get_graphics_region()") |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_buffer_stream_get_current_buffer() may be understood. More... | |
void | mir_buffer_stream_get_current_buffer (MirBufferStream *buffer_stream, MirNativeBuffer **buffer_package) MIR_FOR_REMOVAL_IN_VERSION_1("Use platform specific buffer extensions instead") |
Retrieve the current buffer in "raw" representation. More... | |
MirWaitHandle * | mir_buffer_stream_swap_buffers (MirBufferStream *buffer_stream, MirBufferStreamCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("For non-blocking swaps use mir_buffer_stream_swap_buffers_sync with an interval of zero." " And a client API for manual vsync will soon be available.") |
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... | |
bool | 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) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirRenderSurface *as the window type") |
Retrieve a window type which may be used by EGL. More... | |
MirWaitHandle * | mir_buffer_stream_set_scale (MirBufferStream *buffer_stream, float scale) MIR_FOR_REMOVAL_IN_VERSION_1("Functionality replaced by the introduction of MirRenderSurface") |
Set the scale associated with all buffers in the stream. More... | |
void | mir_buffer_stream_set_scale_sync (MirBufferStream *buffer_stream, float scale) MIR_FOR_REMOVAL_IN_VERSION_1("Functionality replaced by the introduction of MirRenderSurface") |
Set the scale as in mir_buffer_stream_set_scale(), but also wait for the operation to complete. More... | |
MirWaitHandle * | mir_buffer_stream_set_swapinterval (MirBufferStream *stream, int interval) |
Set the swapinterval for the stream. More... | |
int | mir_buffer_stream_get_swapinterval (MirBufferStream *stream) |
Query the swapinterval that the stream is operating with. More... | |
unsigned long | mir_buffer_stream_get_microseconds_till_vblank (MirBufferStream const *stream) |
Query the approximate time interval in microseconds until the next vblank for a given buffer stream (actually the next vblank for the monitor deemed most relevant to the window using the buffer stream). More... | |
void | mir_buffer_stream_set_size (MirBufferStream *stream, int width, int height) |
Set the physical size of the buffers provided by the buffer stream. More... | |
void | mir_buffer_stream_get_size (MirBufferStream *stream, int *width, int *height) |
Get the physical size of the next buffer that will be provided by the stream. More... | |
MirWaitHandle * | mir_connect (char const *server, char const *app_name, MirConnectedCallback 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) MIR_FOR_REMOVAL_IN_VERSION_1("use platform extensions instead") |
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) MIR_FOR_REMOVAL_IN_VERSION_1("use graphics module extension instead") |
Query graphics platform module. More... | |
void | mir_connection_set_lifecycle_event_callback (MirConnection *connection, MirLifecycleEventCallback callback, void *context) |
Register a callback to be called when a Lifecycle state change occurs. More... | |
void | mir_connection_set_ping_event_callback (MirConnection *connection, MirPingEventCallback 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) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_create_display_configuration instead") |
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, MirDisplayConfigCallback callback, void *context) |
Register a callback to be called when the hardware display configuration changes. More... | |
void | mir_display_config_destroy (MirDisplayConfiguration *display_configuration) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_display_config_release instead") |
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config. More... | |
MirWaitHandle * | mir_connection_apply_display_config (MirConnection *connection, MirDisplayConfiguration *display_configuration) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_apply_session_display_config instead") |
Apply the display configuration. More... | |
void | mir_connection_apply_session_display_config (MirConnection *connection, MirDisplayConfig const *display_config) |
Apply the display config for the connection. More... | |
void | mir_connection_remove_session_display_config (MirConnection *connection) |
Remove the display configuration for the connection. More... | |
MirWaitHandle * | mir_connection_set_base_display_config (MirConnection *connection, MirDisplayConfiguration const *display_configuration) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_preview_base_display_configuration/mir_connection_confirm_base_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... | |
void | mir_connection_cancel_base_display_configuration_preview (MirConnection *connection) |
Cancel a pending base display configuration preview. More... | |
MirEGLNativeDisplayType | mir_connection_get_egl_native_display (MirConnection *connection) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirConnection * as the native display instead") |
Get a display type that can be used with EGL. More... | |
MirPixelFormat | mir_connection_get_egl_pixel_format (MirConnection *connection, void *egldisplay, void *eglconfig) MIR_FOR_REMOVAL_IN_VERSION_1("Use EGL directly |
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 formats_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, MirPlatformOperationCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use platform specific extensions instead") |
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_connection_apply_session_input_config (MirConnection *connection, MirInputConfig const *config) |
Apply the input configuration for the connection. More... | |
void | mir_connection_set_base_input_config (MirConnection *connection, MirInputConfig const *config) |
Set the input configuration as base configuration. More... | |
void | mir_input_config_destroy (MirInputConfig const *config) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_input_config_release instead") |
void | mir_input_config_release (MirInputConfig const *config) |
Release this snapshot of the input configuration. More... | |
void | mir_connection_set_input_config_change_callback (MirConnection *connection, MirInputConfigCallback callback, void *context) |
Register a callback to be called when the input devices change. More... | |
void | mir_connection_set_error_callback (MirConnection *connection, MirErrorCallback callback, void *context) |
Register a callback to be called on non-fatal errors. More... | |
unsigned | mir_get_client_api_version () |
Returns client API version. More... | |
void | mir_connection_enumerate_extensions (MirConnection *connection, void *context, void(*enumerator)(void *context, char const *extension, int version)) |
Enumerates the supported extensions. 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) MIR_FOR_REMOVAL_IN_VERSION_1("MirCursorConfiguration is deprecated") |
Release resources assosciated with cursor parameters. More... | |
MirCursorConfiguration * | mir_cursor_configuration_from_name (char const *name) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_cursor_name() instead") |
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) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_cursor_render_surface instead") |
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) MIR_FOR_REMOVAL_IN_VERSION_1("Not accurate in Mir 0.26 and later. May be removed in future.") |
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... | |
size_t | mir_output_get_preferred_mode_index (MirOutput const *output) |
Get the index of 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... | |
size_t | mir_output_get_current_mode_index (MirOutput const *output) |
Get the index of 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... | |
char const * | mir_display_output_type_name (MirDisplayOutputType type) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_output_type_name instead") |
Get the textual name of an output type. More... | |
char const * | mir_output_type_name (MirOutputType type) |
Get the textual name of an output type. 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... | |
unsigned int | mir_output_get_logical_width (MirOutput const *output) |
Get the width of the virtual display space occupied by an output. More... | |
unsigned int | mir_output_get_logical_height (MirOutput const *output) |
Get the height of the virtual display space occupied by an output. More... | |
void | mir_output_set_logical_size (MirOutput *output, unsigned w, unsigned h) |
Set the logical size of the virtual display space occupied by an output. More... | |
bool | mir_output_has_custom_logical_size (MirOutput const *output) |
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... | |
char const * | mir_output_get_model (MirOutput const *output) |
Get a descriptive manufacturer/model string for the connected display. 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... | |
MirSubpixelArrangement | mir_output_get_subpixel_arrangement (MirOutput const *output) |
Get the subpixel arrangement of a display. More... | |
MirFormFactor | mir_output_get_form_factor (MirOutput const *output) |
Get the form-factor of a connected output. More... | |
bool | mir_output_is_gamma_supported (MirOutput const *output) |
Gets if the platform supports gamma correction. More... | |
uint32_t | mir_output_get_gamma_size (MirOutput const *output) |
Gets the gamma size. More... | |
void | mir_output_get_gamma (MirOutput const *output, uint16_t *red, uint16_t *green, uint16_t *blue, uint32_t size) |
Get the gamma ramp of a display. More... | |
void | mir_output_set_gamma (MirOutput *output, uint16_t const *red, uint16_t const *green, uint16_t const *blue, uint32_t size) |
Set the gamma ramp of a display. More... | |
void | mir_output_set_scale_factor (MirOutput *output, float scale) |
Set the scale-factor of a display. More... | |
uint8_t const * | mir_output_get_edid (MirOutput const *output) |
Get the raw EDID data of a display. More... | |
size_t | mir_output_get_edid_size (MirOutput const *output) |
Get the size of the EDID of this display. 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... | |
MirKeyboardConfig const * | mir_input_device_get_keyboard_config (MirInputDevice const *device) |
Retrieve a structure containing the keyboard related config options of the input device. More... | |
char const * | mir_keyboard_config_get_keymap_model (MirKeyboardConfig const *conf) |
Retrieve the keyboard model of the keymap as a null terminated string. More... | |
char const * | mir_keyboard_config_get_keymap_layout (MirKeyboardConfig const *conf) |
Retrieve the layout of the keymap as a null terminated string. More... | |
char const * | mir_keyboard_config_get_keymap_variant (MirKeyboardConfig const *conf) |
Retrieve the layout of the keymap as a null terminated string. More... | |
char const * | mir_keyboard_config_get_keymap_options (MirKeyboardConfig const *conf) |
Retrieve the options of the keymap as a null terminated string. More... | |
MirKeyboardConfig * | mir_input_device_get_mutable_keyboard_config (MirInputDevice *device) |
Retrieve a mutable structure containing the keyboard related config options of the input device. More... | |
void | mir_keyboard_config_set_keymap_model (MirKeyboardConfig *conf, char const *model) |
Set the keyboard model of the keymap as a null terminated string. More... | |
void | mir_keyboard_config_set_keymap_layout (MirKeyboardConfig *conf, char const *layout) |
Set the layout of the keymap as a null terminated string. More... | |
void | mir_keyboard_config_set_keymap_options (MirKeyboardConfig *conf, char const *options) |
Set the options of the keymap as a null terminated string. More... | |
void | mir_keyboard_config_set_keymap_variant (MirKeyboardConfig *conf, char const *variant) |
Set the variant of the keymap as a null terminated string. More... | |
MirPointerConfig const * | mir_input_device_get_pointer_config (MirInputDevice const *device) |
Retrieve a structure containing the pointer related config options of the input device. More... | |
MirPointerAcceleration | mir_pointer_config_get_acceleration (MirPointerConfig const *conf) |
Retrieve the cursor acceleration profile. More... | |
double | mir_pointer_config_get_acceleration_bias (MirPointerConfig const *conf) |
Retrieve the cursor acceleration bias. More... | |
double | mir_pointer_config_get_horizontal_scroll_scale (MirPointerConfig const *conf) |
Retrieve the horizontal scroll scale. More... | |
double | mir_pointer_config_get_vertical_scroll_scale (MirPointerConfig const *conf) |
Retrieve the vertical scroll scale. More... | |
MirPointerHandedness | mir_pointer_config_get_handedness (MirPointerConfig const *conf) |
Retrieve whether the pointer device is configured for right or left handed use. More... | |
MirPointerConfig * | mir_input_device_get_mutable_pointer_config (MirInputDevice *device) |
Retrieve a structure containing the pointer related config options of the input device that can be manipulated. More... | |
void | mir_pointer_config_set_acceleration (MirPointerConfig *conf, MirPointerAcceleration acceleration) |
Set the acceleration mode of the pointer device. More... | |
void | mir_pointer_config_set_acceleration_bias (MirPointerConfig *conf, double acceleration_bias) |
Set the acceleration bias of the pointer device. More... | |
void | mir_pointer_config_set_horizontal_scroll_scale (MirPointerConfig *conf, double horizontal_scroll_scale) |
Set the horizontal scroll scale. More... | |
void | mir_pointer_config_set_vertical_scroll_scale (MirPointerConfig *conf, double vertical_scroll_scale) |
Set the vertical scroll scale. More... | |
void | mir_pointer_config_set_handedness (MirPointerConfig *conf, MirPointerHandedness handedness) |
Configure left and right hand use of the pointer device. More... | |
MirTouchpadConfig const * | mir_input_device_get_touchpad_config (MirInputDevice const *device) |
Retrieve a structure containing the touchpad related config options of the input device. More... | |
MirTouchpadClickModes | mir_touchpad_config_get_click_modes (MirTouchpadConfig const *conf) |
Retrieve the click modes of the touchpad. More... | |
MirTouchpadScrollModes | mir_touchpad_config_get_scroll_modes (MirTouchpadConfig const *conf) |
Retrieve the scroll modes of the touchpad. More... | |
int | mir_touchpad_config_get_button_down_scroll_button (MirTouchpadConfig const *conf) |
Retrieve the configured button down for button down scroll mode. More... | |
bool | mir_touchpad_config_get_tap_to_click (MirTouchpadConfig const *conf) |
Retrieve whether a tap gesture generates pointer button events. More... | |
bool | mir_touchpad_config_get_middle_mouse_button_emulation (MirTouchpadConfig const *conf) |
Retrieve whether middle mouse button should be emulated. More... | |
bool | mir_touchpad_config_get_disable_with_mouse (MirTouchpadConfig const *conf) |
Retrieve whether the touchpad should be disabled when an external pointer device like a mouse is connected. More... | |
bool | mir_touchpad_config_get_disable_while_typing (MirTouchpadConfig const *conf) |
Retrieve whether the touchpad events should be blocked while the user types. More... | |
MirTouchpadConfig * | mir_input_device_get_mutable_touchpad_config (MirInputDevice *device) |
Retrieve a structure containing the touchpad related config options of the input device that can be manipulated. More... | |
void | mir_touchpad_config_set_click_modes (MirTouchpadConfig *conf, MirTouchpadClickModes modes) |
Configure the enable click modes for the touchpad. More... | |
void | mir_touchpad_config_set_scroll_modes (MirTouchpadConfig *conf, MirTouchpadScrollModes modes) |
Configure the enabled scroll modes for the touchpad. More... | |
void | mir_touchpad_config_set_button_down_scroll_button (MirTouchpadConfig *conf, int button) |
Configure the button for button down scroll mode. More... | |
void | mir_touchpad_config_set_tap_to_click (MirTouchpadConfig *conf, bool tap_to_click) |
Configure whether tap to click should be enabled. More... | |
void | mir_touchpad_config_set_middle_mouse_button_emulation (MirTouchpadConfig *conf, bool middle_emulation) |
Configure whether middle mouse button emulation should be enabled. More... | |
void | mir_touchpad_config_set_disable_with_mouse (MirTouchpadConfig *conf, bool active) |
Configure whether the touchpad should be turned off while a mouse is attached. More... | |
void | mir_touchpad_config_set_disable_while_typing (MirTouchpadConfig *conf, bool active) |
Configure whether the touchpad should be turned off while typing. More... | |
MirTouchscreenConfig const * | mir_input_device_get_touchscreen_config (MirInputDevice const *device) |
Retrieve a structure containing the touchscreen related config options of the input device. More... | |
uint32_t | mir_touchscreen_config_get_output_id (MirTouchscreenConfig const *device) |
Get the output ID of the display the coordinates of this device will be mapped to. More... | |
enum MirTouchscreenMappingMode | mir_touchscreen_config_get_mapping_mode (MirTouchscreenConfig const *device) |
Get the mapping mode used for the touchscreen. More... | |
MirTouchscreenConfig * | mir_input_device_get_mutable_touchscreen_config (MirInputDevice *device) |
Retrieve a mutable structure containing the touchscreen related options of the input device to change the device configuration. More... | |
void | mir_touchscreen_config_set_output_id (MirTouchscreenConfig *config, uint32_t output) |
Set the output ID of the display the coordinates of this device will be mapped to. More... | |
void | mir_touchscreen_config_set_mapping_mode (MirTouchscreenConfig *config, enum MirTouchscreenMappingMode mode) |
Set the mapping mode used for the touchscreen. More... | |
bool | mir_persistent_id_is_valid (MirPersistentId *id) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_is_valid() instead") |
Check the validity of a MirPersistentId. More... | |
void | mir_persistent_id_release (MirPersistentId *id) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_release() instead") |
Free a MirPersistentId. More... | |
char const * | mir_persistent_id_as_string (MirPersistentId *id) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_as_string() instead") |
Get a string representation of a MirSurfaceId. More... | |
MirPersistentId * | mir_persistent_id_from_string (char const *string_representation) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_from_string() instead") |
Deserialise a string representation of a MirSurfaceId. 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... | |
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_presentation_chain_submit_buffer (MirPresentationChain *presentation_chain, MirBuffer *buffer, MirBufferCallback available_callback, void *available_context) |
Submit a buffer to the server so the server can display it. More... | |
MirPromptSession * | mir_connection_create_prompt_session_sync (MirConnection *connection, pid_t application_pid, MirPromptSessionStateChangeCallback 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, MirClientFdCallback callback, void *context) |
Allocate some FDs for prompt providers to connect on. More... | |
size_t | mir_prompt_session_new_fds_for_prompt_providers_sync (MirPromptSession *prompt_session, unsigned int no_of_fds, int *fds) |
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) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_screencast_create_sync instead") |
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... | |
void | mir_screencast_capture_to_buffer (MirScreencast *screencast, MirBuffer *buffer, MirScreencastBufferCallback available_callback, void *available_context) |
Capture the contents of the screen to a particular buffer. More... | |
MirScreencastResult | mir_screencast_capture_to_buffer_sync (MirScreencast *screencast, MirBuffer *buffer) |
Capture the contents of the screen to a particular buffer and wait for the capture to complete. More... | |
MirSurfaceSpec * | mir_connection_create_spec_for_normal_surface (MirConnection *connection, int width, int height, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_normal_window_spec() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_menu (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_specify_menu() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_tooltip (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *zone) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_tip_window_spec() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_tip (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_tip_window_spec() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_modal_dialog (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_modal_dialog_window_spec() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_dialog (MirConnection *connection, int width, int height, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_dialog_window_spec() instead") |
MirSurfaceSpec * | mir_create_surface_spec (MirConnection *connection) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_window_spec() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_changes (MirConnection *connection) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_window_spec() instead") |
void | mir_surface_spec_set_parent (MirSurfaceSpec *spec, MirSurface *parent) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_parent() instead") |
int | mir_surface_get_swapinterval (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("This will soon be a property of the backing content") |
void | mir_surface_spec_set_type (MirSurfaceSpec *spec, MirSurfaceType type) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_type() instead") |
void | mir_surface_spec_set_name (MirSurfaceSpec *spec, char const *name) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_name() instead") |
void | mir_surface_spec_set_width (MirSurfaceSpec *spec, unsigned width) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_width() instead") |
void | mir_surface_spec_set_height (MirSurfaceSpec *spec, unsigned height) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_height() instead") |
void | mir_surface_spec_set_width_increment (MirSurfaceSpec *spec, unsigned width_inc) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_width_increment() instead") |
void | mir_surface_spec_set_height_increment (MirSurfaceSpec *spec, unsigned height_inc) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_height_increment() instead") |
void | mir_surface_spec_set_min_width (MirSurfaceSpec *spec, unsigned min_width) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_width() instead") |
void | mir_surface_spec_set_min_height (MirSurfaceSpec *spec, unsigned min_height) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_height() instead") |
void | mir_surface_spec_set_max_width (MirSurfaceSpec *spec, unsigned max_width) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_width() instead") |
void | mir_surface_spec_set_max_height (MirSurfaceSpec *spec, unsigned max_height) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_height() instead") |
void | mir_surface_spec_set_min_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_aspect_ratio() instead") |
void | mir_surface_spec_set_max_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_aspect_ratio() instead") |
void | mir_surface_spec_set_fullscreen_on_output (MirSurfaceSpec *spec, uint32_t output_id) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_fullscreen_on_output() instead") |
void | mir_surface_spec_set_preferred_orientation (MirSurfaceSpec *spec, MirOrientationMode mode) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_preferred_orientation() instead") |
bool | mir_surface_spec_attach_to_foreign_parent (MirSurfaceSpec *spec, MirPersistentId *parent, MirRectangle *attachment_rect, MirEdgeAttachment edge) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_attach_to_foreign_parent() instead") |
void | mir_surface_spec_set_state (MirSurfaceSpec *spec, MirSurfaceState state) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_state() instead") |
void | mir_surface_spec_release (MirSurfaceSpec *spec) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_release() instead") |
void | mir_surface_spec_set_input_shape (MirSurfaceSpec *spec, MirRectangle const *rectangles, size_t n_rects) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_input_shape() instead") |
void | mir_surface_spec_set_event_handler (MirSurfaceSpec *spec, mir_surface_event_callback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_event_handler() instead") |
void | mir_surface_spec_set_shell_chrome (MirSurfaceSpec *spec, MirShellChrome style) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_shell_chrome() instead") |
void | mir_surface_spec_set_pointer_confinement (MirSurfaceSpec *spec, MirPointerConfinementState state) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_pointer_confinement() instead") |
void | mir_surface_spec_set_placement (MirSurfaceSpec *spec, const MirRectangle *rect, MirPlacementGravity rect_gravity, MirPlacementGravity window_gravity, MirPlacementHints placement_hints, int offset_dx, int offset_dy) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_placement() instead") |
MirSurfaceSpec * | mir_connection_create_spec_for_input_method (MirConnection *connection, int width, int height, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_input_method_window_spec() instead") |
void | mir_surface_spec_set_pixel_format (MirSurfaceSpec *spec, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_pixel_format() instead") |
void | mir_surface_spec_set_buffer_usage (MirSurfaceSpec *spec, MirBufferUsage usage) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_buffer_usage() instead") |
void | mir_surface_spec_set_streams (MirSurfaceSpec *spec, MirBufferStreamInfo *streams, unsigned int num_streams) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_streams() instead") |
void | mir_surface_apply_spec (MirSurface *surface, MirSurfaceSpec *spec) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_apply_spec() instead") |
bool | mir_surface_is_valid (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_is_valid() instead") |
MirWaitHandle * | mir_surface_create (MirSurfaceSpec *requested_specification, mir_surface_callback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_window() instead") |
MirSurface * | mir_surface_create_sync (MirSurfaceSpec *requested_specification) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_window_sync() instead") |
MirWaitHandle * | mir_surface_release (MirSurface *surface, mir_surface_callback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_release() instead") |
void | mir_surface_release_sync (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_release_sync() instead") |
void | mir_surface_set_event_handler (MirSurface *surface, mir_surface_event_callback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_event_handler() instead") |
MirBufferStream * | mir_surface_get_buffer_stream (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_buffer_stream() instead") |
char const * | mir_surface_get_error_message (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_error_message() instead") |
void | mir_surface_get_parameters (MirSurface *surface, MirSurfaceParameters *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_parameters() instead") |
MirSurfaceType | mir_surface_get_type (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_type() instead") |
MirWaitHandle * | mir_surface_set_state (MirSurface *surface, MirSurfaceState state) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_state() instead") |
MirSurfaceState | mir_surface_get_state (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_state() instead") |
MirWaitHandle * | mir_surface_set_swapinterval (MirSurface *surface, int interval) MIR_FOR_REMOVAL_IN_VERSION_1("Swap interval should be set on the backing content") |
Set the swapinterval for the default stream. More... | |
int | mir_surface_get_dpi (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_dpi() instead") |
MirSurfaceFocusState | mir_surface_get_focus (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_focus_state() instead") |
MirSurfaceVisibility | mir_surface_get_visibility (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_visibility() instead") |
MirWaitHandle * | mir_surface_configure_cursor (MirSurface *surface, MirCursorConfiguration const *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_configure_cursor() instead") |
MirOrientation | mir_surface_get_orientation (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_orientation() instead") |
MirWaitHandle * | mir_surface_set_preferred_orientation (MirSurface *surface, MirOrientationMode orientation) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_preferred_orientation() instead") |
MirOrientationMode | mir_surface_get_preferred_orientation (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_preferred_orientation() instead") |
MirWaitHandle * | mir_surface_request_persistent_id (MirSurface *surface, mir_surface_id_callback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_request_persistent_id() instead") |
MirPersistentId * | mir_surface_request_persistent_id_sync (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_request_persistent_id_sync() instead") |
void | mir_surface_raise (MirSurface *surface, MirCookie const *cookie) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_raise() instead") |
void | mir_wait_for (MirWaitHandle *wait_handle) MIR_FOR_REMOVAL_IN_VERSION_1("No longer supported - use callbacks or wait for state changes") |
Wait on the supplied handle until all instances of the associated request have completed. More... | |
void | mir_wait_for_one (MirWaitHandle *wait_handle) MIR_FOR_REMOVAL_IN_VERSION_1("No longer supported - use callbacks or wait for state changes") |
Wait on the supplied handle until one instance of the associated request has completed. More... | |
MirWindowSpec * | mir_create_normal_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for a normal window. More... | |
MirWindowSpec * | mir_create_menu_window_spec (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge) |
Create a window specification for a menu window. More... | |
MirWindowSpec * | mir_create_tip_window_spec (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge) |
Create a window specification for a tip window. More... | |
MirWindowSpec * | mir_create_modal_dialog_window_spec (MirConnection *connection, int width, int height, MirWindow *parent) |
Create a window specification for a modal dialog window. More... | |
MirWindowSpec * | mir_create_dialog_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for a parentless dialog window. More... | |
MirWindowSpec * | mir_create_input_method_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for an input method window. More... | |
MirWindowSpec * | mir_create_gloss_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for a gloss window. More... | |
MirWindowSpec * | mir_create_satellite_window_spec (MirConnection *connection, int width, int height, MirWindow *parent) |
Create a window specification for a satellite window. More... | |
MirWindowSpec * | mir_create_utility_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for a utility window. More... | |
MirWindowSpec * | mir_create_freestyle_window_spec (MirConnection *connection, int width, int height) |
Create a window specification for a freestyle window. More... | |
MirWindowSpec * | mir_create_window_spec (MirConnection *connection) |
Create a window specification. More... | |
MirConnection * | mir_window_get_connection (MirWindow *window) |
Retrieve the connection. More... | |
void | mir_window_spec_set_parent (MirWindowSpec *spec, MirWindow *parent) |
Set the requested parent. More... | |
void | mir_window_spec_set_type (MirWindowSpec *spec, MirWindowType type) |
Update a window specification with a window type. More... | |
void | mir_window_spec_set_name (MirWindowSpec *spec, char const *name) |
Set the requested name. More... | |
void | mir_window_spec_set_width (MirWindowSpec *spec, unsigned width) |
Set the requested width, in pixels. More... | |
void | mir_window_spec_set_height (MirWindowSpec *spec, unsigned height) |
Set the requested height, in pixels. More... | |
void | mir_window_spec_set_width_increment (MirWindowSpec *spec, unsigned width_inc) |
Set the requested width increment, in pixels. More... | |
void | mir_window_spec_set_height_increment (MirWindowSpec *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 window prefers to be resized. More... | |
void | mir_window_spec_set_min_width (MirWindowSpec *spec, unsigned min_width) |
Set the minimum width, in pixels. More... | |
void | mir_window_spec_set_min_height (MirWindowSpec *spec, unsigned min_height) |
Set the minimum height, in pixels. More... | |
void | mir_window_spec_set_max_width (MirWindowSpec *spec, unsigned max_width) |
Set the maximum width, in pixels. More... | |
void | mir_window_spec_set_max_height (MirWindowSpec *spec, unsigned max_height) |
Set the maximum height, in pixels. More... | |
void | mir_window_spec_set_min_aspect_ratio (MirWindowSpec *spec, unsigned width, unsigned height) |
Set the minimum aspect ratio. More... | |
void | mir_window_spec_set_max_aspect_ratio (MirWindowSpec *spec, unsigned width, unsigned height) |
Set the maximum aspect ratio. More... | |
void | mir_window_spec_set_fullscreen_on_output (MirWindowSpec *spec, uint32_t output_id) |
void | mir_window_spec_set_preferred_orientation (MirWindowSpec *spec, MirOrientationMode mode) |
Set the requested preferred orientation mode. More... | |
bool | mir_window_spec_attach_to_foreign_parent (MirWindowSpec *spec, MirWindowId *parent, MirRectangle *attachment_rect, MirEdgeAttachment edge) |
Request that the created window be attached to a window of a different client. More... | |
void | mir_window_spec_set_state (MirWindowSpec *spec, MirWindowState state) |
Set the requested state. More... | |
void | mir_window_spec_set_input_shape (MirWindowSpec *spec, MirRectangle const *rectangles, size_t n_rects) |
Set a collection of input rectangles associated with the spec. More... | |
void | mir_window_spec_set_event_handler (MirWindowSpec *spec, MirWindowEventCallback callback, void *context) |
Set the event handler to be called when events arrive for a window. More... | |
void | mir_window_spec_set_shell_chrome (MirWindowSpec *spec, MirShellChrome style) |
Ask the shell to customize "chrome" for this window. More... | |
void | mir_window_spec_set_pointer_confinement (MirWindowSpec *spec, MirPointerConfinementState state) |
Attempts to set the pointer confinement spec for this window. More... | |
void | mir_window_spec_set_placement (MirWindowSpec *spec, const MirRectangle *rect, MirPlacementGravity rect_gravity, MirPlacementGravity window_gravity, MirPlacementHints placement_hints, int offset_dx, int offset_dy) |
Set the window placement on the spec. More... | |
void | mir_window_spec_set_cursor_name (MirWindowSpec *spec, char const *name) |
Set the name for the cursor from the system cursor theme. More... | |
void | mir_window_spec_set_pixel_format (MirWindowSpec *spec, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_connection_allocate_buffer/mir_render_surface_get_buffer_stream instead") |
Set the requested pixel format. More... | |
void | mir_window_spec_set_buffer_usage (MirWindowSpec *spec, MirBufferUsage usage) MIR_FOR_REMOVAL_IN_VERSION_1("No longer applicable |
void | mir_window_spec_set_streams (MirWindowSpec *spec, MirBufferStreamInfo *streams, unsigned int num_streams) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_add_render_surface instead") |
Set the streams associated with the spec. More... | |
void | mir_window_spec_release (MirWindowSpec *spec) |
Release the resources held by a MirWindowSpec. More... | |
void | mir_window_apply_spec (MirWindow *window, MirWindowSpec *spec) |
Request changes to the specification of a window. More... | |
void | mir_create_window (MirWindowSpec *requested_specification, MirWindowCallback callback, void *context) |
Create a window from a given specification. More... | |
MirWindow * | mir_create_window_sync (MirWindowSpec *requested_specification) |
Create a window from a given specification and wait for the result. More... | |
void | mir_window_release (MirWindow *window, MirWindowCallback callback, void *context) |
Release the supplied window and any associated buffer. More... | |
void | mir_window_release_sync (MirWindow *window) |
Release the specified window like in mir_window_release(), but also wait for the operation to complete. More... | |
bool | mir_window_is_valid (MirWindow *window) |
Test for a valid window. More... | |
void | mir_window_set_event_handler (MirWindow *window, MirWindowEventCallback callback, void *context) |
Set the event handler to be called when events arrive for a window. More... | |
MirBufferStream * | mir_window_get_buffer_stream (MirWindow *window) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_add_render_surface during window creation/modification instead") |
Retrieve the primary MirBufferStream associated with a window (to advance buffers, obtain EGLNativeWindow, etc...) More... | |
char const * | mir_window_get_error_message (MirWindow *window) |
Retrieve a text description of the error. More... | |
void | mir_window_get_parameters (MirWindow *window, MirWindowParameters *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_get_xxx apis or listen to state/attribute change events instead") |
Get a window's parameters. More... | |
MirOrientation | mir_window_get_orientation (MirWindow *window) |
Get the orientation of a window. More... | |
void | mir_window_raise (MirWindow *window, MirCookie const *cookie) |
Attempts to raise the window to the front. More... | |
void | mir_window_request_user_move (MirWindow *window, MirCookie const *cookie) |
Informs the window manager that the user is moving the window. More... | |
void | mir_window_request_user_resize (MirWindow *window, MirResizeEdge edge, MirCookie const *cookie) |
Informs the window manager that the user is resizing the window. More... | |
MirWindowType | mir_window_get_type (MirWindow *window) |
Get the type (purpose) of a window. More... | |
void | mir_window_set_state (MirWindow *window, MirWindowState state) |
Change the state of a window. More... | |
MirWindowState | mir_window_get_state (MirWindow *window) |
Get the current state of a window. More... | |
MirWindowFocusState | mir_window_get_focus_state (MirWindow *window) |
Query the focus state for a window. More... | |
MirWindowVisibility | mir_window_get_visibility (MirWindow *window) |
Query the visibility state for a window. More... | |
int | mir_window_get_dpi (MirWindow *window) |
Query the DPI value of the window (dots per inch). More... | |
void | mir_window_configure_cursor (MirWindow *window, MirCursorConfiguration const *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_cursor_name/mir_window_spec_set_cursor_render_surface instead") |
Choose the cursor state for a window: whether a cursor is shown, and which cursor if so. More... | |
void | mir_window_set_preferred_orientation (MirWindow *window, MirOrientationMode orientation) |
Request to set the preferred orientations of a window. More... | |
MirOrientationMode | mir_window_get_preferred_orientation (MirWindow *window) |
Get the preferred orientation modes of a window. More... | |
void | mir_window_request_persistent_id (MirWindow *window, MirWindowIdCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id() instead") |
Request an ID for the window that can be shared cross-process and across restarts. More... | |
void | mir_window_request_window_id (MirWindow *window, MirWindowIdCallback callback, void *context) |
MirPersistentId * | mir_window_request_persistent_id_sync (MirWindow *window) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id_sync") |
Request a persistent ID for a window and wait for the result. More... | |
MirWindowId * | mir_window_request_window_id_sync (MirWindow *window) |
bool | mir_window_id_is_valid (MirWindowId *id) |
Check the validity of a MirWindowId. More... | |
void | mir_window_id_release (MirWindowId *id) |
Free a MirWindowId. More... | |
char const * | mir_window_id_as_string (MirWindowId *id) |
Get a string representation of a MirSurfaceId. More... | |
MirWindowId * | mir_window_id_from_string (char const *string_representation) |
Deserialise a string representation of a MirSurfaceId. More... | |
void | mir_connection_create_render_surface (MirConnection *connection, int width, int height, MirRenderSurfaceCallback callback, void *context) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Create a render surface. More... | |
MirRenderSurface * | mir_connection_create_render_surface_sync (MirConnection *connection, int width, int height) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Create a render surface and wait for the result. More... | |
void | mir_render_surface_get_size (MirRenderSurface *render_surface, int *width, int *height) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Get the size of the MirRenderSurface. More... | |
void | mir_render_surface_set_size (MirRenderSurface *render_surface, int width, int height) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Set the size of the MirRenderSurface. More... | |
bool | mir_render_surface_is_valid (MirRenderSurface *render_surface) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Test for a valid render surface. More... | |
char const * | mir_render_surface_get_error_message (MirRenderSurface *render_surface) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Retrieve a text description of the error. More... | |
void | mir_render_surface_release (MirRenderSurface *render_surface) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Release the specified render surface. More... | |
MirBufferStream * | mir_render_surface_get_buffer_stream (MirRenderSurface *render_surface, int width, int height, MirPixelFormat format) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Obtain the buffer stream backing a given render surface. More... | |
MirPresentationChain * | mir_render_surface_get_presentation_chain (MirRenderSurface *render_surface) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Obtain the presentation chain backing a given render surface. More... | |
bool | mir_connection_present_mode_supported (MirConnection *connection, MirPresentMode mode) |
Query whether the server supports a given presentation mode. More... | |
void | mir_presentation_chain_set_mode (MirPresentationChain *chain, MirPresentMode mode) |
Respecify the submission mode that the MirPresentationChain is operating with. More... | |
void | mir_window_spec_set_cursor_render_surface (MirWindowSpec *spec, MirRenderSurface *render_surface, int hotspot_x, int hotspot_y) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Set the MirWindowSpec to contain a specific cursor. More... | |
MirCursorConfiguration * | mir_cursor_configuration_from_render_surface (MirRenderSurface *surface, int hotspot_x, int hotspot_y) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Returns a new cursor configuration tied to a given render surface. More... | |
void | mir_window_spec_add_render_surface (MirWindowSpec *spec, MirRenderSurface *render_surface, int logical_width, int logical_height, int displacement_x, int displacement_y) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
Set the MirWindowSpec to display content contained in a render surface. 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 resizing a top right corner. More... | |
char const *const | mir_diagonal_resize_top_to_bottom_cursor_name |
The cursor used to indicate diagonal resizing a bottom right corner. 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... | |
MirPixelFormat the EGL implementation will now set correct pixel | format |
void use mir_render_surface | apis |
#define MIR_BYTES_PER_PIXEL | ( | f | ) |
#define MIR_CLIENT_API_VERSION |
The current version of the Mir client headers in use.
For example, to test for a feature introduced in Mir version 1.2.3 you would write: #if defined(MIR_CLIENT_API_VERSION) && \ MIR_CLIENT_API_VERSION >= MIR_VERSION_NUMBER(1,2,3)
#define MIR_CLIENT_API_VERSION_MAJOR (1) |
#define MIR_CLIENT_API_VERSION_MINOR (7) |
#define MIR_CLIENT_API_VERSION_PATCH (2) |
#define MIR_CLIENT_MAJOR_VERSION (3) |
#define MIR_CLIENT_MICRO_VERSION (0) |
#define MIR_CLIENT_MINOR_VERSION (5) |
#define MIR_CLIENT_VERSION |
typedef MirSurfaceParameters MirWindowParameters MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_get_xxx apis or listen for attribute events instead") |
typedef void(* mir_surface_callback) (MirSurface *surface, void *client_context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowCallback instead") |
typedef void(* mir_surface_event_callback) (MirSurface *surface, MirEvent const *event, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowEventCallback instead") |
typedef void(* mir_surface_id_callback) (MirSurface *surface, MirPersistentId *id, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowIdCallback instead") |
typedef void(* MirBufferCallback) (MirBuffer *, void *context) |
typedef enum MirBufferLayout MirBufferLayout |
typedef struct MirBufferStream MirBufferStream |
typedef void(* MirBufferStreamCallback) (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 struct MirBufferStreamInfo MirBufferStreamInfo |
The displacement from the top-left corner of the surface.
typedef void(* MirClientFdCallback) (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 struct MirCloseSurfaceEvent MirCloseWindowEvent |
typedef void(* MirConnectedCallback) (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 struct MirConnection MirConnection |
typedef enum MirDepthLayer MirDepthLayer |
Depth layer controls Z ordering of surfaces.
A surface will always appear on top of surfaces with a lower depth layer, and below those with a higher one. A depth layer can be converted to a number with mir::mir_depth_layer_get_index(). This is useful for creating a list indexed by depth layer, or comparing the height of two layers.
typedef struct MirDisplayCard MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment.
typedef struct MirDisplayConfig MirDisplayConfig |
typedef void(* MirDisplayConfigCallback) (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 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 void(* MirErrorCallback) (MirConnection *connection, MirError const *error, void *context) |
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 MirWindow.
This is most useful for learning how and where to write to a 'mir_buffer_usage_software' surface.
typedef struct MirInputConfig MirInputConfig |
typedef void(* MirInputConfigCallback) (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 enum MirInputConfigurationError MirInputConfigurationError |
Errors from the mir_error_domain_input_configuration MirErrorDomain.
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 MirKeyboardConfig MirKeyboardConfig |
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 void(* MirLifecycleEventCallback) (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 enum MirLifecycleState MirLifecycleState |
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 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 enum MirOutputGammaSupported MirOutputGammaSupported |
Supports gamma correction.
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 void(* MirPingEventCallback) (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 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 enum MirPlacementGravity MirPlacementGravity |
Reference point for aligning a surface relative to a rectangle.
Each element (surface and rectangle) has a MirPlacementGravity assigned.
typedef enum MirPlacementHints MirPlacementHints |
Positioning hints for aligning a window relative to a rectangle.
These hints determine how the window should be positioned in the case that the surface would fall off-screen if placed in its ideal position.
For example, mir_placement_hints_flip_x
will invert the x component of aux_rect_placement_offset
and replace mir_placement_gravity_northwest
with mir_placement_gravity_northeast
and vice versa if the window extends beyond the left or right edges of the monitor.
If mir_placement_hints_slide_x
is set, the window can be shifted horizontally to fit on-screen.
If mir_placement_hints_resize_x
is set, the window can be shrunken horizontally to fit.
If mir_placement_hints_antipodes
is set then the rect gravity may be substituted with the opposite corner (e.g. mir_placement_gravity_northeast
to mir_placement_gravity_southwest
) in combination with other options.
When multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.
typedef struct MirPlatformMessage MirPlatformMessage |
typedef void(* MirPlatformOperationCallback) (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 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 struct MirPointerConfig MirPointerConfig |
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 enum MirPresentMode MirPresentMode |
typedef struct MirPromptSession MirPromptSession |
typedef void(* MirPromptSessionCallback) (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 struct MirPromptSessionEvent MirPromptSessionEvent |
typedef enum MirPromptSessionState MirPromptSessionState |
typedef void(* MirPromptSessionStateChangeCallback) (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 struct MirRectangle MirRectangle |
typedef struct MirRenderSurface MirRenderSurface |
typedef void(* MirRenderSurfaceCallback) (MirRenderSurface *, void *context) MIR_DEPRECATE_RENDERSURFACES_FOR_RENAME |
typedef enum MirResizeEdge MirResizeEdge |
Hints for resizing a window.
These values are used to indicate which edge(s) of a surface is being dragged in a resize operation.
typedef struct MirResizeEvent MirResizeEvent |
typedef struct MirScreencast MirScreencast |
typedef void(* MirScreencastBufferCallback) (MirScreencastResult status, MirBuffer *buffer, void *context) |
typedef void(* MirScreencastCallback) (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 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 enum MirScreencastResult MirScreencastResult |
typedef struct MirScreencastSpec MirScreencastSpec |
typedef enum MirShellChrome MirShellChrome |
Shell chrome.
typedef enum MirSubpixelArrangement MirSubpixelArrangement |
Physical arrangement of subpixels on the physical output.
This is always relative to the “natural” orientation of the display - mir_orientation_normal.
typedef struct MirSurfacePlacementEvent MirSurfacePlacementEvent |
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 |
MirTouchpadClickMode configures how the touchpad itself should generate pointer button events.
The available click modes may be active simultaneously.
typedef unsigned int MirTouchpadClickModes |
typedef struct MirTouchpadConfig MirTouchpadConfig |
typedef enum MirTouchpadScrollMode MirTouchpadScrollMode |
MirTouchpadScrollMode configures how the touchpad should generate scroll events.
typedef unsigned int MirTouchpadScrollModes |
typedef struct MirTouchscreenConfig MirTouchscreenConfig |
typedef enum MirTouchscreenMappingMode MirTouchscreenMappingMode |
Mapping modes for touchscreen devices.
The mode defines how coordinates from the touchscreen frequently referred to as device coordinates are translated into scene coordinates.
This configuration mode is relevant for different classes of input devices, i.e handheld devices with builtin touchscreens or external graphic tablets or external monitors with touchscreen capabilities.
typedef struct MirWaitHandle MirWaitHandle |
Returned by asynchronous functions.
Must not be free'd by callers. See the individual function documentation for information on the lifetime of wait handles.
typedef struct MirSurface MirWindow |
typedef enum MirWindowAttrib MirWindowAttrib |
Attributes of a window that the client and server/shell may wish to get or set over the wire.
typedef void(* MirWindowCallback) (MirWindow *window, void *client_context) |
Callback to be passed when calling window functions :
[in] | window | the window being updated |
[in,out] | client_context | context provided by client in calling mir_connect |
typedef struct MirSurfaceEvent MirWindowEvent |
Callback for handling of window events.
[in] | window | The window on which an event has occurred |
[in] | event | The event to be handled |
[in,out] | context | The context provided by client |
typedef enum MirWindowFocusState MirWindowFocusState |
typedef struct MirPersistentId MirWindowId |
typedef void(* MirWindowIdCallback) (MirWindow *window, MirPersistentId *id, void *context) |
typedef struct MirSurfaceOutputEvent MirWindowOutputEvent |
typedef struct MirSurfacePlacementEvent MirWindowPlacementEvent |
typedef struct MirSurfaceSpec MirWindowSpec |
typedef enum MirWindowState MirWindowState |
typedef enum MirWindowType MirWindowType |
typedef enum MirWindowVisibility MirWindowVisibility |
anonymous enum |
enum MirBufferLayout |
enum 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.
enum MirDepthLayer |
Depth layer controls Z ordering of surfaces.
A surface will always appear on top of surfaces with a lower depth layer, and below those with a higher one. A depth layer can be converted to a number with mir::mir_depth_layer_get_index(). This is useful for creating a list indexed by depth layer, or comparing the height of two layers.
Errors from the mir_error_domain_display_configuration MirErrorDomain.
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. |
mir_error_domain_input_configuration | Errors relating to input configuration. Associated error codes are found in MirInputConfigurationError. |
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 |
Errors from the mir_error_domain_input_configuration MirErrorDomain.
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 MirPlacementGravity |
Reference point for aligning a surface relative to a rectangle.
Each element (surface and rectangle) has a MirPlacementGravity assigned.
enum MirPlacementHints |
Positioning hints for aligning a window relative to a rectangle.
These hints determine how the window should be positioned in the case that the surface would fall off-screen if placed in its ideal position.
For example, mir_placement_hints_flip_x
will invert the x component of aux_rect_placement_offset
and replace mir_placement_gravity_northwest
with mir_placement_gravity_northeast
and vice versa if the window extends beyond the left or right edges of the monitor.
If mir_placement_hints_slide_x
is set, the window can be shifted horizontally to fit on-screen.
If mir_placement_hints_resize_x
is set, the window can be shrunken horizontally to fit.
If mir_placement_hints_antipodes
is set then the rect gravity may be substituted with the opposite corner (e.g. mir_placement_gravity_northeast
to mir_placement_gravity_southwest
) in combination with other options.
When multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.
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 MirPresentMode |
enum MirResizeEdge |
Hints for resizing a window.
These values are used to indicate which edge(s) of a surface is being dragged in a resize operation.
enum MirScreencastResult |
enum MirShellChrome |
Physical arrangement of subpixels on the physical output.
This is always relative to the “natural” orientation of the display - mir_orientation_normal.
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 |
enum MirSurfaceVisibility |
enum MirTouchAction |
enum MirTouchAxis |
enum MirTouchpadClickMode |
MirTouchpadClickMode configures how the touchpad itself should generate pointer button events.
The available click modes may be active simultaneously.
Enumerator | |
---|---|
mir_touchpad_click_mode_none | |
mir_touchpad_click_mode_area_to_click | |
mir_touchpad_click_mode_finger_count |
MirTouchpadScrollMode configures how the touchpad should generate scroll events.
Enumerator | |
---|---|
mir_touchpad_scroll_mode_none | |
mir_touchpad_scroll_mode_two_finger_scroll | |
mir_touchpad_scroll_mode_edge_scroll | |
mir_touchpad_scroll_mode_button_down_scroll |
Mapping modes for touchscreen devices.
The mode defines how coordinates from the touchscreen frequently referred to as device coordinates are translated into scene coordinates.
This configuration mode is relevant for different classes of input devices, i.e handheld devices with builtin touchscreens or external graphic tablets or external monitors with touchscreen capabilities.
enum MirTouchTooltype |
enum MirWindowAttrib |
Attributes of a window that the client and server/shell may wish to get or set over the wire.
Enumerator | |
---|---|
mir_window_attrib_type | |
mir_window_attrib_state | |
mir_window_attrib_swapinterval |
|
mir_window_attrib_focus | |
mir_window_attrib_dpi | |
mir_window_attrib_visibility | |
mir_window_attrib_preferred_orientation | |
mir_window_attribs |
enum MirWindowFocusState |
enum MirWindowState |
enum MirWindowType |
enum MirWindowVisibility |
void const* mir_blob_data | ( | MirBlob * | blob | ) |
Get the data of a blob.
[in] | blob | The blob |
MirBlob* mir_blob_from_display_config | ( | MirDisplayConfig * | config | ) |
Create a blob from a display config.
[in] | config | The display config |
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 |
MirDisplayConfig* mir_blob_to_display_config | ( | MirBlob * | blob | ) |
Create a blob from a display config.
[in] | blob | The blob |
MirDisplayConfiguration* mir_blob_to_display_configuration | ( | MirBlob * | blob | ) |
Create a blob from a display configuration.
[in] | blob | The blob |
MirBufferPackage* mir_buffer_get_buffer_package | ( | MirBuffer * | buffer | ) |
Access the MirBufferPackage.
[in] | buffer | The buffer |
char const* mir_buffer_get_error_message | ( | MirBuffer const * | 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 |
unsigned int mir_buffer_get_height | ( | MirBuffer const * | buffer | ) |
Retrieve the height of the buffer in pixels.
[in] | buffer | The buffer |
MirPixelFormat mir_buffer_get_pixel_format | ( | MirBuffer const * | buffer | ) |
Retrieve the pixel format of the buffer.
[in] | buffer | The buffer |
unsigned int mir_buffer_get_width | ( | MirBuffer const * | buffer | ) |
Retrieve the width of the buffer in pixels.
[in] | buffer | The buffer |
bool mir_buffer_is_valid | ( | MirBuffer const * | buffer | ) |
Test for a valid buffer.
[in] | buffer | The buffer |
bool mir_buffer_map | ( | MirBuffer * | buffer, |
MirGraphicsRegion * | region, | ||
MirBufferLayout * | layout | ||
) |
Access a CPU-mapped region associated with a given buffer.
[in] | buffer | The buffer |
[out] | region | The mapped region |
[out] | layout | The memory layout of the region |
void mir_buffer_stream_get_current_buffer | ( | MirBufferStream * | buffer_stream, |
MirNativeBuffer ** | buffer_package | ||
) |
Retrieve the current buffer in "raw" representation.
[in] | buffer_stream | 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 * | buffer_stream | ) |
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 |
bool 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 |
unsigned long mir_buffer_stream_get_microseconds_till_vblank | ( | MirBufferStream const * | stream | ) |
Query the approximate time interval in microseconds until the next vblank for a given buffer stream (actually the next vblank for the monitor deemed most relevant to the window using the buffer stream).
The result of (current_time + mir_buffer_stream_get_microseconds_till_vblank()) is the precise time at which the client should start rendering the next frame (or at least when it should sample its inputs/scene) so as to produce perfectly smooth rendering.
[in] | stream | The buffer stream |
MirPlatformType mir_buffer_stream_get_platform_type | ( | MirBufferStream * | stream | ) |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_buffer_stream_get_current_buffer() may be understood.
[in] | stream | The stream |
void mir_buffer_stream_get_size | ( | MirBufferStream * | stream, |
int * | width, | ||
int * | height | ||
) |
Get the physical size of the next buffer that will be provided by the stream.
[in] | stream | The buffer stream |
[out] | width | The physical width of the stream |
[out] | height | The physical height of the stream |
int mir_buffer_stream_get_swapinterval | ( | MirBufferStream * | stream | ) |
Query the swapinterval that the stream is operating with.
The default interval is 1.
[in] | stream | The buffer stream |
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, |
MirBufferStreamCallback | 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] | buffer_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 * | buffer_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 * | buffer_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 |
void mir_buffer_stream_set_size | ( | MirBufferStream * | stream, |
int | width, | ||
int | height | ||
) |
Set the physical size of the buffers provided by the buffer stream.
[in] | stream | The buffer stream |
[in] | width | The desired physical width |
[in] | height | The desired physical height |
MirWaitHandle* mir_buffer_stream_set_swapinterval | ( | MirBufferStream * | stream, |
int | interval | ||
) |
Set the swapinterval for the stream.
[in] | stream | The buffer stream |
[in] | interval | The number of vblank signals that mir_buffer_stream_swap_buffers will wait for |
MirWaitHandle* mir_buffer_stream_swap_buffers | ( | MirBufferStream * | buffer_stream, |
MirBufferStreamCallback | 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 |
void mir_buffer_unmap | ( | MirBuffer * | buffer | ) |
Flush the CPU caches for the buffer.
[in] | buffer | The buffer |
MirWaitHandle* mir_connect | ( | char const * | server, |
char const * | app_name, | ||
MirConnectedCallback | 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, | ||
MirBufferCallback | available_callback, | ||
void * | available_context | ||
) |
Allocate a MirBuffer and do not wait for the server to return it.
The buffer will be suitable for writing to via the CPU. Buffers that will be used on a GPU should be allocated via the platform appropriate extensions. (eg, mir_extension_gbm_buffer or mir_extension_android_buffer)
The callback will be called when the buffer is created.
[in] | connection | The connection |
[in] | width | Requested buffer width |
[in] | height | Requested buffer height |
[in] | format | Requested buffer pixel format |
[in] | available_callback | The callback called when the buffer is available |
[in] | available_context | The context for the available_callback |
MirBuffer* mir_connection_allocate_buffer_sync | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
Allocate a MirBuffer and wait for the server to return it.
[in] | connection | The connection |
[in] | width | Requested buffer width |
[in] | height | Requested buffer height |
[in] | format | Requested buffer pixel format |
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_apply_session_display_config | ( | MirConnection * | connection, |
MirDisplayConfig const * | display_config | ||
) |
Apply the display config for the connection.
The display config is applied to this connection only (per-connection config) 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 they can apply a new config.
[in] | connection | The connection |
[in] | display_config | The display_config to apply |
void mir_connection_apply_session_input_config | ( | MirConnection * | connection, |
MirInputConfig const * | config | ||
) |
Apply the input configuration for the connection.
Configure the behavior of input device attached to a server when the session this connection represents is the focused. If the session is not focused the configuration will be stored for later use.
The call returns after sending the configuration to the server.
Errors during application of the configuration will be indicated through the error callback.
[in] | connection | The connection |
[in] | config | The input config |
void mir_connection_cancel_base_display_configuration_preview | ( | MirConnection * | connection | ) |
Cancel a pending base display configuration preview.
If this request succeeds a configuration change event is sent to the client, with the now-current base display configuration.
This call will fail if there is no display configuration preview current. A client can detect this by registering a callback with mir_connection_set_error_callback() and checking for mir_display_configuration_error_no_preview_in_progress.
[in] | connection | The connection |
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, | ||
MirBufferStreamCallback | 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] | format | Requested pixel format |
[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] | format | Requested pixel format |
[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 |
MirPromptSession* mir_connection_create_prompt_session_sync | ( | MirConnection * | connection, |
pid_t | application_pid, | ||
MirPromptSessionStateChangeCallback | 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 |
void mir_connection_create_render_surface | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirRenderSurfaceCallback | callback, | ||
void * | context | ||
) |
Create a render surface.
[in] | connection | A valid connection |
[in] | width | The width in pixels |
[in] | height | The height in pixels |
[in] | callback | Callback to be invoked when the request completes. The callback is guaranteed to be called and called with a non-null MirRenderSurface*, but the render surface may be invalid in case of error. |
[in,out] | context | User data to pass to callback function |
MirRenderSurface* mir_connection_create_render_surface_sync | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a render surface and wait for the result.
[in] | connection | A valid connection |
[in] | width | The width in pixels |
[in] | height | The height in pixels |
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 | ) |
MirSurfaceSpec* mir_connection_create_spec_for_dialog | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_input_method | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_menu | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent, | ||
MirRectangle * | rect, | ||
MirEdgeAttachment | edge | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_modal_dialog | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_normal_surface | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_tip | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent, | ||
MirRectangle * | rect, | ||
MirEdgeAttachment | edge | ||
) |
MirSurfaceSpec* mir_connection_create_spec_for_tooltip | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirPixelFormat | format, | ||
MirSurface * | parent, | ||
MirRectangle * | zone | ||
) |
void mir_connection_enumerate_extensions | ( | MirConnection * | connection, |
void * | context, | ||
void(*)(void *context, char const *extension, int version) | enumerator | ||
) |
Enumerates the supported extensions.
[in] | connection | The connection |
[out] | context | User data passed to the enumerator function |
[in] | enumerator | The function to be called for each extension |
void mir_connection_get_available_surface_formats | ( | MirConnection * | connection, |
MirPixelFormat * | formats, | ||
unsigned const int | formats_size, | ||
unsigned int * | num_valid_formats | ||
) |
Get the list of possible formats that a surface can be created with.
[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 with EGL.
[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, | ||
MirPlatformOperationCallback | 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 |
bool mir_connection_present_mode_supported | ( | MirConnection * | connection, |
MirPresentMode | mode | ||
) |
Query whether the server supports a given presentation mode.
[in] | connection | The connection |
[in] | mode | The MirPresentMode |
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(), or is reverted immediately after a call to mir_connection_cancel_display_configuration_preview().
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 |
void mir_connection_remove_session_display_config | ( | MirConnection * | connection | ) |
Remove the display configuration for the connection.
If a session display config is applied to the connection it is removed, and the base display config is used. If there was no previous call to mir_connection_apply_session_display_config this will do nothing.
[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_base_input_config | ( | MirConnection * | connection, |
MirInputConfig const * | config | ||
) |
Set the input configuration as base configuration.
Configure the behavior of input device attached to a server. When allowed by the shell the configuration will be used as base configuration.
So whenever the active session has no session specific configuration this input configuration will be used.
The call returns after sending the configuration to the server.
Errors during application of the configuration will be indicated through the error callback.
[in] | connection | The connection |
[in] | config | The input config |
void mir_connection_set_display_config_change_callback | ( | MirConnection * | connection, |
MirDisplayConfigCallback | callback, | ||
void * | context | ||
) |
Register a callback to be called when the hardware display configuration changes.
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, |
MirErrorCallback | 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, |
MirInputConfigCallback | 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, |
MirLifecycleEventCallback | 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, |
MirPingEventCallback | 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. |
[in] | size | The size of the buffer. 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.
[in] | cookie | A cookie instance |
[in] | buffer | A buffer which is filled with the serialized representation of the given cookie |
[in] | size | The size of the given buffer |
MirWindowSpec* mir_create_dialog_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for a parentless dialog window.
A parentless dialog window is similar to a normal window, 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 window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
MirWindowSpec* mir_create_freestyle_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for a freestyle window.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
MirWindowSpec* mir_create_gloss_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for a gloss window.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
MirWindowSpec* mir_create_input_method_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for an input method window.
Currently this is only appropriate for the Unity On-Screen-Keyboard.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
MirWindowSpec* mir_create_menu_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirWindow * | parent, | ||
MirRectangle * | rect, | ||
MirEdgeAttachment | edge | ||
) |
Create a window specification for a menu window.
Positioning of the window is specified with respect to the parent window via an adjacency rectangle. The server will attempt to choose an edge of the adjacency rectangle on which to place the window 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 window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
[in] | parent | A valid parent window for this menu. |
[in] | rect | The adjacency rectangle. The server is not guaranteed to create a window at the requested location. |
[in] | edge | The preferred edge direction to attach to. Use mir_edge_attachment_any for no preference. |
MirWindowSpec* mir_create_modal_dialog_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirWindow * | parent | ||
) |
Create a window specification for a modal dialog window.
The dialog window 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 window creation, if the specified parent is another dialog window the server may choose to close the specified parent in order to show this new dialog window.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
[in] | parent | A valid parent window. |
MirWindowSpec* mir_create_normal_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for a normal window.
A normal window 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 window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
MirWindowSpec* mir_create_satellite_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirWindow * | parent | ||
) |
Create a window specification for a satellite window.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
[in] | parent | A valid parent window. |
MirScreencastSpec* mir_create_screencast_spec | ( | MirConnection * | connection | ) |
Create a screencast specification.
[in] | connection | a valid mir connection |
MirSurfaceSpec* mir_create_surface_spec | ( | MirConnection * | connection | ) |
MirWindowSpec* mir_create_tip_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height, | ||
MirWindow * | parent, | ||
MirRectangle * | rect, | ||
MirEdgeAttachment | edge | ||
) |
Create a window specification for a tip window.
Positioning of the window is specified with respect to the parent window via an adjacency rectangle. The server will attempt to choose an edge of the adjacency rectangle on which to place the window 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 window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
[in] | parent | A valid parent window for this tip. |
[in] | rect | The adjacency rectangle. The server is not guaranteed to create a window at the requested location. |
[in] | edge | The preferred edge direction to attach to. Use mir_edge_attachment_any for no preference. |
MirWindowSpec* mir_create_utility_window_spec | ( | MirConnection * | connection, |
int | width, | ||
int | height | ||
) |
Create a window specification for a utility window.
[in] | connection | Connection the window will be created on |
[in] | width | Requested width. The server is not guaranteed to return a window of this width. |
[in] | height | Requested height. The server is not guaranteed to return a window of this height. |
void mir_create_window | ( | MirWindowSpec * | requested_specification, |
MirWindowCallback | callback, | ||
void * | context | ||
) |
Create a window from a given specification.
[in] | requested_specification | Specification of the attributes for the created window |
[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 MirWindow*, but the window may be invalid in case of an error. |
MirWindowSpec* mir_create_window_spec | ( | MirConnection * | connection | ) |
Create a window specification.
This can be used with mir_create_window() to create a window or with mir_window_apply_spec() to change an existing window.
[in] | connection | a valid mir connection |
MirWindow* mir_create_window_sync | ( | MirWindowSpec * | requested_specification | ) |
Create a window from a given specification and wait for the result.
[in] | requested_specification | Specification of the attributes for the created window |
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] | stream | 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 |
MirCursorConfiguration* mir_cursor_configuration_from_render_surface | ( | MirRenderSurface * | surface, |
int | hotspot_x, | ||
int | hotspot_y | ||
) |
Returns a new cursor configuration tied to a given render surface.
If the configuration is successfully applied buffers from the surface will be used to fill the system cursor.
[in] | surface | The render surface |
[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. |
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 |
char const* mir_display_output_type_name | ( | MirDisplayOutputType | type | ) |
Get the textual name of an output type.
[in] | type | The MirDisplayOutputType to describe. |
uint32_t mir_error_get_code | ( | MirError const * | error | ) |
Get the domain-specific error code of a MirError.
[in] | error | The MirError to query |
MirErrorDomain mir_error_get_domain | ( | MirError const * | error | ) |
Get the domain of a MirError.
The error domain is required to interpret the rest of the error details.
[in] | error | The MirError to query |
MirCloseSurfaceEvent const* mir_event_get_close_surface_event | ( | MirEvent const * | event | ) |
Retrieve the MirCloseSurfaceEvent associated with a MirEvent of type mir_event_type_close_surface.
The event is a request to close the surface it is delivered to and has no accessors.
[in] | event | The event |
MirInputConfigurationEvent const* mir_event_get_input_configuration_event | ( | MirEvent const * | event | ) |
Retrieve the MirInputConfig 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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 * | event | ) |
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 |
MirSurfacePlacementEvent const* mir_event_get_surface_placement_event | ( | MirEvent const * | event | ) |
Retrieve the MirSurfacePlacementEvent associated with a MirEvent of type mir_event_type_surface_placement.
The event signifies that the the server has fulfilled a request for relative surface placement.
[in] | event | The event |
MirEventType mir_event_get_type | ( | MirEvent const * | event | ) |
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 |
MirWindowEvent const* mir_event_get_window_event | ( | MirEvent const * | event | ) |
Retrieve the MirWindowEvent associated with a MirEvent of type mir_event_type_window.
See <mir_toolkit/events/surface_event.h> for accessors.
[in] | event | The event |
MirWindowOutputEvent const* mir_event_get_window_output_event | ( | MirEvent const * | event | ) |
Retrieve the MirWindowOutputEvent associated with a MirEvent of type mir_event_type_window_output.
The event signifies that the properties of the output the window is displayed upon have changed.
A MirWindowOutputEvent is generated either when the properties of the output the window is primarily on change (for example: by user configuration of resolution) or when the output the window is primarily on changes (for example: when a user moves the window from one monitor to another).
[in] | event | The event |
MirWindowPlacementEvent const* mir_event_get_window_placement_event | ( | MirEvent const * | event | ) |
Retrieve the MirWindowPlacementEvent associated with a MirEvent of type mir_event_type_window_placement.
The event signifies that the the server has fulfilled a request for relative window placement.
[in] | event | The event |
Reference this MirEvent and return a pointer to the newly referenced instance.
[in] | event | The event to reference |
void mir_event_unref | ( | MirEvent const * | event | ) |
Release a reference to a MirEvent.
[in] | event | The event to un-reference |
enum MirBufferUsage MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "No longer applicable when using MirRenderSurface" | ) |
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.
struct MirSurfaceParameters MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use mir_window_get apis or listen for attribute events instead" | ) |
MirWindowParameters is the structure of minimum required information that you must provide to Mir in order to create a window.
struct MirCursorConfiguration MirCursorConfiguration MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use mir_window_spec_set_cursor_name/mir_window_spec_set_cursor_render_surface instead" | ) |
Opaque structure containing cursor parameterization.
Create with mir_cursor* family. Used with mir_window_configure_cursor.
struct MirCloseSurfaceEvent MirCloseSurfaceEvent MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirCloseWindowEvent instead" | ) |
struct MirInputConfigurationEvent MirInputConfigurationEvent MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use MirInputDeviceStateEvent and the MirInputConfig callback instead" | ) |
struct MirSurface MirSurface MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use MirWindow instead" | ) |
enum MirSurfaceAttrib MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowAttrib" | ) |
Attributes of a surface that the client and server/shell may wish to get or set over the wire.
struct MirSurfaceEvent MirSurfaceEvent MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowEvent instead" | ) |
enum MirSurfaceFocusState MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowFocusState" | ) |
struct MirPersistentId MirPersistentId MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use MirWindowId instead" | ) |
struct MirSurfaceOutputEvent MirSurfaceOutputEvent MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowOutputEvent instead" | ) |
struct MirSurfacePlacementEvent MirSurfacePlacementEvent MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowPlacementEvent instead" | ) |
struct MirSurfaceSpec MirSurfaceSpec MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "Use MirWindowSpec instead" | ) |
enum MirSurfaceState MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowState" | ) |
enum MirSurfaceType MIR_FOR_REMOVAL_IN_VERSION_1 | ( | "use MirWindowType" | ) |
unsigned mir_get_client_api_version | ( | ) |
Returns client API version.
Result of the function should be compared to result of MIR_VERSION_NUMBER
void mir_input_config_destroy | ( | MirInputConfig const * | config | ) |
Release this snapshot of the input configuration. This invalidates any pointers retrieved from this structure.
[in] | config | 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_release 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_release 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_release 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_release 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 |
void mir_input_config_release | ( | MirInputConfig const * | config | ) |
Release this snapshot of the input configuration.
This invalidates any pointers retrieved from this structure.
[in] | config | The input configuration |
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 |
MirKeyboardConfig const* mir_input_device_get_keyboard_config | ( | MirInputDevice const * | device | ) |
Retrieve a structure containing the keyboard related config options of the input device.
If the input device does not contain keys, there will be no config options, and the function will return a null pointer.
[in] | device | The input device |
MirKeyboardConfig* mir_input_device_get_mutable_keyboard_config | ( | MirInputDevice * | device | ) |
Retrieve a mutable structure containing the keyboard related config options of the input device.
If the input device does not contain keys, there will be no config options, and the function will return a null pointer.
[in] | device | The input device |
MirPointerConfig* mir_input_device_get_mutable_pointer_config | ( | MirInputDevice * | device | ) |
Retrieve a structure containing the pointer related config options of the input device that can be manipulated.
If the input device does not control the mouse cursor, there will be no config options, and the function will return a null pointer.
[in] | device | The input device |
MirTouchpadConfig* mir_input_device_get_mutable_touchpad_config | ( | MirInputDevice * | device | ) |
Retrieve a structure containing the touchpad related config options of the input device that can be manipulated.
If the input device is not a touchpad this function will return null pointer.
[in] | device | The input device |
MirTouchscreenConfig* mir_input_device_get_mutable_touchscreen_config | ( | MirInputDevice * | device | ) |
Retrieve a mutable structure containing the touchscreen related options of the input device to change the device configuration.
If the input device does not contain a touchscreen, there are no config options, and the function will return a null pointer.
[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 |
MirPointerConfig const* mir_input_device_get_pointer_config | ( | MirInputDevice const * | device | ) |
Retrieve a structure containing the pointer related config options of the input device.
If the input device does not control the mouse cursor, there will be no config options, and the function will return a null pointer.
[in] | device | The input device |
MirTouchpadConfig const* mir_input_device_get_touchpad_config | ( | MirInputDevice const * | device | ) |
Retrieve a structure containing the touchpad related config options of the input device.
If the input device is not a touchpad this function will return null pointer.
[in] | device | The input device |
MirTouchscreenConfig const* mir_input_device_get_touchscreen_config | ( | MirInputDevice const * | device | ) |
Retrieve a structure containing the touchscreen related config options of the input device.
If the input device does not contain a touchscreen, there are no config options, and the function will return a null pointer.
[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 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 |
uint32_t mir_input_device_state_event_device_pressed_keys_for_index | ( | MirInputDeviceStateEvent const * | ev, |
uint32_t | index, | ||
uint32_t | pressed_index | ||
) |
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.
[in] | ev | An input event |
MirInputDeviceId mir_input_event_get_device_id | ( | MirInputEvent const * | event | ) |
Retrieves the device id responsible for generating an input event.
[in] | event | The input event |
MirEvent const* mir_input_event_get_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirEvent associated with a given input event.
[in] | event | The input event |
int64_t mir_input_event_get_event_time | ( | MirInputEvent const * | event | ) |
Retrieve the time at which an input event occurred.
[in] | event | The input event |
MirKeyboardEvent const* mir_input_event_get_keyboard_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirKeyboardEvent associated with a given input event.
[in] | event | The input event |
MirPointerEvent const* mir_input_event_get_pointer_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirPointerEvent associated with a given input event.
[in] | event | The input event |
MirTouchEvent const* mir_input_event_get_touch_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirTouchEvent associated with a given input event.
[in] | event | The input event |
MirInputEventType mir_input_event_get_type | ( | MirInputEvent const * | event | ) |
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 |
char const* mir_keyboard_config_get_keymap_layout | ( | MirKeyboardConfig const * | conf | ) |
Retrieve the layout of the keymap as a null terminated string.
[in] | conf | The keyboard config |
char const* mir_keyboard_config_get_keymap_model | ( | MirKeyboardConfig const * | conf | ) |
Retrieve the keyboard model of the keymap as a null terminated string.
[in] | conf | The keyboard config |
char const* mir_keyboard_config_get_keymap_options | ( | MirKeyboardConfig const * | conf | ) |
Retrieve the options of the keymap as a null terminated string.
The keymap options are an optional parameter of the keymap selection, this then indicated as an empty string.
[in] | conf | The keyboard config |
char const* mir_keyboard_config_get_keymap_variant | ( | MirKeyboardConfig const * | conf | ) |
Retrieve the layout of the keymap as a null terminated string.
[in] | conf | The keyboard config |
void mir_keyboard_config_set_keymap_layout | ( | MirKeyboardConfig * | conf, |
char const * | layout | ||
) |
Set the layout of the keymap as a null terminated string.
[in] | conf | The keyboard config |
[in] | layout | The keymap layout |
void mir_keyboard_config_set_keymap_model | ( | MirKeyboardConfig * | conf, |
char const * | model | ||
) |
Set the keyboard model of the keymap as a null terminated string.
[in] | conf | The keyboard config |
[in] | model | The keymap keyboard model |
void mir_keyboard_config_set_keymap_options | ( | MirKeyboardConfig * | conf, |
char const * | options | ||
) |
Set the options of the keymap as a null terminated string.
[in] | conf | The keyboard config |
[in] | options | The keymap options |
void mir_keyboard_config_set_keymap_variant | ( | MirKeyboardConfig * | conf, |
char const * | variant | ||
) |
Set the variant of the keymap as a null terminated string.
[in] | conf | The keyboard config |
[in] | variant | The keymap variant |
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 |
char const* mir_keyboard_event_key_text | ( | MirKeyboardEvent const * | event | ) |
Retrieve the text the key press would emit as null terminated utf8 string.
The text will only be available to key down and key repeat events. For mir_keyboard_action_up or key presses that do produce text an empty string will be returned.
[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 |
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 * | rules | ||
) |
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 |
size_t mir_output_get_current_mode_index | ( | MirOutput const * | output | ) |
Get the index of 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 (size_t)-1.
[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 |
uint8_t const* mir_output_get_edid | ( | MirOutput const * | output | ) |
Get the raw EDID data of a display.
This returns a pointer to the start of the raw, unparsed EDID data. Some displays or connection types may not provide EDID data. In that case, this returns NULL.
An EDID is always at least 128 bytes, but may be longer in the presence of extensions.
[in] | output | The MirOutput to query |
size_t mir_output_get_edid_size | ( | MirOutput const * | output | ) |
Get the size of the EDID of this display.
If the EDID is unavailable for some reason this returns 0.
An EDID is always at least 128 bytes, but may be longer in the presence of extensions.
[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 |
void mir_output_get_gamma | ( | MirOutput const * | output, |
uint16_t * | red, | ||
uint16_t * | green, | ||
uint16_t * | blue, | ||
uint32_t | size | ||
) |
Get the gamma ramp of a display.
Copies the gammas into user created buffers up to the size provided
[in] | output | The MirOutput to query |
[out] | red | The red gamma ramp |
[out] | green | The green gamma ramp |
[out] | blue | The blue gamma ramp |
[in] | size | The size of the gamma ramp |
uint32_t mir_output_get_gamma_size | ( | MirOutput const * | output | ) |
Gets the gamma size.
[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_window_spec_set_fullscreen_on_output().
[in] | output | The MirOutput to query. |
unsigned int mir_output_get_logical_height | ( | MirOutput const * | output | ) |
Get the height of the virtual display space occupied by an output.
This may not be equal to the height of its current mode, for example if it is rotated or (in future) cloning another output.
[in] | output | The MirOutput to query |
unsigned int mir_output_get_logical_width | ( | MirOutput const * | output | ) |
Get the width of the virtual display space occupied by an output.
This may not be equal to the width of its current mode, for example if it is rotated or (in future) cloning another 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. |
char const* mir_output_get_model | ( | MirOutput const * | output | ) |
Get a descriptive manufacturer/model string for the connected display.
The format of this string is arbitrary and driver-specific but should be human-readable and helpful for someone to identify which physical display this is. Note this function is not called get_name because that would imply the returned value is different for each output, whereas it may not be.
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 |
size_t mir_output_get_preferred_mode_index | ( | MirOutput const * | output | ) |
Get the index of 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 (size_t)-1.
[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 |
MirSubpixelArrangement mir_output_get_subpixel_arrangement | ( | MirOutput const * | output | ) |
Get the subpixel arrangement of a display.
[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_has_custom_logical_size | ( | MirOutput const * | output | ) |
bool mir_output_is_enabled | ( | MirOutput const * | output | ) |
Get whether this output is enabled in the current configuration.
[in] | output | the MirOutput to query |
bool mir_output_is_gamma_supported | ( | MirOutput const * | output | ) |
Gets if the platform supports gamma correction.
[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_gamma | ( | MirOutput * | output, |
uint16_t const * | red, | ||
uint16_t const * | green, | ||
uint16_t const * | blue, | ||
uint32_t | size | ||
) |
Set the gamma ramp of a display.
[in] | output | The MirOutput to query |
[in] | red | The red gamma ramp |
[in] | green | The green gamma ramp |
[in] | blue | The blue gamma ramp |
[in] | size | The size of the gamma ramp |
void mir_output_set_logical_size | ( | MirOutput * | output, |
unsigned | w, | ||
unsigned | h | ||
) |
Set the logical size of the virtual display space occupied by an output.
By default this is the dimensions of the output's current mode, but you can now set it to an arbitrary size and the compositor will scale accordingly.
[in] | output | The output to modify |
[in] | w | The width in logical view area pixels, or zero to revert to the current display mode dimensions. |
[in] | h | The height in logical view area pixels, or zero to revert to the current display mode dimensions. |
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 |
void mir_output_set_scale_factor | ( | MirOutput * | output, |
float | scale | ||
) |
Set the scale-factor of a display.
The scale-factor specifies the conversion between logical pixels and physical pixels on this output. See mir_output_get_scale_factor for further details.
[in] | output | The MirOutput to modify |
[in] | scale | The scale factor |
char const* mir_output_type_name | ( | MirOutputType | type | ) |
Get the textual name of an output type.
[in] | type | The MirOutputType to describe. |
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 |
MirPointerAcceleration mir_pointer_config_get_acceleration | ( | MirPointerConfig const * | conf | ) |
Retrieve the cursor acceleration profile.
[in] | conf | The pointer config |
double mir_pointer_config_get_acceleration_bias | ( | MirPointerConfig const * | conf | ) |
Retrieve the cursor acceleration bias.
The value will be in the range of [-1, 1]:
[in] | conf | The pointer config |
MirPointerHandedness mir_pointer_config_get_handedness | ( | MirPointerConfig const * | conf | ) |
Retrieve whether the pointer device is configured for right or left handed use.
[in] | conf | The pointer config |
double mir_pointer_config_get_horizontal_scroll_scale | ( | MirPointerConfig const * | conf | ) |
Retrieve the horizontal scroll scale.
The value is a signed linear scale of the horizontal scroll axis. A Negative value indicates 'natural scrolling'.
[in] | conf | The pointer config |
double mir_pointer_config_get_vertical_scroll_scale | ( | MirPointerConfig const * | conf | ) |
Retrieve the vertical scroll scale.
The value is a signed linear scale of the vertical scroll axis. A Negative value indicates 'natural scrolling'.
[in] | conf | The pointer config |
void mir_pointer_config_set_acceleration | ( | MirPointerConfig * | conf, |
MirPointerAcceleration | acceleration | ||
) |
Set the acceleration mode of the pointer device.
See MirPointerAcceleration for reference.
[in] | conf | The pointer config |
[in] | acceleration | The acceleration mode |
void mir_pointer_config_set_acceleration_bias | ( | MirPointerConfig * | conf, |
double | acceleration_bias | ||
) |
Set the acceleration bias of the pointer device.
The acceleration bias must be in the range of [-1, 1]:
[in] | conf | The pointer config |
[in] | acceleration_bias | The acceleration bias |
void mir_pointer_config_set_handedness | ( | MirPointerConfig * | conf, |
MirPointerHandedness | handedness | ||
) |
Configure left and right hand use of the pointer device.
This configures which buttons will be used as primary and secondary buttons.
[in] | conf | The pointer config |
[in] | handedness | left or right handed use |
void mir_pointer_config_set_horizontal_scroll_scale | ( | MirPointerConfig * | conf, |
double | horizontal_scroll_scale | ||
) |
Set the horizontal scroll scale.
The horizontal scroll scale is a signed linear scale of scroll motion along the horizontal axis. Negative scales can be used to configure 'natural scrolling'.
[in] | conf | The pointer config |
[in] | horizontal_scroll_scale | The horizontal scroll scale |
void mir_pointer_config_set_vertical_scroll_scale | ( | MirPointerConfig * | conf, |
double | vertical_scroll_scale | ||
) |
Set the vertical scroll scale.
The vertical scroll scale is a signed linear scale of scroll motion along the vertical axis. Negative scales can be used to configure 'natural scrolling'.
[in] | conf | The pointer config |
[in] | vertical_scroll_scale | The vertical scroll scale |
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_set_mode | ( | MirPresentationChain * | chain, |
MirPresentMode | mode | ||
) |
Respecify the submission mode that the MirPresentationChain is operating with.
The buffers currently queued will immediately be requeued according to the new mode.
[in] | chain | The chain |
[in] | mode | The mode to change to |
void mir_presentation_chain_submit_buffer | ( | MirPresentationChain * | presentation_chain, |
MirBuffer * | buffer, | ||
MirBufferCallback | available_callback, | ||
void * | available_context | ||
) |
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 |
[in] | available_callback | The callback called when the buffer is available |
[in] | available_context | The context for the available_callback |
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 * | event | ) |
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, | ||
MirClientFdCallback | 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 |
size_t mir_prompt_session_new_fds_for_prompt_providers_sync | ( | MirPromptSession * | prompt_session, |
unsigned int | no_of_fds, | ||
int * | fds | ||
) |
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 |
[out] | fds | An int array of at least size no_of_fds |
void mir_prompt_session_release_sync | ( | MirPromptSession * | prompt_session | ) |
Stop and release the specified prompt session.
[in] | prompt_session | The prompt session |
MirBufferStream* mir_render_surface_get_buffer_stream | ( | MirRenderSurface * | render_surface, |
int | width, | ||
int | height, | ||
MirPixelFormat | format | ||
) |
Obtain the buffer stream backing a given render surface.
The MirBufferStream will contain buffers suitable for writing via the CPU.
[in] | render_surface | The render surface |
[in] | width | Requested width |
[in] | height | Requested height |
[in] | format | Requested pixel format |
char const* mir_render_surface_get_error_message | ( | MirRenderSurface * | render_surface | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the render surface or the associated connection has been released.
[in] | render_surface | The render surface |
MirPresentationChain* mir_render_surface_get_presentation_chain | ( | MirRenderSurface * | render_surface | ) |
Obtain the presentation chain backing a given render surface.
The MirPresentationChain is created in mir_present_mode_fifo submission mode.
void mir_render_surface_get_size | ( | MirRenderSurface * | render_surface, |
int * | width, | ||
int * | height | ||
) |
Get the size of the MirRenderSurface.
[in] | render_surface | The render surface |
[out] | width | The width in pixels |
[out] | height | The height in pixels |
bool mir_render_surface_is_valid | ( | MirRenderSurface * | render_surface | ) |
Test for a valid render surface.
[in] | render_surface | The render surface |
void mir_render_surface_release | ( | MirRenderSurface * | render_surface | ) |
Release the specified render surface.
[in] | render_surface | The render surface to be released |
void mir_render_surface_set_size | ( | MirRenderSurface * | render_surface, |
int | width, | ||
int | height | ||
) |
Set the size of the MirRenderSurface.
[in] | render_surface | The render surface |
[in] | width | The width in pixels |
[in] | height | The height in pixels |
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 |
void mir_screencast_capture_to_buffer | ( | MirScreencast * | screencast, |
MirBuffer * | buffer, | ||
MirScreencastBufferCallback | available_callback, | ||
void * | available_context | ||
) |
Capture the contents of the screen to a particular buffer.
[in] | screencast | The screencast |
[in] | buffer | The buffer |
[in] | available_callback | Callback triggered when buffer is available again |
[in] | available_context | The context for the above callback |
MirScreencastResult mir_screencast_capture_to_buffer_sync | ( | MirScreencast * | screencast, |
MirBuffer * | buffer | ||
) |
Capture the contents of the screen to a particular buffer and wait for the capture to complete.
[in] | screencast | The screencast |
[in] | buffer | The buffer |
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 | ||
) |
MirWaitHandle* mir_surface_configure_cursor | ( | MirSurface * | surface, |
MirCursorConfiguration const * | parameters | ||
) |
MirWaitHandle* mir_surface_create | ( | MirSurfaceSpec * | requested_specification, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
MirSurface* mir_surface_create_sync | ( | MirSurfaceSpec * | requested_specification | ) |
MirSurfaceAttrib mir_surface_event_get_attribute | ( | MirSurfaceEvent const * | event | ) |
Retrieve the attribute index configured with a given MirSurfaceEvent.
[in] | event | The event |
int mir_surface_event_get_attribute_value | ( | MirSurfaceEvent const * | event | ) |
Retrieve the new value of the associated attribute for a given MirSurfaceEvent.
[in] | event | The event |
MirBufferStream* mir_surface_get_buffer_stream | ( | MirSurface * | surface | ) |
int mir_surface_get_dpi | ( | MirSurface * | surface | ) |
char const* mir_surface_get_error_message | ( | MirSurface * | surface | ) |
MirSurfaceFocusState mir_surface_get_focus | ( | MirSurface * | surface | ) |
MirOrientation mir_surface_get_orientation | ( | MirSurface * | surface | ) |
void mir_surface_get_parameters | ( | MirSurface * | surface, |
MirSurfaceParameters * | parameters | ||
) |
MirOrientationMode mir_surface_get_preferred_orientation | ( | MirSurface * | surface | ) |
MirSurfaceState mir_surface_get_state | ( | MirSurface * | surface | ) |
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 | ) |
MirSurfaceVisibility mir_surface_get_visibility | ( | MirSurface * | surface | ) |
bool mir_surface_is_valid | ( | MirSurface * | 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 |
double mir_surface_output_event_get_refresh_rate | ( | MirSurfaceOutputEvent const * | ev | ) |
Retrieve the maximum refresh rate of the output(s) associated with a MirSurfaceOutputEvent.
For variable refresh rate displays this represents the maximum refresh rate of the display to aim for, rather than a measurement of recent performance.
[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 |
MirRectangle mir_surface_placement_get_relative_position | ( | MirSurfacePlacementEvent const * | event | ) |
Retrieve the relative position from a placement notification.
[in] | event | The placement event |
void mir_surface_raise | ( | MirSurface * | surface, |
MirCookie const * | cookie | ||
) |
MirWaitHandle* mir_surface_release | ( | MirSurface * | surface, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
void mir_surface_release_sync | ( | MirSurface * | surface | ) |
MirWaitHandle* mir_surface_request_persistent_id | ( | MirSurface * | surface, |
mir_surface_id_callback | callback, | ||
void * | context | ||
) |
MirPersistentId* mir_surface_request_persistent_id_sync | ( | MirSurface * | surface | ) |
void mir_surface_set_event_handler | ( | MirSurface * | surface, |
mir_surface_event_callback | callback, | ||
void * | context | ||
) |
MirWaitHandle* mir_surface_set_preferred_orientation | ( | MirSurface * | surface, |
MirOrientationMode | orientation | ||
) |
MirWaitHandle* mir_surface_set_state | ( | MirSurface * | surface, |
MirSurfaceState | state | ||
) |
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 |
bool mir_surface_spec_attach_to_foreign_parent | ( | MirSurfaceSpec * | spec, |
MirPersistentId * | parent, | ||
MirRectangle * | attachment_rect, | ||
MirEdgeAttachment | edge | ||
) |
void mir_surface_spec_release | ( | MirSurfaceSpec * | spec | ) |
void mir_surface_spec_set_buffer_usage | ( | MirSurfaceSpec * | spec, |
MirBufferUsage | usage | ||
) |
void mir_surface_spec_set_event_handler | ( | MirSurfaceSpec * | spec, |
mir_surface_event_callback | callback, | ||
void * | context | ||
) |
void mir_surface_spec_set_fullscreen_on_output | ( | MirSurfaceSpec * | spec, |
uint32_t | output_id | ||
) |
void mir_surface_spec_set_height | ( | MirSurfaceSpec * | spec, |
unsigned | height | ||
) |
void mir_surface_spec_set_height_increment | ( | MirSurfaceSpec * | spec, |
unsigned | height_inc | ||
) |
void mir_surface_spec_set_input_shape | ( | MirSurfaceSpec * | spec, |
MirRectangle const * | rectangles, | ||
size_t | n_rects | ||
) |
void mir_surface_spec_set_max_aspect_ratio | ( | MirSurfaceSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
void mir_surface_spec_set_max_height | ( | MirSurfaceSpec * | spec, |
unsigned | max_height | ||
) |
void mir_surface_spec_set_max_width | ( | MirSurfaceSpec * | spec, |
unsigned | max_width | ||
) |
void mir_surface_spec_set_min_aspect_ratio | ( | MirSurfaceSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
void mir_surface_spec_set_min_height | ( | MirSurfaceSpec * | spec, |
unsigned | min_height | ||
) |
void mir_surface_spec_set_min_width | ( | MirSurfaceSpec * | spec, |
unsigned | min_width | ||
) |
void mir_surface_spec_set_name | ( | MirSurfaceSpec * | spec, |
char const * | name | ||
) |
void mir_surface_spec_set_parent | ( | MirSurfaceSpec * | spec, |
MirSurface * | parent | ||
) |
void mir_surface_spec_set_pixel_format | ( | MirSurfaceSpec * | spec, |
MirPixelFormat | format | ||
) |
void mir_surface_spec_set_placement | ( | MirSurfaceSpec * | spec, |
const MirRectangle * | rect, | ||
MirPlacementGravity | rect_gravity, | ||
MirPlacementGravity | window_gravity, | ||
MirPlacementHints | placement_hints, | ||
int | offset_dx, | ||
int | offset_dy | ||
) |
void mir_surface_spec_set_pointer_confinement | ( | MirSurfaceSpec * | spec, |
MirPointerConfinementState | state | ||
) |
void mir_surface_spec_set_preferred_orientation | ( | MirSurfaceSpec * | spec, |
MirOrientationMode | mode | ||
) |
void mir_surface_spec_set_shell_chrome | ( | MirSurfaceSpec * | spec, |
MirShellChrome | style | ||
) |
void mir_surface_spec_set_state | ( | MirSurfaceSpec * | spec, |
MirSurfaceState | state | ||
) |
void mir_surface_spec_set_streams | ( | MirSurfaceSpec * | spec, |
MirBufferStreamInfo * | streams, | ||
unsigned int | num_streams | ||
) |
void mir_surface_spec_set_type | ( | MirSurfaceSpec * | spec, |
MirSurfaceType | type | ||
) |
void mir_surface_spec_set_width | ( | MirSurfaceSpec * | spec, |
unsigned | width | ||
) |
void mir_surface_spec_set_width_increment | ( | MirSurfaceSpec * | spec, |
unsigned | width_inc | ||
) |
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). |
int mir_touchpad_config_get_button_down_scroll_button | ( | MirTouchpadConfig const * | conf | ) |
Retrieve the configured button down for button down scroll mode.
See MirTouchpadScrollMode for reference.
[in] | conf | The touchpad config |
MirTouchpadClickModes mir_touchpad_config_get_click_modes | ( | MirTouchpadConfig const * | conf | ) |
Retrieve the click modes of the touchpad.
See MirTouchpadClickMode for reference.
[in] | conf | The touchpad config |
bool mir_touchpad_config_get_disable_while_typing | ( | MirTouchpadConfig const * | conf | ) |
Retrieve whether the touchpad events should be blocked while the user types.
[in] | conf | The touchpad config |
bool mir_touchpad_config_get_disable_with_mouse | ( | MirTouchpadConfig const * | conf | ) |
Retrieve whether the touchpad should be disabled when an external pointer device like a mouse is connected.
[in] | conf | The touchpad config |
bool mir_touchpad_config_get_middle_mouse_button_emulation | ( | MirTouchpadConfig const * | conf | ) |
Retrieve whether middle mouse button should be emulated.
[in] | conf | The touchpad config |
MirTouchpadScrollModes mir_touchpad_config_get_scroll_modes | ( | MirTouchpadConfig const * | conf | ) |
Retrieve the scroll modes of the touchpad.
See MirTouchpadScrollMode for reference.
[in] | conf | The touchpad config |
bool mir_touchpad_config_get_tap_to_click | ( | MirTouchpadConfig const * | conf | ) |
Retrieve whether a tap gesture generates pointer button events.
[in] | conf | The touchpad config |
void mir_touchpad_config_set_button_down_scroll_button | ( | MirTouchpadConfig * | conf, |
int | button | ||
) |
Configure the button for button down scroll mode.
[in] | conf | The touchpad config |
[in] | button | the button |
void mir_touchpad_config_set_click_modes | ( | MirTouchpadConfig * | conf, |
MirTouchpadClickModes | modes | ||
) |
Configure the enable click modes for the touchpad.
[in] | conf | The touchpad config |
[in] | modes | the enabled click modes |
void mir_touchpad_config_set_disable_while_typing | ( | MirTouchpadConfig * | conf, |
bool | active | ||
) |
Configure whether the touchpad should be turned off while typing.
[in] | conf | The touchpad config |
[in] | active | disable touchpad while typing |
void mir_touchpad_config_set_disable_with_mouse | ( | MirTouchpadConfig * | conf, |
bool | active | ||
) |
Configure whether the touchpad should be turned off while a mouse is attached.
[in] | conf | The touchpad config |
[in] | active | disable touchpad with mouse |
void mir_touchpad_config_set_middle_mouse_button_emulation | ( | MirTouchpadConfig * | conf, |
bool | middle_emulation | ||
) |
Configure whether middle mouse button emulation should be enabled.
[in] | conf | The touchpad config |
[in] | middle_emulation |
void mir_touchpad_config_set_scroll_modes | ( | MirTouchpadConfig * | conf, |
MirTouchpadScrollModes | modes | ||
) |
Configure the enabled scroll modes for the touchpad.
[in] | conf | The touchpad config |
[in] | modes | the enabled scroll modes |
void mir_touchpad_config_set_tap_to_click | ( | MirTouchpadConfig * | conf, |
bool | tap_to_click | ||
) |
Configure whether tap to click should be enabled.
[in] | conf | The touchpad config |
[in] | tap_to_click |
enum MirTouchscreenMappingMode mir_touchscreen_config_get_mapping_mode | ( | MirTouchscreenConfig const * | device | ) |
Get the mapping mode used for the touchscreen.
[in] | device | The touchscreen configuration |
uint32_t mir_touchscreen_config_get_output_id | ( | MirTouchscreenConfig const * | device | ) |
Get the output ID of the display the coordinates of this device will be mapped to.
This setting is ignored when the mapping mode is set to mir_touchscreen_mapping_mode_to_display_wall.
[in] | device | The touchscreen configuration |
void mir_touchscreen_config_set_mapping_mode | ( | MirTouchscreenConfig * | config, |
enum MirTouchscreenMappingMode | mode | ||
) |
Set the mapping mode used for the touchscreen.
[in] | config | The touchscreen configuration |
[in] | mode | The mapping mode |
void mir_touchscreen_config_set_output_id | ( | MirTouchscreenConfig * | config, |
uint32_t | output | ||
) |
Set the output ID of the display the coordinates of this device will be mapped to.
This setting is ignored when the mapping mode is set to mir_touchscreen_mapping_mode_to_display_wall.
[in] | config | The touchscreen configuration |
[in] | output | The output id |
void mir_wait_for | ( | MirWaitHandle * | wait_handle | ) |
Wait on the supplied handle until all instances of the associated request have completed.
Returns immediately if zero are pending.
[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. Unlike mir_wait_for, this function does not return if zero are pending and instead waits for one.
[in] | wait_handle | Handle returned by an asynchronous request |
void mir_window_apply_spec | ( | MirWindow * | window, |
MirWindowSpec * | spec | ||
) |
Request changes to the specification of a window.
The server will decide whether and how the request can be honoured.
[in] | window | The window to mutate |
[in] | spec | Spec with the requested changes applied |
void mir_window_configure_cursor | ( | MirWindow * | window, |
MirCursorConfiguration const * | parameters | ||
) |
Choose the cursor state for a window: whether a cursor is shown, and which cursor if so.
[in] | window | The window to operate on |
[in] | parameters | The configuration parameters obtained from mir_cursor* family of functions. |
MirWindowAttrib mir_window_event_get_attribute | ( | MirWindowEvent const * | event | ) |
Retrieve the attribute index configured with a given MirWindowEvent.
[in] | event | The event |
int mir_window_event_get_attribute_value | ( | MirWindowEvent const * | event | ) |
Retrieve the new value of the associated attribute for a given MirWindowEvent.
[in] | event | The event |
MirBufferStream* mir_window_get_buffer_stream | ( | MirWindow * | window | ) |
Retrieve the primary MirBufferStream associated with a window (to advance buffers, obtain EGLNativeWindow, etc...)
[in] | window | The window |
MirConnection* mir_window_get_connection | ( | MirWindow * | window | ) |
Retrieve the connection.
[in] | window | a valid MirWindow |
int mir_window_get_dpi | ( | MirWindow * | window | ) |
Query the DPI value of the window (dots per inch).
This will vary depending on the physical display configuration and where the window is within it.
char const* mir_window_get_error_message | ( | MirWindow * | window | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the window or the associated connection has been released.
[in] | window | The window |
MirWindowFocusState mir_window_get_focus_state | ( | MirWindow * | window | ) |
Query the focus state for a window.
[in] | window | The window to operate on |
MirOrientation mir_window_get_orientation | ( | MirWindow * | window | ) |
Get the orientation of a window.
[in] | window | The window to query |
void mir_window_get_parameters | ( | MirWindow * | window, |
MirWindowParameters * | parameters | ||
) |
Get a window's parameters.
[in] | window | The window |
[out] | parameters | Structure to be populated |
MirOrientationMode mir_window_get_preferred_orientation | ( | MirWindow * | window | ) |
Get the preferred orientation modes of a window.
[in] | window | The window to query |
MirWindowState mir_window_get_state | ( | MirWindow * | window | ) |
Get the current state of a window.
[in] | window | The window to query |
MirWindowType mir_window_get_type | ( | MirWindow * | window | ) |
Get the type (purpose) of a window.
[in] | window | The window to query |
MirWindowVisibility mir_window_get_visibility | ( | MirWindow * | window | ) |
Query the visibility state for a window.
[in] | window | The window to operate on |
char const* mir_window_id_as_string | ( | MirWindowId * | id | ) |
Get a string representation of a MirSurfaceId.
[in] | id | The ID to serialise |
MirWindowId* mir_window_id_from_string | ( | char const * | string_representation | ) |
Deserialise a string representation of a MirSurfaceId.
[in] | string_representation | Serialised representation of the ID |
bool mir_window_id_is_valid | ( | MirWindowId * | id | ) |
Check the validity of a MirWindowId.
[in] | id | The MirWindowId |
void mir_window_id_release | ( | MirWindowId * | id | ) |
Free a MirWindowId.
[in] | id | The MirWindowId to free |
bool mir_window_is_valid | ( | MirWindow * | window | ) |
Test for a valid window.
[in] | window | The window |
int mir_window_output_event_get_dpi | ( | MirWindowOutputEvent const * | ev | ) |
Retrieve the DPI of the new output configuration of a MirWindowOutputEvent.
[in] | ev | The event |
MirFormFactor mir_window_output_event_get_form_factor | ( | MirWindowOutputEvent const * | ev | ) |
Retrieve the form factor of the new output configuration of a MirWindowOutputEvent.
[in] | ev | The event |
uint32_t mir_window_output_event_get_output_id | ( | MirWindowOutputEvent const * | ev | ) |
Retrieve the ID of the output this window is on from a MirWindowOutputEvent.
[in] | ev | The event |
double mir_window_output_event_get_refresh_rate | ( | MirWindowOutputEvent const * | ev | ) |
Retrieve the maximum refresh rate of the output(s) associated with a MirWindowOutputEvent.
For variable refresh rate displays this represents the maximum refresh rate of the display to aim for, rather than a measurement of recent performance.
[in] | ev | The event |
float mir_window_output_event_get_scale | ( | MirWindowOutputEvent const * | ev | ) |
Retrieve the suggested scaling factor of the new output configuration of a MirWindowOutputEvent.
[in] | ev | The event |
MirRectangle mir_window_placement_get_relative_position | ( | MirWindowPlacementEvent const * | event | ) |
Retrieve the relative position from a placement notification.
[in] | event | The placement event |
Attempts to raise the window to the front.
[in] | window | The window to raise |
[in] | cookie | A cookie instance obtained from an input event. An invalid cookie will terminate the client connection. |
void mir_window_release | ( | MirWindow * | window, |
MirWindowCallback | callback, | ||
void * | context | ||
) |
Release the supplied window and any associated buffer.
[in] | window | The window |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_window_release_sync | ( | MirWindow * | window | ) |
Release the specified window like in mir_window_release(), but also wait for the operation to complete.
[in] | window | The window to be released |
void mir_window_request_persistent_id | ( | MirWindow * | window, |
MirWindowIdCallback | callback, | ||
void * | context | ||
) |
Request an ID for the window that can be shared cross-process and across restarts.
This call acquires a MirWindowId for this MirWindow. This MirWindowId can be serialized to a string, stored or sent to another process, and then later deserialized to refer to the same window.
[in] | window | The window 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_window_request_persistent_id_sync | ( | MirWindow * | window | ) |
Request a persistent ID for a window and wait for the result.
[in] | window | The window to acquire a persistent ID for. |
Informs the window manager that the user is moving the window.
[in] | window | The window to move |
[in] | cookie | A cookie instance obtained from an input event. An invalid cookie will terminate the client connection. |
void mir_window_request_user_resize | ( | MirWindow * | window, |
MirResizeEdge | edge, | ||
MirCookie const * | cookie | ||
) |
Informs the window manager that the user is resizing the window.
[in] | window | The window to resize |
[in] | edge | The edge being dragged |
[in] | cookie | A cookie instance obtained from an input event. An invalid cookie will terminate the client connection. |
void mir_window_request_window_id | ( | MirWindow * | window, |
MirWindowIdCallback | callback, | ||
void * | context | ||
) |
MirWindowId* mir_window_request_window_id_sync | ( | MirWindow * | window | ) |
void mir_window_set_event_handler | ( | MirWindow * | window, |
MirWindowEventCallback | callback, | ||
void * | context | ||
) |
Set the event handler to be called when events arrive for a window.
[in] | window | The window |
[in] | callback | The callback function |
[in] | context | Additional argument to be passed to callback |
void mir_window_set_preferred_orientation | ( | MirWindow * | window, |
MirOrientationMode | orientation | ||
) |
Request to set the preferred orientations of a window.
The request may be rejected by the server; to check wait on the result and check the applied value using mir_window_get_preferred_orientation
[in] | window | The window to operate on |
[in] | orientation | The preferred orientation modes |
void mir_window_set_state | ( | MirWindow * | window, |
MirWindowState | state | ||
) |
Change the state of a window.
[in] | window | The window to operate on |
[in] | state | The new state of the window |
void mir_window_spec_add_render_surface | ( | MirWindowSpec * | spec, |
MirRenderSurface * | render_surface, | ||
int | logical_width, | ||
int | logical_height, | ||
int | displacement_x, | ||
int | displacement_y | ||
) |
Set the MirWindowSpec to display content contained in a render surface.
spec | The window_spec to be updated |
render_surface | The render surface containing the content to be displayed |
logical_width | The width that the content will be displayed at (Ignored for buffer streams) |
logical_height | The height that the content will be displayed at (Ignored for buffer streams) |
displacement_x | The x displacement from the top-left corner of the MirWindow |
displacement_y | The y displacement from the top-left corner of the MirWindow |
bool mir_window_spec_attach_to_foreign_parent | ( | MirWindowSpec * | spec, |
MirWindowId * | parent, | ||
MirRectangle * | attachment_rect, | ||
MirEdgeAttachment | edge | ||
) |
Request that the created window be attached to a window of a different client.
This is restricted to input methods, which need to attach their suggestion window to text entry widgets of other processes.
[in] | spec | Specification to mutate |
[in] | parent | A MirWindowId reference to the parent window |
[in] | attachment_rect | A rectangle specifying the region (in parent window coordinates) that the created window should be attached to. |
[in] | edge | The preferred edge direction to attach to. Use mir_edge_attachment_any for no preference. |
void mir_window_spec_release | ( | MirWindowSpec * | spec | ) |
Release the resources held by a MirWindowSpec.
[in] | spec | Specification to release |
void mir_window_spec_set_buffer_usage | ( | MirWindowSpec * | spec, |
MirBufferUsage | usage | ||
) |
Set the requested buffer usage.
[in] | spec | Specification to mutate |
[in] | usage | Requested buffer usage |
void mir_window_spec_set_cursor_name | ( | MirWindowSpec * | spec, |
char const * | name | ||
) |
Set the name for the cursor from the system cursor theme.
[in] | spec | The spec |
[in] | name | The name, or "" to reset to default |
void mir_window_spec_set_cursor_render_surface | ( | MirWindowSpec * | spec, |
MirRenderSurface * | render_surface, | ||
int | hotspot_x, | ||
int | hotspot_y | ||
) |
Set the MirWindowSpec to contain a specific cursor.
[in] | spec | The spec |
[in] | render_surface | The rendersurface to set, or nullptr to reset to default cursor. |
[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 |
void mir_window_spec_set_event_handler | ( | MirWindowSpec * | spec, |
MirWindowEventCallback | callback, | ||
void * | context | ||
) |
Set the event handler to be called when events arrive for a window.
[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_window_spec_set_fullscreen_on_output | ( | MirWindowSpec * | spec, |
uint32_t | output_id | ||
) |
[in] | spec | Specification to mutate |
[in] | output_id | ID of output to place window on. From MirDisplayOutput.output_id |
void mir_window_spec_set_height | ( | MirWindowSpec * | spec, |
unsigned | height | ||
) |
Set the requested height, in pixels.
[in] | spec | Specification to mutate |
[in] | height | Requested height. |
void mir_window_spec_set_height_increment | ( | MirWindowSpec * | 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 window prefers to be resized.
[in] | spec | Specification to mutate |
[in] | height_inc | Requested height increment. |
void mir_window_spec_set_input_shape | ( | MirWindowSpec * | spec, |
MirRectangle const * | rectangles, | ||
size_t | n_rects | ||
) |
Set a collection of input rectangles associated with the spec.
Rectangles are specified as a list of regions relative to the top left of the specified window. If the server applies this specification to a window input which would normally go to the window 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] | n_rects | The number of elements in the rectangles array. |
void mir_window_spec_set_max_aspect_ratio | ( | MirWindowSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
Set the maximum aspect ratio.
This is the maximum ratio of window 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_window_spec_set_max_height | ( | MirWindowSpec * | spec, |
unsigned | max_height | ||
) |
Set the maximum height, in pixels.
[in] | spec | Specification to mutate |
[in] | max_height | maximum height. |
void mir_window_spec_set_max_width | ( | MirWindowSpec * | spec, |
unsigned | max_width | ||
) |
Set the maximum width, in pixels.
[in] | spec | Specification to mutate |
[in] | max_width | maximum width. |
void mir_window_spec_set_min_aspect_ratio | ( | MirWindowSpec * | spec, |
unsigned | width, | ||
unsigned | height | ||
) |
Set the minimum aspect ratio.
This is the minimum ratio of window 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_window_spec_set_min_height | ( | MirWindowSpec * | spec, |
unsigned | min_height | ||
) |
Set the minimum height, in pixels.
[in] | spec | Specification to mutate |
[in] | min_height | Minimum height. |
void mir_window_spec_set_min_width | ( | MirWindowSpec * | spec, |
unsigned | min_width | ||
) |
Set the minimum width, in pixels.
[in] | spec | Specification to mutate |
[in] | min_width | Minimum width. |
void mir_window_spec_set_name | ( | MirWindowSpec * | spec, |
char const * | name | ||
) |
Set the requested name.
The window 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_window_spec_set_parent | ( | MirWindowSpec * | spec, |
MirWindow * | parent | ||
) |
Set the requested parent.
[in] | spec | Specification to mutate |
[in] | parent | A valid parent window. |
void mir_window_spec_set_pixel_format | ( | MirWindowSpec * | spec, |
MirPixelFormat | format | ||
) |
Set the requested pixel format.
[in] | spec | Specification to mutate |
[in] | format | Requested pixel format |
void mir_window_spec_set_placement | ( | MirWindowSpec * | spec, |
const MirRectangle * | rect, | ||
MirPlacementGravity | rect_gravity, | ||
MirPlacementGravity | window_gravity, | ||
MirPlacementHints | placement_hints, | ||
int | offset_dx, | ||
int | offset_dy | ||
) |
Set the window placement on the spec.
[in] | spec | the spec to update |
[in] | rect | the destination rectangle to align with |
[in] | rect_gravity | the point on rect to align with |
[in] | window_gravity | the point on the window to align with |
[in] | placement_hints | positioning hints to use when limited on space |
[in] | offset_dx | horizontal offset to shift w.r.t. rect |
[in] | offset_dy | vertical offset to shift w.r.t. rect |
Moves a window to rect
, aligning their reference points.
rect
is relative to the top-left corner of the parent window. rect_gravity
and surface_gravity
determine the points on rect
and the window to pin together. rect's
alignment point can be offset by offset_dx
and offset_dy
, which is equivalent to offsetting the position of the window.
placement_hints
determine how the window should be positioned in the case that the window would fall off-screen if placed in its ideal position. See MirPlacementHints for details.
void mir_window_spec_set_pointer_confinement | ( | MirWindowSpec * | spec, |
MirPointerConfinementState | state | ||
) |
Attempts to set the pointer confinement spec for this window.
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_window_spec_set_preferred_orientation | ( | MirWindowSpec * | spec, |
MirOrientationMode | mode | ||
) |
Set the requested preferred orientation mode.
[in] | spec | Specification to mutate |
[in] | mode | Requested preferred orientation |
void mir_window_spec_set_shell_chrome | ( | MirWindowSpec * | spec, |
MirShellChrome | style | ||
) |
Ask the shell to customize "chrome" for this window.
For example, on the phone hide indicators when this window is active.
[in] | spec | The spec to accumulate the request in. |
[in] | style | The requested level of "chrome" |
void mir_window_spec_set_state | ( | MirWindowSpec * | spec, |
MirWindowState | state | ||
) |
Set the requested state.
[in] | spec | Specification to mutate |
[in] | state | Requested state |
void mir_window_spec_set_streams | ( | MirWindowSpec * | 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 window, but is not in the list will be disassociated from the window. On application of the spec, a stream that is not present in the window, but is in the list will be associated with the window. Streams set a displacement from the top-left corner of the window.
[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_window_spec_set_type | ( | MirWindowSpec * | spec, |
MirWindowType | type | ||
) |
Update a window specification with a window type.
This can be used with mir_create_window() to create a window or with mir_window_apply_spec() to change an existing window.
[in] | spec | Specification to mutate |
[in] | type | the target type of the window |
void mir_window_spec_set_width | ( | MirWindowSpec * | spec, |
unsigned | width | ||
) |
Set the requested width, in pixels.
[in] | spec | Specification to mutate |
[in] | width | Requested width. |
void mir_window_spec_set_width_increment | ( | MirWindowSpec * | 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 window prefers to be resized.
[in] | spec | Specification to mutate |
[in] | width_inc | Requested width increment. |
void use mir_render_surface apis |
MirPixelFormat the EGL implementation will now set correct pixel format |
|
extern |
The standard arrow cursor (typically the system default)
|
extern |
The "wait" cursor, typically an hourglass or watch used during operations which prevent the user from interacting.
|
extern |
The caret or ibeam cursor, indicating acceptance of text input.
|
extern |
The close handed cursor, typically used to indicate that a drag operation is in process which involves scrolling.
|
extern |
The cursor used for crosshair, which may be used for picking colors or finer precision.
|
extern |
A special cursor name for use with mir_cursor_configuration_from_name representing the system default cursor.
|
extern |
The cursor used to indicate diagonal resizing a top right corner.
|
extern |
The cursor used to indicate diagonal resizing a bottom right corner.
|
extern |
A special cursor name for use with mir_cursor_configuration_from_name representing a disabled cursor image.
|
extern |
The cursor used to indicate a horizontal resize operation.
|
extern |
The cursor used for horizontal splitters, indicating that a handle may be dragged to adjust horizontal space.
|
extern |
The cursor used to indicate resize with no directional constraint.
|
extern |
The open handed cursor, typically used to indicate that the area beneath the cursor may be clicked and dragged around.
|
extern |
The pointing hand cursor, typically used for clickable elements such as hyperlinks.
|
extern |
The cursor used to indicate a vertical resize operation.
|
extern |
The cursor used for vertical splitters, indicating that a handle may be dragged to adjust vertical space.
Copyright © 2012-2020
Canonical Ltd.
Generated on Sun Sep 27 19:03:53 UTC 2020
This documentation is licensed under the GPL version 2 or 3.