Mir
Macros | Functions
mir_surface_api.cpp File Reference
#include "mir_toolkit/mir_surface.h"
#include "mir_toolkit/mir_wait.h"
#include "mir/require.h"
#include "mir_connection.h"
#include "mir_surface.h"
#include "error_connections.h"
#include "mir/uncaught.h"
#include <boost/exception/diagnostic_information.hpp>
#include <functional>
Include dependency graph for mir_surface_api.cpp:

Macros

#define MIR_LOG_COMPONENT   "MirSurfaceAPI"
 

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 *rect)
 Create a surface specification for a tooltip 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_connection_create_spec_for_input_method (MirConnection *connection, int width, int height, MirPixelFormat format)
 Create a surface specification for an input method 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...
 
MirSurfacemir_surface_create_sync (MirSurfaceSpec *requested_specification)
 Create a surface from a given specification and wait for the result. More...
 
MirWaitHandlemir_surface_create (MirSurfaceSpec *requested_specification, mir_surface_callback callback, void *context)
 Create a surface from a given specification. More...
 
bool mir_surface_spec_set_name (MirSurfaceSpec *spec, char const *name)
 Set the requested name. More...
 
bool mir_surface_spec_set_width (MirSurfaceSpec *spec, unsigned width)
 Set the requested width, in pixels. More...
 
bool mir_surface_spec_set_height (MirSurfaceSpec *spec, unsigned height)
 Set the requested height, in pixels. More...
 
bool mir_surface_spec_set_pixel_format (MirSurfaceSpec *spec, MirPixelFormat format)
 Set the requested pixel format. More...
 
bool mir_surface_spec_set_buffer_usage (MirSurfaceSpec *spec, MirBufferUsage usage)
 Set the requested buffer usage. More...
 
bool mir_surface_spec_set_fullscreen_on_output (MirSurfaceSpec *spec, uint32_t output_id)
 
bool mir_surface_spec_set_preferred_orientation (MirSurfaceSpec *spec, MirOrientationMode mode)
 Set the requested preferred orientation mode. More...
 
void mir_surface_spec_release (MirSurfaceSpec *spec)
 Release the resources held by a MirSurfaceSpec. More...
 
MirWaitHandlemir_connection_create_surface (MirConnection *connection, MirSurfaceParameters const *params, mir_surface_callback callback, void *context)
 Request a new Mir surface on the supplied connection with the supplied parameters. More...
 
MirSurfacemir_connection_create_surface_sync (MirConnection *connection, MirSurfaceParameters const *params)
 Create a surface like in mir_connection_create_surface(), but also wait for creation to complete and return the resulting surface. More...
 
void mir_surface_set_event_handler (MirSurface *surface, MirEventDelegate const *event_handler)
 Set the event handler to be called when events arrive for a surface. More...
 
MirEGLNativeWindowType mir_surface_get_egl_native_window (MirSurface *surface)
 Get a window type that can be used for OpenGL ES 2.0 acceleration. More...
 
bool mir_surface_is_valid (MirSurface *surface)
 Test for a valid surface. More...
 
char const * mir_surface_get_error_message (MirSurface *surface)
 Retrieve a text description of the error. More...
 
void mir_surface_get_parameters (MirSurface *surface, MirSurfaceParameters *parameters)
 Get a surface's parameters. More...
 
MirPlatformType mir_surface_get_platform_type (MirSurface *surface)
 Get the underlying platform type so the buffer obtained in "raw" representation in mir_surface_get_current_buffer() can be understood. More...
 
void mir_surface_get_current_buffer (MirSurface *surface, MirNativeBuffer **buffer_package_out)
 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...
 
MirWaitHandlemir_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...
 
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...
 
int mir_surface_get_id (MirSurface *)
 
MirWaitHandlemir_surface_set_type (MirSurface *surf, MirSurfaceType type)
 
MirSurfaceType mir_surface_get_type (MirSurface *surf)
 Get the type (purpose) of a surface. More...
 
MirWaitHandlemir_surface_set_state (MirSurface *surf, MirSurfaceState state)
 Change the state of a surface. More...
 
MirSurfaceState mir_surface_get_state (MirSurface *surf)
 Get the current state of a surface. More...
 
MirOrientation mir_surface_get_orientation (MirSurface *surface)
 Get the orientation of a surface. More...
 
MirWaitHandlemir_surface_set_swapinterval (MirSurface *surf, int interval)
 Set the swapinterval for mir_surface_swap_buffers. More...
 
int mir_surface_get_swapinterval (MirSurface *surf)
 Query the swapinterval that the surface is operating with. More...
 
int mir_surface_get_dpi (MirSurface *surf)
 Query the DPI value of the surface (dots per inch). More...
 
MirSurfaceFocusState mir_surface_get_focus (MirSurface *surf)
 Query the focus state for a surface. More...
 
MirSurfaceVisibility mir_surface_get_visibility (MirSurface *surf)
 Query the visibility state for a surface. More...
 
MirWaitHandlemir_surface_configure_cursor (MirSurface *surface, MirCursorConfiguration const *cursor)
 Choose the cursor state for a surface: whether a cursor is shown, and which cursor if so. More...
 
MirOrientationMode mir_surface_get_preferred_orientation (MirSurface *surf)
 Get the preferred orientation modes of a surface. More...
 
MirWaitHandlemir_surface_set_preferred_orientation (MirSurface *surf, MirOrientationMode mode)
 Request to set the preferred orientations of a surface. More...
 

Macro Definition Documentation

#define MIR_LOG_COMPONENT   "MirSurfaceAPI"

Function Documentation

int mir_surface_get_id ( MirSurface )
MirWaitHandle* mir_surface_set_type ( MirSurface surf,
MirSurfaceType  type 
)

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015