include/SDL_syswm.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 12:48:50 -0700
changeset 7190 11612d544fcd
parent 6885 700f1b25f77f
child 7191 75360622e65f
child 8439 14d94a8a9fb6
permissions -rw-r--r--
Added mobile application events, with implementations for iOS and Android
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@0
    21
slouken@1895
    22
/**
slouken@3407
    23
 *  \file SDL_syswm.h
slouken@3407
    24
 *  
slouken@3407
    25
 *  Include file for SDL custom system window manager hooks.
slouken@1895
    26
 */
slouken@0
    27
slouken@0
    28
#ifndef _SDL_syswm_h
slouken@0
    29
#define _SDL_syswm_h
slouken@0
    30
slouken@1356
    31
#include "SDL_stdinc.h"
slouken@1358
    32
#include "SDL_error.h"
slouken@1895
    33
#include "SDL_video.h"
slouken@0
    34
#include "SDL_version.h"
slouken@0
    35
slouken@0
    36
#include "begin_code.h"
slouken@0
    37
/* Set up for C function definitions, even when using C++ */
slouken@0
    38
#ifdef __cplusplus
slouken@1895
    39
/* *INDENT-OFF* */
slouken@0
    40
extern "C" {
slouken@1895
    41
/* *INDENT-ON* */
slouken@0
    42
#endif
slouken@0
    43
slouken@3407
    44
/**
slouken@3407
    45
 *  \file SDL_syswm.h
slouken@3407
    46
 *  
slouken@3407
    47
 *  Your application has access to a special type of event ::SDL_SYSWMEVENT,
slouken@3407
    48
 *  which contains window-manager specific information and arrives whenever
slouken@3407
    49
 *  an unhandled window event occurs.  This event is ignored by default, but
slouken@3407
    50
 *  you can enable it with SDL_EventState().
slouken@3407
    51
 */
slouken@0
    52
#ifdef SDL_PROTOTYPES_ONLY
slouken@0
    53
struct SDL_SysWMinfo;
slouken@0
    54
#else
slouken@0
    55
slouken@5062
    56
#if defined(SDL_VIDEO_DRIVER_WINDOWS)
slouken@4900
    57
#define WIN32_LEAN_AND_MEAN
slouken@4900
    58
#include <windows.h>
slouken@4900
    59
#endif
slouken@4900
    60
slouken@1361
    61
/* This is the structure for custom window manager events */
slouken@1626
    62
#if defined(SDL_VIDEO_DRIVER_X11)
icculus@1133
    63
#if defined(__APPLE__) && defined(__MACH__)
slouken@1487
    64
/* conflicts with Quickdraw.h */
icculus@1133
    65
#define Cursor X11Cursor
icculus@1133
    66
#endif
icculus@1133
    67
slouken@0
    68
#include <X11/Xlib.h>
slouken@0
    69
#include <X11/Xatom.h>
slouken@0
    70
icculus@1133
    71
#if defined(__APPLE__) && defined(__MACH__)
slouken@1487
    72
/* matches the re-define above */
icculus@1133
    73
#undef Cursor
icculus@1133
    74
#endif
icculus@1133
    75
slouken@4899
    76
#endif /* defined(SDL_VIDEO_DRIVER_X11) */
slouken@4899
    77
slouken@4899
    78
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
slouken@5199
    79
#include <directfb.h>
slouken@4899
    80
#endif
slouken@4900
    81
slouken@4900
    82
#if defined(SDL_VIDEO_DRIVER_COCOA)
slouken@4900
    83
#ifdef __OBJC__
slouken@4900
    84
#include <Cocoa/Cocoa.h>
slouken@4900
    85
#else
slouken@4900
    86
typedef struct _NSWindow NSWindow;
slouken@4900
    87
#endif
slouken@4900
    88
#endif
slouken@4900
    89
slouken@5056
    90
#if defined(SDL_VIDEO_DRIVER_UIKIT)
slouken@5056
    91
#ifdef __OBJC__
slouken@5056
    92
#include <UIKit/UIKit.h>
slouken@5056
    93
#else
slouken@5056
    94
typedef struct _UIWindow UIWindow;
slouken@5056
    95
#endif
slouken@5056
    96
#endif
slouken@5056
    97
slouken@3407
    98
/** 
slouken@4900
    99
 *  These are the various supported windowing subsystems
slouken@3407
   100
 */
slouken@1895
   101
typedef enum
slouken@1895
   102
{
slouken@4900
   103
    SDL_SYSWM_UNKNOWN,
slouken@4900
   104
    SDL_SYSWM_WINDOWS,
slouken@4899
   105
    SDL_SYSWM_X11,
slouken@4899
   106
    SDL_SYSWM_DIRECTFB,
slouken@4900
   107
    SDL_SYSWM_COCOA,
slouken@5056
   108
    SDL_SYSWM_UIKIT,
slouken@0
   109
} SDL_SYSWM_TYPE;
slouken@0
   110
slouken@3407
   111
/**
slouken@4900
   112
 *  The custom event structure.
slouken@3407
   113
 */
slouken@1895
   114
struct SDL_SysWMmsg
slouken@1895
   115
{
slouken@1895
   116
    SDL_version version;
slouken@1895
   117
    SDL_SYSWM_TYPE subsystem;
slouken@1895
   118
    union
slouken@1895
   119
    {
slouken@5062
   120
#if defined(SDL_VIDEO_DRIVER_WINDOWS)
slouken@4900
   121
        struct {
slouken@4900
   122
            HWND hwnd;                  /**< The window for the message */
slouken@4900
   123
            UINT msg;                   /**< The type of message */
slouken@4900
   124
            WPARAM wParam;              /**< WORD message parameter */
slouken@4900
   125
            LPARAM lParam;              /**< LONG message parameter */
slouken@4900
   126
        } win;
slouken@5065
   127
#endif
slouken@5065
   128
#if defined(SDL_VIDEO_DRIVER_X11)
slouken@4900
   129
        struct {
slouken@4900
   130
            XEvent event;
slouken@4900
   131
        } x11;
slouken@5065
   132
#endif
slouken@5065
   133
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
slouken@4900
   134
        struct {
slouken@4900
   135
            DFBEvent event;
slouken@4900
   136
        } dfb;
slouken@5065
   137
#endif
slouken@5065
   138
#if defined(SDL_VIDEO_DRIVER_COCOA)
slouken@4900
   139
        struct
slouken@4900
   140
        {
slouken@4900
   141
            /* No Cocoa window events yet */
slouken@4900
   142
        } cocoa;
slouken@5065
   143
#endif
slouken@5065
   144
#if defined(SDL_VIDEO_DRIVER_UIKIT)
slouken@5056
   145
        struct
slouken@5056
   146
        {
slouken@5056
   147
            /* No UIKit window events yet */
slouken@5056
   148
        } uikit;
slouken@5065
   149
#endif
slouken@5063
   150
        /* Can't have an empty union */
slouken@5063
   151
        int dummy;
slouken@5056
   152
    } msg;
slouken@0
   153
};
slouken@0
   154
slouken@3407
   155
/**
slouken@4900
   156
 *  The custom window manager information structure.
slouken@3407
   157
 *
slouken@3407
   158
 *  When this structure is returned, it holds information about which
slouken@3407
   159
 *  low level system it is using, and will be one of SDL_SYSWM_TYPE.
slouken@0
   160
 */
slouken@1895
   161
struct SDL_SysWMinfo
slouken@1895
   162
{
slouken@1895
   163
    SDL_version version;
slouken@1895
   164
    SDL_SYSWM_TYPE subsystem;
slouken@1895
   165
    union
slouken@1895
   166
    {
slouken@5062
   167
#if defined(SDL_VIDEO_DRIVER_WINDOWS)
slouken@4900
   168
        struct
slouken@4900
   169
        {
slouken@4903
   170
            HWND window;                /**< The window handle */
slouken@4900
   171
        } win;
slouken@5065
   172
#endif
slouken@5065
   173
#if defined(SDL_VIDEO_DRIVER_X11)
slouken@1895
   174
        struct
slouken@1895
   175
        {
slouken@4900
   176
            Display *display;           /**< The X11 display */
slouken@4903
   177
            Window window;              /**< The X11 window */
slouken@1895
   178
        } x11;
slouken@5065
   179
#endif
slouken@5065
   180
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
slouken@4899
   181
        struct
slouken@4899
   182
        {
slouken@4903
   183
            IDirectFB *dfb;             /**< The directfb main interface */
slouken@4903
   184
            IDirectFBWindow *window;    /**< The directfb window handle */
slouken@4903
   185
            IDirectFBSurface *surface;  /**< The directfb client surface */
slouken@4900
   186
        } dfb;
slouken@5065
   187
#endif
slouken@5065
   188
#if defined(SDL_VIDEO_DRIVER_COCOA)
slouken@4900
   189
        struct
slouken@4900
   190
        {
slouken@4903
   191
            NSWindow *window;           /* The Cocoa window */
slouken@4900
   192
        } cocoa;
slouken@5065
   193
#endif
slouken@5065
   194
#if defined(SDL_VIDEO_DRIVER_UIKIT)
slouken@5056
   195
        struct
slouken@5056
   196
        {
slouken@5056
   197
            UIWindow *window;           /* The UIKit window */
slouken@5056
   198
        } uikit;
slouken@5065
   199
#endif
slouken@5063
   200
        /* Can't have an empty union */
slouken@5063
   201
        int dummy;
slouken@5056
   202
    } info;
slouken@1895
   203
};
slouken@0
   204
slouken@0
   205
#endif /* SDL_PROTOTYPES_ONLY */
slouken@0
   206
slouken@1895
   207
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
slouken@1895
   208
slouken@0
   209
/* Function prototypes */
slouken@1895
   210
/**
slouken@3407
   211
 *  \brief This function allows access to driver-dependent window information.
slouken@3407
   212
 *  
slouken@4530
   213
 *  \param window The window about which information is being requested
slouken@3407
   214
 *  \param info This structure must be initialized with the SDL version, and is 
slouken@3407
   215
 *              then filled in with information about the given window.
slouken@3407
   216
 *  
slouken@3407
   217
 *  \return SDL_TRUE if the function is implemented and the version member of 
slouken@3407
   218
 *          the \c info struct is valid, SDL_FALSE otherwise.
slouken@3407
   219
 *  
slouken@3407
   220
 *  You typically use this function like this:
slouken@3407
   221
 *  \code
slouken@4895
   222
 *  SDL_SysWMinfo info;
slouken@3407
   223
 *  SDL_VERSION(&info.version);
slouken@3407
   224
 *  if ( SDL_GetWindowWMInfo(&info) ) { ... }
slouken@3407
   225
 *  \endcode
slouken@0
   226
 */
slouken@3685
   227
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
slouken@1895
   228
                                                     SDL_SysWMinfo * info);
slouken@0
   229
slouken@0
   230
slouken@0
   231
/* Ends C function definitions when using C++ */
slouken@0
   232
#ifdef __cplusplus
slouken@1895
   233
/* *INDENT-OFF* */
slouken@0
   234
}
slouken@1895
   235
/* *INDENT-ON* */
slouken@0
   236
#endif
slouken@0
   237
#include "close_code.h"
slouken@0
   238
slouken@0
   239
#endif /* _SDL_syswm_h */
slouken@1895
   240
slouken@1895
   241
/* vi: set ts=4 sw=4 expandtab: */