Mir
Functions
mir_surface.h File Reference
#include <mir_toolkit/mir_native_buffer.h>
#include <mir_toolkit/client_types.h>
#include <mir_toolkit/common.h>
#include <mir_toolkit/mir_cursor_configuration.h>
#include <stdbool.h>
Include dependency graph for mir_surface.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

MirSurfaceSpecmir_connection_create_spec_for_normal_surface (MirConnection *connection, int width, int height, MirPixelFormat format)
 Create a surface specification for a normal surface. More...
 
MirSurfaceSpecmir_connection_create_spec_for_menu (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge)
 Create a surface specification for a menu surface. More...
 
MirSurfaceSpecmir_connection_create_spec_for_tooltip (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *zone)
 Create a surface specification for a tooltip surface. More...
 
MirSurfaceSpecmir_connection_create_spec_for_modal_dialog (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent)
 Create a surface specification for a modal dialog surface. More...
 
MirSurfaceSpecmir_connection_create_spec_for_dialog (MirConnection *connection, int width, int height, MirPixelFormat format)
 Create a surface specification for a parentless dialog surface. More...
 
MirSurfaceSpecmir_create_surface_spec (MirConnection *connection)
 Create a surface specification. More...
 
MirSurfaceSpecmir_connection_create_spec_for_changes (MirConnection *connection)
 Create a surface specification for updating a surface. More...
 
MirWaitHandlemir_surface_create (MirSurfaceSpec *requested_specification, mir_surface_callback callback, void *context)
 Create a surface from a given specification. More...
 
MirSurfacemir_surface_create_sync (MirSurfaceSpec *requested_specification)
 Create a surface from a given specification and wait for the result. More...
 
void mir_surface_spec_set_parent (MirSurfaceSpec *spec, MirSurface *parent)
 Set the requested parent. More...
 
void mir_surface_spec_set_type (MirSurfaceSpec *spec, MirSurfaceType type)
 Update a surface specification with a surface type. More...
 
void mir_surface_spec_set_name (MirSurfaceSpec *spec, char const *name)
 Set the requested name. More...
 
void mir_surface_spec_set_width (MirSurfaceSpec *spec, unsigned width)
 Set the requested width, in pixels. More...
 
void mir_surface_spec_set_height (MirSurfaceSpec *spec, unsigned height)
 Set the requested height, in pixels. More...
 
void mir_surface_spec_set_width_increment (MirSurfaceSpec *spec, unsigned width_inc)
 Set the requested width increment, in pixels. More...
 
void mir_surface_spec_set_height_increment (MirSurfaceSpec *spec, unsigned height_inc)
 Set the requested height increment, in pixels Defines an arithmetic progression of sizes starting with min_height (if set, otherwise 0) into which the surface prefers to be resized. More...
 
void mir_surface_spec_set_min_width (MirSurfaceSpec *spec, unsigned min_width)
 Set the minimum width, in pixels. More...
 
void mir_surface_spec_set_min_height (MirSurfaceSpec *spec, unsigned min_height)
 Set the minimum height, in pixels. More...
 
void mir_surface_spec_set_max_width (MirSurfaceSpec *spec, unsigned max_width)
 Set the maximum width, in pixels. More...
 
void mir_surface_spec_set_max_height (MirSurfaceSpec *spec, unsigned max_height)
 Set the maximum height, in pixels. More...
 
void mir_surface_spec_set_min_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height)
 Set the minimum aspect ratio. More...
 
void mir_surface_spec_set_max_aspect_ratio (MirSurfaceSpec *spec, unsigned width, unsigned height)
 Set the maximum aspect ratio. More...
 
void mir_surface_spec_set_pixel_format (MirSurfaceSpec *spec, MirPixelFormat format)
 Set the requested pixel format. More...
 
void mir_surface_spec_set_buffer_usage (MirSurfaceSpec *spec, MirBufferUsage usage)
 Set the requested buffer usage. More...
 
void mir_surface_spec_set_fullscreen_on_output (MirSurfaceSpec *spec, uint32_t output_id)
 
void mir_surface_spec_set_preferred_orientation (MirSurfaceSpec *spec, MirOrientationMode mode)
 Set the requested preferred orientation mode. More...
 
bool mir_surface_spec_attach_to_foreign_parent (MirSurfaceSpec *spec, MirPersistentId *parent, MirRectangle *attachment_rect, MirEdgeAttachment edge)
 Request that the created surface be attached to a surface of a different client. More...
 
void mir_surface_spec_set_state (MirSurfaceSpec *spec, MirSurfaceState state)
 Set the requested state. More...
 
void mir_surface_spec_release (MirSurfaceSpec *spec)
 Release the resources held by a MirSurfaceSpec. More...
 
void mir_surface_spec_set_streams (MirSurfaceSpec *spec, MirBufferStreamInfo *streams, unsigned int num_streams)
 Set the streams associated with the spec. More...
 
void mir_surface_spec_set_input_shape (MirSurfaceSpec *spec, MirRectangle const *rectangles, size_t n_rects)
 Set a collection of input rectangles assosciated with the spec. More...
 
void mir_surface_spec_set_event_handler (MirSurfaceSpec *spec, mir_surface_event_callback callback, void *context)
 
void mir_surface_set_event_handler (MirSurface *surface, mir_surface_event_callback callback, void *context)
 Set the event handler to be called when events arrive for a surface. More...
 
MirBufferStreammir_surface_get_buffer_stream (MirSurface *surface)
 Retrieve the primary MirBufferStream associated with a surface (to advance buffers, obtain EGLNativeWindow, etc...) More...
 
bool mir_surface_is_valid (MirSurface *surface)
 Test for a valid surface. More...
 
char const * mir_surface_get_error_message (MirSurface *surface)
 Retrieve a text description of the error. More...
 
void mir_surface_get_parameters (MirSurface *surface, MirSurfaceParameters *parameters)
 Get a surface's parameters. More...
 
MirWaitHandlemir_surface_release (MirSurface *surface, mir_surface_callback callback, void *context)
 Release the supplied surface and any associated buffer. More...
 
void mir_surface_release_sync (MirSurface *surface)
 Release the specified surface like in mir_surface_release(), but also wait for the operation to complete. More...
 
MirSurfaceType mir_surface_get_type (MirSurface *surface)
 Get the type (purpose) of a surface. More...
 
MirWaitHandlemir_surface_set_state (MirSurface *surface, MirSurfaceState state)
 Change the state of a surface. More...
 
MirSurfaceState mir_surface_get_state (MirSurface *surface)
 Get the current state of a surface. More...
 
MirWaitHandlemir_surface_set_swapinterval (MirSurface *surface, int interval)
 Set the swapinterval for mir_surface_swap_buffers. More...
 
int mir_surface_get_swapinterval (MirSurface *surface)
 Query the swapinterval that the surface is operating with. More...
 
int mir_surface_get_dpi (MirSurface *surface)
 Query the DPI value of the surface (dots per inch). More...
 
MirSurfaceFocusState mir_surface_get_focus (MirSurface *surface)
 Query the focus state for a surface. More...
 
MirSurfaceVisibility mir_surface_get_visibility (MirSurface *surface)
 Query the visibility state for a surface. More...
 
MirWaitHandlemir_surface_configure_cursor (MirSurface *surface, MirCursorConfiguration const *parameters)
 Choose the cursor state for a surface: whether a cursor is shown, and which cursor if so. More...
 
MirOrientation mir_surface_get_orientation (MirSurface *surface)
 Get the orientation of a surface. More...
 
MirWaitHandlemir_surface_set_preferred_orientation (MirSurface *surface, MirOrientationMode orientation)
 Request to set the preferred orientations of a surface. More...
 
MirOrientationMode mir_surface_get_preferred_orientation (MirSurface *surface)
 Get the preferred orientation modes of a surface. More...
 
MirSurfaceSpecmir_connection_create_spec_for_input_method (MirConnection *connection, int width, int height, MirPixelFormat format)
 Create a surface specification for an input method surface. More...
 
void mir_surface_apply_spec (MirSurface *surface, MirSurfaceSpec *spec)
 Request changes to the specification of a surface. More...
 
MirWaitHandlemir_surface_request_persistent_id (MirSurface *surface, mir_surface_id_callback callback, void *context)
 Request an ID for the surface that can be shared cross-process and across restarts. More...
 
MirPersistentIdmir_surface_request_persistent_id_sync (MirSurface *surface)
 Request a persistent ID for a surface and wait for the result. More...
 
bool mir_persistent_id_is_valid (MirPersistentId *id)
 Check the validity of a MirPersistentId. More...
 
void mir_persistent_id_release (MirPersistentId *id)
 Free a MirPersistentId. More...
 
char const * mir_persistent_id_as_string (MirPersistentId *id)
 Get a string representation of a MirSurfaceId. More...
 
MirPersistentIdmir_persistent_id_from_string (char const *string_representation)
 Deserialise a string representation of a MirSurfaceId. More...
 

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015