Mir
|
Classes | |
struct | MirWaitHandle |
struct | MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface. More... | |
struct | MirPlatformPackage |
struct | MirGraphicsRegion |
Retrieved information about a MirSurface. More... | |
struct | MirDisplayInfo |
struct | MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment. More... | |
struct | MirDisplayMode |
struct | MirDisplayOutput |
struct | MirDisplayConfiguration |
struct | MirEventDelegate |
MirEventDelegate may be used to specify (at surface creation time) callbacks for handling of events. 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 | MirKeyEvent |
struct | MirMotionEvent |
struct | MirSurfaceEvent |
struct | MirResizeEvent |
union | MirEvent |
struct | MirMesaEGLNativeDisplay |
struct | MirMesaEGLNativeSurface |
Macros | |
#define | MIR_BYTES_PER_PIXEL(f) (((f) == mir_pixel_format_bgr_888) ? 3 : 4) |
#define | MIR_INPUT_EVENT_MAX_POINTER_COUNT 16 |
Typedefs | |
typedef void(* | mir_drm_auth_magic_callback )(int status, void *context) |
typedef enum MirBool | MirBool |
typedef void * | MirEGLNativeWindowType |
typedef void * | MirEGLNativeDisplayType |
typedef struct MirConnection | MirConnection |
typedef struct MirSurface | MirSurface |
typedef struct MirScreencast | MirScreencast |
typedef struct MirWaitHandle | MirWaitHandle |
Returned by asynchronous functions. More... | |
typedef void(* | mir_connected_callback )(MirConnection *connection, void *client_context) |
Callback to be passed when issuing a mir_connect request. More... | |
typedef void(* | mir_surface_callback )(MirSurface *surface, void *client_context) |
Callback to be passed when calling: More... | |
typedef void(* | mir_event_delegate_callback )(MirSurface *surface, MirEvent const *event, void *context) |
Callback member of MirEventDelegate for handling of events. More... | |
typedef void(* | mir_lifecycle_event_callback )(MirConnection *connection, MirLifecycleState state, void *context) |
Callback called when a lifecycle event/callback is requested from the running server. More... | |
typedef void(* | mir_display_config_callback )(MirConnection *connection, void *context) |
Callback called when a display config change has occurred. More... | |
typedef enum MirBufferUsage | MirBufferUsage |
MirBufferUsage specifies how a surface can and will be used. More... | |
typedef struct MirSurfaceParameters | MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface. More... | |
typedef enum MirPlatformType | MirPlatformType |
The native buffer type for the system the client is connected on. More... | |
typedef struct MirPlatformPackage | MirPlatformPackage |
typedef struct MirGraphicsRegion | MirGraphicsRegion |
Retrieved information about a MirSurface. More... | |
typedef struct MirDisplayInfo | MirDisplayInfo |
typedef struct MirDisplayCard | MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment. More... | |
typedef enum MirDisplayOutputType | MirDisplayOutputType |
typedef struct MirDisplayMode | MirDisplayMode |
typedef struct MirDisplayOutput | MirDisplayOutput |
typedef struct MirDisplayConfiguration | MirDisplayConfiguration |
typedef struct MirEventDelegate | MirEventDelegate |
MirEventDelegate may be used to specify (at surface creation time) callbacks for handling of events. More... | |
typedef struct MirRectangle | MirRectangle |
typedef struct MirScreencastParameters | MirScreencastParameters |
MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast. More... | |
typedef void(* | mir_screencast_callback )(MirScreencast *screencast, void *client_context) |
Callback to be passed when calling MirScreencast functions. More... | |
typedef enum MirSurfaceAttrib | MirSurfaceAttrib |
Attributes of a surface that the client and server/shell may wish to get or set over the wire. More... | |
typedef enum MirSurfaceType | MirSurfaceType |
typedef enum MirSurfaceState | MirSurfaceState |
typedef enum MirSurfaceFocusState | MirSurfaceFocusState |
typedef enum MirLifecycleState | MirLifecycleState |
typedef enum MirPowerMode | MirPowerMode |
typedef enum MirPixelFormat | MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format. More... | |
typedef enum MirOrientation | MirOrientation |
typedef int64_t | nsecs_t |
typedef struct MirMesaEGLNativeDisplay | MirMesaEGLNativeDisplay |
typedef struct MirMesaEGLNativeSurface | MirMesaEGLNativeSurface |
typedef int(* | MirMesaEGLNativeDisplayIsValidFunc )(MirMesaEGLNativeDisplay *display) |
Functions | |
MirWaitHandle * | mir_connect (char const *server, char const *app_name, mir_connected_callback callback, void *context) |
Request a connection to the Mir server. More... | |
MirConnection * | mir_connect_sync (char const *server, char const *app_name) |
Perform a mir_connect() but also wait for and return the result. More... | |
MirBool | mir_connection_is_valid (MirConnection *connection) |
Test for a valid connection. More... | |
char const * | mir_connection_get_error_message (MirConnection *connection) |
Retrieve a text description of the last error. More... | |
void | mir_connection_release (MirConnection *connection) |
Release a connection to the Mir server. More... | |
void | mir_connection_get_platform (MirConnection *connection, MirPlatformPackage *platform_package) |
Query platform-specific data and/or file descriptors that are required to initialize GL/EGL features. More... | |
void | mir_connection_set_lifecycle_event_callback (MirConnection *connection, mir_lifecycle_event_callback callback, void *context) |
Register a callback to be called when a Lifecycle state change occurs. More... | |
__attribute__ ((__deprecated__("Use mir_connection_create_display_config()"))) void mir_connection_get_display_info(MirConnection *connection | |
MirDisplayConfiguration * | mir_connection_create_display_config (MirConnection *connection) |
Query the display. More... | |
void | mir_connection_set_display_config_change_callback (MirConnection *connection, mir_display_config_callback callback, void *context) |
Register a callback to be called when the hardware display configuration changes. More... | |
void | mir_display_config_destroy (MirDisplayConfiguration *display_configuration) |
Destroy the DisplayConfiguration resource acquired from mir_connection_create_display_config. More... | |
MirWaitHandle * | mir_connection_apply_display_config (MirConnection *connection, MirDisplayConfiguration *display_configuration) |
Apply the display configuration. More... | |
MirEGLNativeDisplayType | mir_connection_get_egl_native_display (MirConnection *connection) |
Get a display type that can be used for OpenGL ES 2.0 acceleration. More... | |
void | mir_connection_get_available_surface_formats (MirConnection *connection, MirPixelFormat *formats, unsigned const int format_size, unsigned int *num_valid_formats) |
Get the list of possible formats that a surface can be created with. More... | |
MirWaitHandle * | mir_connection_create_surface (MirConnection *connection, MirSurfaceParameters const *surface_parameters, mir_surface_callback callback, void *context) |
Request a new Mir surface on the supplied connection with the supplied parameters. More... | |
MirSurface * | mir_connection_create_surface_sync (MirConnection *connection, MirSurfaceParameters const *params) |
Create a surface like in mir_connection_create_surface(), but also wait for creation to complete and return the resulting surface. More... | |
void | mir_surface_set_event_handler (MirSurface *surface, MirEventDelegate const *event_handler) |
Set the event handler to be called when events arrive for a surface. More... | |
MirEGLNativeWindowType | mir_surface_get_egl_native_window (MirSurface *surface) |
Get a window type that can be used for OpenGL ES 2.0 acceleration. More... | |
MirBool | mir_surface_is_valid (MirSurface *surface) |
Test for a valid surface. More... | |
char const * | mir_surface_get_error_message (MirSurface *surface) |
Retrieve a text description of the error. More... | |
void | mir_surface_get_parameters (MirSurface *surface, MirSurfaceParameters *parameters) |
Get a surface's parameters. More... | |
MirPlatformType | mir_surface_get_platform_type (MirSurface *surface) |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_surface_get_current_buffer() can be understood. More... | |
void | mir_surface_get_current_buffer (MirSurface *surface, MirNativeBuffer **buffer_package) |
Get a surface's buffer in "raw" representation. More... | |
void | mir_surface_get_graphics_region (MirSurface *surface, MirGraphicsRegion *graphics_region) |
Get a surface's graphics_region, i.e., map the graphics buffer to main memory. More... | |
MirWaitHandle * | mir_surface_swap_buffers (MirSurface *surface, mir_surface_callback callback, void *context) |
Advance a surface's buffer. More... | |
void | mir_surface_swap_buffers_sync (MirSurface *surface) |
Advance a surface's buffer as in mir_surface_swap_buffers(), but also wait for the operation to complete. More... | |
MirWaitHandle * | mir_surface_release (MirSurface *surface, mir_surface_callback callback, void *context) |
Release the supplied surface and any associated buffer. More... | |
void | mir_surface_release_sync (MirSurface *surface) |
Release the specified surface like in mir_surface_release(), but also wait for the operation to complete. More... | |
void | mir_wait_for (MirWaitHandle *wait_handle) |
Wait on the supplied handle until all instances of the associated request have completed. More... | |
void | mir_wait_for_one (MirWaitHandle *wait_handle) |
Wait on the supplied handle until one instance of the associated request has completed. More... | |
__attribute__ ((__deprecated__("Use mir_debug_surface_id()"))) int mir_surface_get_id(MirSurface *surface) | |
MirWaitHandle * | mir_surface_set_type (MirSurface *surface, MirSurfaceType type) |
Set the type (purpose) of a surface. More... | |
MirSurfaceType | mir_surface_get_type (MirSurface *surface) |
Get the type (purpose) of a surface. More... | |
MirWaitHandle * | mir_surface_set_state (MirSurface *surface, MirSurfaceState state) |
Change the state of a surface. More... | |
MirSurfaceState | mir_surface_get_state (MirSurface *surface) |
Get the current state of a surface. More... | |
MirWaitHandle * | mir_surface_set_swapinterval (MirSurface *surface, int interval) |
Set the swapinterval for mir_surface_swap_buffers. More... | |
int | mir_surface_get_swapinterval (MirSurface *surface) |
Query the swapinterval that the surface is operating with. More... | |
MirWaitHandle * | mir_connection_drm_auth_magic (MirConnection *connection, unsigned int magic, mir_drm_auth_magic_callback callback, void *context) |
int | mir_connection_drm_set_gbm_device (MirConnection *connection, struct gbm_device *dev) |
Set the gbm_device to be used by the EGL implementation. More... | |
MirScreencast * | mir_connection_create_screencast_sync (MirConnection *connection, MirScreencastParameters *parameters) |
Create a screencast on the supplied connection. More... | |
void | mir_screencast_release_sync (MirScreencast *screencast) |
Release the specified screencast. More... | |
MirEGLNativeWindowType | mir_screencast_egl_native_window (MirScreencast *screencast) |
Get a window type that can be used by EGL. More... | |
Variables | |
MirDisplayInfo * | display_info |
#define MIR_BYTES_PER_PIXEL | ( | f | ) | (((f) == mir_pixel_format_bgr_888) ? 3 : 4) |
#define MIR_INPUT_EVENT_MAX_POINTER_COUNT 16 |
typedef void(* mir_connected_callback)(MirConnection *connection, void *client_context) |
Callback to be passed when issuing a mir_connect request.
[in] | connection | the new connection |
[in,out] | client_context | context provided by client in calling mir_connect |
typedef void(* mir_display_config_callback)(MirConnection *connection, void *context) |
Callback called when a display config change has occurred.
[in] | connection | The connection associated with the display change |
[in,out] | context | The context provided by client |
typedef void(* mir_drm_auth_magic_callback)(int status, void *context) |
typedef void(* mir_event_delegate_callback)(MirSurface *surface, MirEvent const *event, void *context) |
Callback member of MirEventDelegate for handling of events.
[in] | surface | The surface on which an event has occurred |
[in] | event | The event to be handled |
[in,out] | context | The context provided by client during delegate registration. |
typedef void(* mir_lifecycle_event_callback)(MirConnection *connection, MirLifecycleState state, void *context) |
Callback called when a lifecycle event/callback is requested from the running server.
[in] | connection | The connection associated with the lifecycle event |
[in] | cb | The callback requested |
[in,out] | context | The context provided by the client |
typedef void(* mir_screencast_callback)(MirScreencast *screencast, void *client_context) |
Callback to be passed when calling MirScreencast functions.
[in] | screencast | the screencast being updated |
[in,out] | client_context | context provided by the client |
typedef void(* mir_surface_callback)(MirSurface *surface, void *client_context) |
Callback to be passed when calling:
[in] | surface | the surface being updated |
[in,out] | client_context | context provided by client in calling mir_connect |
typedef enum MirBufferUsage MirBufferUsage |
MirBufferUsage specifies how a surface can and will be used.
A "hardware" surface can be used for OpenGL accelerated rendering. A "software" surface is one that can be addressed in main memory and blitted to directly.
typedef struct MirConnection MirConnection |
typedef struct MirDisplayCard MirDisplayCard |
MirDisplayConfiguration provides details of the graphics environment.
typedef struct MirDisplayConfiguration MirDisplayConfiguration |
typedef struct MirDisplayInfo MirDisplayInfo |
typedef struct MirDisplayMode MirDisplayMode |
typedef struct MirDisplayOutput MirDisplayOutput |
typedef enum MirDisplayOutputType MirDisplayOutputType |
typedef void* MirEGLNativeDisplayType |
typedef void* MirEGLNativeWindowType |
typedef struct MirEventDelegate MirEventDelegate |
MirEventDelegate may be used to specify (at surface creation time) callbacks for handling of events.
typedef struct MirGraphicsRegion MirGraphicsRegion |
Retrieved information about a MirSurface.
This is most useful for learning how and where to write to a 'mir_buffer_usage_software' surface.
typedef enum MirLifecycleState MirLifecycleState |
typedef struct MirMesaEGLNativeDisplay MirMesaEGLNativeDisplay |
typedef int(* MirMesaEGLNativeDisplayIsValidFunc)(MirMesaEGLNativeDisplay *display) |
typedef struct MirMesaEGLNativeSurface MirMesaEGLNativeSurface |
typedef enum MirOrientation MirOrientation |
typedef enum MirPixelFormat MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format.
For example, abgr_8888 corresponds to 0xAABBGGRR, which will end up as R,G,B,A in memory in a little endian system, and as A,B,G,R in memory in a big endian system.
typedef struct MirPlatformPackage MirPlatformPackage |
typedef enum MirPlatformType MirPlatformType |
The native buffer type for the system the client is connected on.
typedef enum MirPowerMode MirPowerMode |
typedef struct MirRectangle MirRectangle |
typedef struct MirScreencast MirScreencast |
typedef struct MirScreencastParameters MirScreencastParameters |
MirScreencastParameters is the structure of required information that you must provide to Mir in order to create a MirScreencast.
The width and height parameters can be used to down-scale the screencast For no scaling set them to the region width and height.
typedef struct MirSurface MirSurface |
typedef enum MirSurfaceAttrib MirSurfaceAttrib |
Attributes of a surface that the client and server/shell may wish to get or set over the wire.
typedef enum MirSurfaceFocusState MirSurfaceFocusState |
typedef struct MirSurfaceParameters MirSurfaceParameters |
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in order to create a surface.
typedef enum MirSurfaceState MirSurfaceState |
typedef enum MirSurfaceType MirSurfaceType |
typedef struct MirWaitHandle MirWaitHandle |
Returned by asynchronous functions.
Must not be free'd by callers. See the individual function documentation for information on the lifetime of wait handles.
typedef int64_t nsecs_t |
anonymous enum |
enum MirBool |
enum MirBufferUsage |
enum MirDisplayOutputType |
enum MirEventType |
enum MirKeyAction |
enum MirKeyFlag |
enum MirKeyModifier |
enum MirLifecycleState |
enum MirMotionAction |
enum MirMotionButton |
enum MirMotionFlag |
enum MirMotionToolType |
enum MirOrientation |
enum MirPixelFormat |
The order of components in a format enum matches the order of the components as they would be written in an integer representing a pixel value of that format.
For example, abgr_8888 corresponds to 0xAABBGGRR, which will end up as R,G,B,A in memory in a little endian system, and as A,B,G,R in memory in a big endian system.
Enumerator | |
---|---|
mir_pixel_format_invalid | |
mir_pixel_format_abgr_8888 | |
mir_pixel_format_xbgr_8888 | |
mir_pixel_format_argb_8888 | |
mir_pixel_format_xrgb_8888 | |
mir_pixel_format_bgr_888 | |
mir_pixel_formats |
enum MirPlatformType |
enum MirPowerMode |
enum MirSurfaceAttrib |
enum MirSurfaceFocusState |
enum MirSurfaceState |
enum MirSurfaceType |
__attribute__ | ( | (__deprecated__("Use mir_connection_create_display_config()")) | ) |
__attribute__ | ( | (__deprecated__("Use mir_debug_surface_id()")) | ) |
MirWaitHandle* mir_connect | ( | char const * | server, |
char const * | app_name, | ||
mir_connected_callback | callback, | ||
void * | context | ||
) |
Request a connection to the Mir server.
The supplied callback is called when the connection is established, or fails. The returned wait handle remains valid until the connection has been released.
[in] | server | File path of the server socket to connect to, or NULL to choose the default server (can be set by the $MIR_SOCKET environment variable) |
[in] | app_name | A name referring to the application |
[in] | callback | Callback function to be invoked when request completes |
[in,out] | context | User data passed to the callback function |
MirConnection* mir_connect_sync | ( | char const * | server, |
char const * | app_name | ||
) |
Perform a mir_connect() but also wait for and return the result.
[in] | server | File path of the server socket to connect to, or NULL to choose the default server |
[in] | app_name | A name referring to the application |
MirWaitHandle* mir_connection_apply_display_config | ( | MirConnection * | connection, |
MirDisplayConfiguration * | display_configuration | ||
) |
Apply the display configuration.
The display configuration is applied to this connection only (per-connection configuration) and is invalidated when a hardware change occurs. Clients should register a callback with mir_connection_set_display_config_change_callback() to get notified about hardware changes, so that the can apply a new configuration.
[in] | connection | The connection |
[in] | display_configuration | The display_configuration to apply |
MirDisplayConfiguration* mir_connection_create_display_config | ( | MirConnection * | connection | ) |
Query the display.
[in] | connection | The connection |
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 |
MirWaitHandle* mir_connection_create_surface | ( | MirConnection * | connection, |
MirSurfaceParameters const * | surface_parameters, | ||
mir_surface_callback | callback, | ||
void * | context | ||
) |
Request a new Mir surface on the supplied connection with the supplied parameters.
The returned handle remains valid until the surface has been released.
[in] | connection | The connection |
[in] | surface_parameters | Request surface parameters |
[in] | callback | Callback function to be invoked when request completes |
[in,out] | context | User data passed to the callback function |
MirSurface* mir_connection_create_surface_sync | ( | MirConnection * | connection, |
MirSurfaceParameters const * | params | ||
) |
Create a surface like in mir_connection_create_surface(), but also wait for creation to complete and return the resulting surface.
[in] | connection | The connection |
[in] | params | Parameters describing the desired surface |
MirWaitHandle* mir_connection_drm_auth_magic | ( | MirConnection * | connection, |
unsigned int | magic, | ||
mir_drm_auth_magic_callback | callback, | ||
void * | context | ||
) |
int mir_connection_drm_set_gbm_device | ( | MirConnection * | connection, |
struct gbm_device * | dev | ||
) |
Set the gbm_device to be used by the EGL implementation.
This is required if the application needs to create EGLImages from gbm buffers objects created on that gbm device.
[in] | connection | The connection |
[in] | dev | The gbm_device to set |
void mir_connection_get_available_surface_formats | ( | MirConnection * | connection, |
MirPixelFormat * | formats, | ||
unsigned const int | format_size, | ||
unsigned int * | num_valid_formats | ||
) |
Get the list of possible formats that a surface can be created with.
[in] | connection | The connection |
[out] | formats | List of valid formats to create surfaces with |
[in] | formats_size | size of formats list |
[out] | num_valid_formats | number of valid formats returned in formats |
MirEGLNativeDisplayType mir_connection_get_egl_native_display | ( | MirConnection * | connection | ) |
Get a display type that can be used for OpenGL ES 2.0 acceleration.
[in] | connection | The connection |
char const* mir_connection_get_error_message | ( | MirConnection * | connection | ) |
Retrieve a text description of the last error.
The returned string is owned by the library and remains valid until the connection has been released.
[in] | connection | The connection |
void mir_connection_get_platform | ( | MirConnection * | connection, |
MirPlatformPackage * | platform_package | ||
) |
Query platform-specific data and/or file descriptors that are required to initialize GL/EGL features.
[in] | connection | The connection |
[out] | platform_package | Structure to be populated |
MirBool mir_connection_is_valid | ( | MirConnection * | connection | ) |
Test for a valid connection.
[in] | connection | The connection |
void mir_connection_release | ( | MirConnection * | connection | ) |
Release a connection to the Mir server.
[in] | connection | The connection |
void mir_connection_set_display_config_change_callback | ( | MirConnection * | connection, |
mir_display_config_callback | callback, | ||
void * | context | ||
) |
Register a callback to be called when the hardware display configuration changes.
Once a change has occurred, you can use mir_connection_create_display_config to see the new configuration.
[in] | connection | The connection |
[in] | callback | The function to be called when a display change occurs |
[in,out] | context | User data passed to the callback function |
void mir_connection_set_lifecycle_event_callback | ( | MirConnection * | connection, |
mir_lifecycle_event_callback | callback, | ||
void * | context | ||
) |
Register a callback to be called when a Lifecycle state change occurs.
[in] | connection | The connection |
[in] | callback | The function to be called when the state change occurs |
[in,out] | context | User data passed to the callback function |
void mir_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 |
MirEGLNativeWindowType mir_screencast_egl_native_window | ( | MirScreencast * | screencast | ) |
Get a window type that can be used by EGL.
[in] | screencast | The screencast |
void mir_screencast_release_sync | ( | MirScreencast * | screencast | ) |
Release the specified screencast.
[in] | screencast | The screencast to be released |
void mir_surface_get_current_buffer | ( | MirSurface * | surface, |
MirNativeBuffer ** | buffer_package | ||
) |
Get a surface's buffer in "raw" representation.
[in] | surface | The surface |
[out] | buffer_package | Structure to be populated |
MirEGLNativeWindowType mir_surface_get_egl_native_window | ( | MirSurface * | surface | ) |
Get a window type that can be used for OpenGL ES 2.0 acceleration.
[in] | surface | The surface |
char const* mir_surface_get_error_message | ( | MirSurface * | surface | ) |
Retrieve a text description of the error.
The returned string is owned by the library and remains valid until the surface or the associated connection has been released.
[in] | surface | The surface |
void mir_surface_get_graphics_region | ( | MirSurface * | surface, |
MirGraphicsRegion * | graphics_region | ||
) |
Get a surface's graphics_region, i.e., map the graphics buffer to main memory.
[in] | surface | The surface |
[out] | graphics_region | Structure to be populated |
void mir_surface_get_parameters | ( | MirSurface * | surface, |
MirSurfaceParameters * | parameters | ||
) |
Get a surface's parameters.
[in] | surface | The surface |
[out] | parameters | Structure to be populated |
MirPlatformType mir_surface_get_platform_type | ( | MirSurface * | surface | ) |
Get the underlying platform type so the buffer obtained in "raw" representation in mir_surface_get_current_buffer() can be understood.
[in] | surface | The surface |
MirSurfaceState mir_surface_get_state | ( | MirSurface * | surface | ) |
Get the current state of a surface.
[in] | surface | The surface to query |
int mir_surface_get_swapinterval | ( | MirSurface * | surface | ) |
Query the swapinterval that the surface is operating with.
The default interval is 1.
[in] | surface | The surface to operate on |
MirSurfaceType mir_surface_get_type | ( | MirSurface * | surface | ) |
Get the type (purpose) of a surface.
[in] | surface | The surface to query |
MirBool mir_surface_is_valid | ( | MirSurface * | surface | ) |
Test for a valid surface.
[in] | surface | The surface |
MirWaitHandle* mir_surface_release | ( | MirSurface * | surface, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
Release the supplied surface and any associated buffer.
The returned wait handle remains valid until the connection to the server is released.
[in] | surface | The surface |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_surface_release_sync | ( | MirSurface * | surface | ) |
Release the specified surface like in mir_surface_release(), but also wait for the operation to complete.
[in] | surface | The surface to be released |
void mir_surface_set_event_handler | ( | MirSurface * | surface, |
MirEventDelegate const * | event_handler | ||
) |
Set the event handler to be called when events arrive for a surface.
[in] | surface | The surface |
[in] | event_handler | The event handler to call |
MirWaitHandle* mir_surface_set_state | ( | MirSurface * | surface, |
MirSurfaceState | state | ||
) |
Change the state of a surface.
[in] | surface | The surface to operate on |
[in] | state | The new state of the surface |
MirWaitHandle* mir_surface_set_swapinterval | ( | MirSurface * | surface, |
int | interval | ||
) |
Set the swapinterval for mir_surface_swap_buffers.
EGL users should use eglSwapInterval directly. At the time being, only swapinterval of 0 or 1 is supported.
[in] | surface | The surface to operate on |
[in] | interval | The number of vblank signals that mir_surface_swap_buffers will wait for |
MirWaitHandle* mir_surface_set_type | ( | MirSurface * | surface, |
MirSurfaceType | type | ||
) |
Set the type (purpose) of a surface.
This is not guaranteed to always work with some shell types (e.g. phone/tablet UIs). As such, you may have to wait on the function and check the result using mir_surface_get_type.
[in] | surface | The surface to operate on |
[in] | type | The new type of the surface |
MirWaitHandle* mir_surface_swap_buffers | ( | MirSurface * | surface, |
mir_surface_callback | callback, | ||
void * | context | ||
) |
Advance a surface's buffer.
The returned handle remains valid until the next call to mir_surface_swap_buffers, until the surface has been released or the connection to the server has been released.
[in] | surface | The surface |
[in] | callback | Callback function to be invoked when the request completes |
[in,out] | context | User data passed to the callback function |
void mir_surface_swap_buffers_sync | ( | MirSurface * | surface | ) |
Advance a surface's buffer as in mir_surface_swap_buffers(), but also wait for the operation to complete.
[in] | surface | The surface whose buffer to advance |
void mir_wait_for | ( | MirWaitHandle * | wait_handle | ) |
Wait on the supplied handle until all instances of the associated request have completed.
[in] | wait_handle | Handle returned by an asynchronous request |
void mir_wait_for_one | ( | MirWaitHandle * | wait_handle | ) |
Wait on the supplied handle until one instance of the associated request has completed.
Use this instead of mir_wait_for in a threaded environment to ensure that the act of waiting does not clear all results associated with the wait handle; only one.
[in] | wait_handle | Handle returned by an asynchronous request |
MirDisplayInfo* display_info |
Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Apr 11 21:14:53 UTC 2014