Mir
Classes | Typedefs | Enumerations | Functions | Variables
client_types.h File Reference
#include <mir_toolkit/events/event.h>
#include <mir_toolkit/common.h>
#include <mir_toolkit/deprecations.h>
#include <stddef.h>
Include dependency graph for client_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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...
 

Typedefs

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")
 

Enumerations

enum  MirBufferUsage
 MirBufferUsage specifies how a surface can and will be used. More...
 
enum  { mir_platform_package_max = 32 }
 
enum  MirPlatformType { mir_platform_type_gbm, mir_platform_type_android, mir_platform_type_eglstream }
 The native buffer type for the system the client is connected on. More...
 
enum  MirBufferLayout { mir_buffer_layout_unknown = 0, mir_buffer_layout_linear = 1 }
 
enum  MirPresentMode {
  mir_present_mode_immediate, mir_present_mode_mailbox, mir_present_mode_fifo, mir_present_mode_fifo_relaxed,
  mir_present_mode_num_modes
}
 
enum  { mir_supported_pixel_format_max = 32 }
 DEPRECATED. More...
 
enum  MirDisplayOutputType {
  mir_display_output_type_unknown = mir_output_type_unknown, mir_display_output_type_vga = mir_output_type_vga, mir_display_output_type_dvii = mir_output_type_dvii, mir_display_output_type_dvid = mir_output_type_dvid,
  mir_display_output_type_dvia = mir_output_type_dvia, mir_display_output_type_composite = mir_output_type_composite, mir_display_output_type_svideo = mir_output_type_svideo, mir_display_output_type_lvds = mir_output_type_lvds,
  mir_display_output_type_component = mir_output_type_component, mir_display_output_type_ninepindin = mir_output_type_ninepindin, mir_display_output_type_displayport = mir_output_type_displayport, mir_display_output_type_hdmia = mir_output_type_hdmia,
  mir_display_output_type_hdmib = mir_output_type_hdmib, mir_display_output_type_tv = mir_output_type_tv, mir_display_output_type_edp = mir_output_type_edp, mir_display_output_type_virtual = mir_output_type_virtual,
  mir_display_output_type_dsi = mir_output_type_dsi, mir_display_output_type_dpi = mir_output_type_dpi
}
 
enum  MirOutputConnectionState { mir_output_connection_state_disconnected = 0, mir_output_connection_state_connected, mir_output_connection_state_unknown }
 
enum  { mir_display_output_id_invalid = 0 }
 
enum  MirErrorDomain { mir_error_domain_display_configuration, mir_error_domain_input_configuration }
 Specifies the origin of an error. More...
 
enum  MirDisplayConfigurationError { mir_display_configuration_error_unauthorized, mir_display_configuration_error_in_progress, mir_display_configuration_error_no_preview_in_progress, mir_display_configuration_error_rejected_by_hardware }
 Errors from the mir_error_domain_display_configuration MirErrorDomain. More...
 
enum  MirInputConfigurationError { mir_input_configuration_error_rejected_by_driver, mir_input_configuration_error_base_configuration_unauthorized, mir_input_configuration_error_unauthorized }
 Errors from the mir_error_domain_input_configuration MirErrorDomain. More...
 

Functions

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...
 

Variables

 mir_buffer_usage_hardware = 1
 
 mir_buffer_usage_software
 
char const * name
 
int width
 
int height
 
MirPixelFormat pixel_format
 
MirBufferUsage buffer_usage
 
uint32_t output_id
 The id of the output to place the surface in. More...
 

Variable Documentation

◆ buffer_usage

MirBufferUsage buffer_usage

◆ height

int height

◆ mir_buffer_usage_hardware

mir_buffer_usage_hardware = 1

◆ mir_buffer_usage_software

mir_buffer_usage_software

◆ name

char const* name

◆ output_id

uint32_t output_id

The id of the output to place the surface in.

Use one of the output ids from MirDisplayConfiguration/MirDisplayOutput to place a surface on that output. Only fullscreen placements are currently supported. If you don't have special placement requirements, use the value mir_display_output_id_invalid.

◆ pixel_format

MirPixelFormat pixel_format

◆ width

int width

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu 12 Jul 10:49:10 UTC 2018