client_types.h

Go to the documentation of this file.

/*
 * client_types.h: Type definitions used in client apps and libmirclient.
 *
 * Copyright © 2013 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Robert Carr <robert.carr@canonical.com>
 */

#ifndef MIR_TOOLKIT_CLIENT_TYPES_H_
#define MIR_TOOLKIT_CLIENT_TYPES_H_

#include <mir_toolkit/events/event.h>
#include <mir_toolkit/common.h>

#include <stddef.h>

#ifdef __cplusplus

extern "C" {
#endif

/* Display server connection API */
typedef void* MirEGLNativeWindowType;
typedef void* MirEGLNativeDisplayType;
typedef struct MirConnection MirConnection;
typedef struct MirSurface MirSurface __attribute__((deprecated("Use MirWindow instead")));
typedef struct MirSurface MirWindow;
typedef struct MirSurfaceSpec MirSurfaceSpec __attribute__((deprecated("Use MirWindowSpec instead")));
typedef struct MirSurfaceSpec MirWindowSpec;
typedef struct MirScreencast MirScreencast;
typedef struct MirScreencastSpec MirScreencastSpec;
typedef struct MirPromptSession MirPromptSession;
typedef struct MirBufferStream MirBufferStream;
typedef struct MirPersistentId MirPersistentId __attribute((deprecated("Use MirWindowId instead")));
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
__attribute__((deprecated("This type is slated for rename due to MirRenderSurface-->MirSurface transition")));

typedef struct MirOutput MirOutput;

typedef struct MirWaitHandle MirWaitHandle;

typedef struct MirPlatformMessage MirPlatformMessage;

typedef void (*MirConnectedCallback)(
    MirConnection *connection, void *client_context);
typedef MirConnectedCallback mir_connected_callback
    __attribute__((deprecated("Use MirConnectedCallback instead")));

typedef void (*MirWindowCallback)(MirWindow *window, void *client_context);

typedef void (*MirBufferStreamCallback)(
    MirBufferStream *stream, void *client_context);
typedef MirBufferStreamCallback mir_buffer_stream_callback
    __attribute__((deprecated("Use MirBufferStreamCallback instead")));

typedef void (*MirWindowEventCallback)(
    MirWindow* window, MirEvent const* event, void* context);

typedef void (*MirLifecycleEventCallback)(
    MirConnection* connection, MirLifecycleState state, void* context);
typedef MirLifecycleEventCallback mir_lifecycle_event_callback
    __attribute__((deprecated("Use MirLifecycleEventCallback instead")));

typedef void (*MirPingEventCallback)(
    MirConnection* connection, int32_t serial, void* context);
typedef MirPingEventCallback mir_ping_event_callback
    __attribute__((deprecated("Use MirPingEventCallback instead")));

typedef void (*MirDisplayConfigCallback)(
    MirConnection* connection, void* context);
typedef MirDisplayConfigCallback mir_display_config_callback
    __attribute__((deprecated("Use MirDisplayConfigCallback instead")));

typedef void (*MirClientFdCallback)(
    MirPromptSession *prompt_session, size_t count, int const* fds, void* context);
typedef MirClientFdCallback mir_client_fd_callback
    __attribute__((deprecated("Use MirClientFdCallback instead")));

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
typedef void (*MirWindowIdCallback)(
    MirWindow* window, MirPersistentId* id, void* context);
#pragma GCC diagnostic pop

typedef enum MirBufferUsage
{
    mir_buffer_usage_hardware = 1,
    mir_buffer_usage_software
} MirBufferUsage;

typedef struct MirSurfaceParameters
{
    char const *name;
    int width;
    int height;
    MirPixelFormat pixel_format;
    MirBufferUsage buffer_usage;
    uint32_t output_id;
} MirSurfaceParameters __attribute__((deprecated("Use MirWindowParameters instead")));

enum { mir_platform_package_max = 32 };

#ifndef __cplusplus
__attribute__ ((deprecated))
#endif
typedef enum MirPlatformType
{
    mir_platform_type_gbm,
    mir_platform_type_android,
    mir_platform_type_eglstream,
} MirPlatformType;

typedef struct MirPlatformPackage
{
    int data_items;
    int fd_items;

    int data[mir_platform_package_max];
    int fd[mir_platform_package_max];
} MirPlatformPackage;

typedef struct MirModuleProperties
{
    char const *name;
    int major_version;
    int minor_version;
    int micro_version;
    char const *filename;
} MirModuleProperties;

typedef enum MirBufferLayout
{
    mir_buffer_layout_unknown = 0,
    mir_buffer_layout_linear  = 1,
} MirBufferLayout;

typedef struct MirGraphicsRegion
{
    int width;
    int height;
    int stride;
    MirPixelFormat pixel_format;
    char *vaddr;

} MirGraphicsRegion;

enum { mir_supported_pixel_format_max = 32 };
typedef struct MirDisplayInfo
{
    uint32_t width;
    uint32_t height;

    int supported_pixel_format_items;
    MirPixelFormat supported_pixel_format[mir_supported_pixel_format_max];
} MirDisplayInfo;

typedef struct MirDisplayCard
{
    uint32_t card_id;
    uint32_t max_simultaneous_outputs;
} MirDisplayCard;

typedef 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,
} MirDisplayOutputType;

typedef enum MirOutputConnectionState
{
    mir_output_connection_state_disconnected = 0,
    mir_output_connection_state_connected,
    mir_output_connection_state_unknown
} MirOutputConnectionState;

typedef struct MirDisplayMode
{
    uint32_t vertical_resolution;
    uint32_t horizontal_resolution;
    double refresh_rate;
} MirDisplayMode;

enum { mir_display_output_id_invalid = 0 };

typedef struct MirDisplayOutput
{
    uint32_t num_modes;
    MirDisplayMode* modes;
    uint32_t preferred_mode;  
    uint32_t current_mode;

    uint32_t num_output_formats;
    MirPixelFormat* output_formats;
    MirPixelFormat current_format;

    uint32_t card_id;
    uint32_t output_id;
    MirDisplayOutputType type;

    int32_t position_x;
    int32_t position_y;
    uint32_t connected;
    uint32_t used;

    uint32_t physical_width_mm;
    uint32_t physical_height_mm;

    MirPowerMode power_mode;
    MirOrientation orientation;
} MirDisplayOutput;

typedef struct MirDisplayConfiguration
{
    uint32_t num_outputs;
    MirDisplayOutput* outputs;
    uint32_t num_cards;
    MirDisplayCard *cards;
} MirDisplayConfiguration;

typedef struct MirBufferStreamInfo
{
    MirBufferStream* stream;
    int displacement_x;
    int displacement_y;
} MirBufferStreamInfo;

typedef struct MirRectangle
{
    int left;
    int top;
    unsigned int width;
    unsigned int height;
} MirRectangle;

typedef struct MirInputConfig MirInputConfig;
typedef struct MirInputDevice MirInputDevice;
typedef struct MirPointerConfig MirPointerConfig;
typedef struct MirTouchpadConfig MirTouchpadConfig;

typedef struct MirScreencastParameters
{
    MirRectangle region;
    unsigned int width;
    unsigned int height;
    MirPixelFormat pixel_format;
} MirScreencastParameters;

typedef void (*MirScreencastCallback)(
    MirScreencast *screencast, void *client_context);
typedef MirScreencastCallback mir_screencast_callback
    __attribute__((deprecated("Use MirScreencastCallback instead")));

typedef void (*MirPromptSessionCallback)(
    MirPromptSession* prompt_provider, void* context);
typedef MirPromptSessionCallback mir_prompt_session_callback
    __attribute__((deprecated("Use MirPromptSessionCallback instead")));

typedef void (*MirPromptSessionStateChangeCallback)(
    MirPromptSession* prompt_provider, MirPromptSessionState state,
    void* context);
typedef MirPromptSessionStateChangeCallback
        mir_prompt_session_state_change_callback
    __attribute__((deprecated("Use MirPromptSessionStateChangeCallback instead")));

typedef void (*MirPlatformOperationCallback)(
    MirConnection* connection, MirPlatformMessage* reply, void* context);
typedef MirPlatformOperationCallback mir_platform_operation_callback
    __attribute__((deprecated("Use MirPlatformOperationCallback instead")));

typedef void (*MirInputConfigCallback)(
    MirConnection* connection, void* context);
typedef MirInputConfigCallback mir_input_config_callback
    __attribute__((deprecated("Use MirInputConfigCallback instead")));

typedef void (*MirBufferCallback)(MirBuffer*, void* context);

typedef enum MirErrorDomain
{
    mir_error_domain_display_configuration,
    mir_error_domain_input_configuration,
} MirErrorDomain;

typedef 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
} MirDisplayConfigurationError;

typedef enum MirInputConfigurationError {
     mir_input_configuration_error_rejected_by_driver
} MirInputConfigurationError;

typedef void (*MirErrorCallback)(
    MirConnection* connection, MirError const* error, void* context);
typedef MirErrorCallback mir_error_callback
    __attribute__((deprecated("Use MirErrorCallback instead")));

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"

typedef void (*mir_surface_callback)(MirSurface *surface, void *client_context)
__attribute__((deprecated("Use MirWindowCallback instead")));

typedef void (*mir_surface_event_callback)(
    MirSurface* surface, MirEvent const* event, void* context)
__attribute__((deprecated("Use MirWindowEventCallback instead")));

typedef void (*mir_surface_id_callback)(
    MirSurface* surface, MirPersistentId* id, void* context)
__attribute__((deprecated("Use MirWindowIdCallback instead")));

typedef void (*MirRenderSurfaceCallback)(MirRenderSurface*, void* context)
__attribute__((deprecated("This type is slated for rename due to MirRenderSurface-->MirSurface transition")));

typedef MirSurfaceParameters MirWindowParameters;

#pragma GCC diagnostic pop

#ifdef __cplusplus
}
#endif

#endif /* MIR_TOOLKIT_CLIENT_TYPES_H_ */