src/video/SDL_sysvideo.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 02 Mar 2013 20:44:16 -0800
changeset 6950 1ddb72193079
parent 6885 700f1b25f77f
child 7009 161b7b6a5303
child 8439 14d94a8a9fb6
permissions -rw-r--r--
Added a mouse ID to the mouse events, which set to the special value SDL_TOUCH_MOUSEID for mouse events simulated by touch input.
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@1402
    21
#include "SDL_config.h"
slouken@0
    22
slouken@0
    23
#ifndef _SDL_sysvideo_h
slouken@0
    24
#define _SDL_sysvideo_h
slouken@0
    25
slouken@6602
    26
#include "SDL_messagebox.h"
eligottlieb@4782
    27
#include "SDL_shape.h"
slouken@0
    28
slouken@0
    29
/* The SDL video driver */
slouken@1895
    30
eligottlieb@4782
    31
typedef struct SDL_WindowShaper SDL_WindowShaper;
eligottlieb@4782
    32
typedef struct SDL_ShapeDriver SDL_ShapeDriver;
slouken@1895
    33
typedef struct SDL_VideoDisplay SDL_VideoDisplay;
slouken@0
    34
typedef struct SDL_VideoDevice SDL_VideoDevice;
slouken@0
    35
eligottlieb@4782
    36
/* Define the SDL window-shaper structure */
eligottlieb@4782
    37
struct SDL_WindowShaper
eligottlieb@4782
    38
{   
eligottlieb@4782
    39
    /* The window associated with the shaper */
eligottlieb@4782
    40
    SDL_Window *window;
eligottlieb@4782
    41
    
eligottlieb@4851
    42
    /* The user's specified coordinates for the window, for once we give it a shape. */
eligottlieb@4851
    43
    Uint32 userx,usery;
eligottlieb@4782
    44
    
eligottlieb@4807
    45
    /* The parameters for shape calculation. */
eligottlieb@4807
    46
    SDL_WindowShapeMode mode;
eligottlieb@4782
    47
    
eligottlieb@4782
    48
    /* Has this window been assigned a shape? */
eligottlieb@4782
    49
    SDL_bool hasshape;
eligottlieb@4782
    50
    
eligottlieb@4782
    51
    void *driverdata;
eligottlieb@4782
    52
};
eligottlieb@4782
    53
eligottlieb@4782
    54
/* Define the SDL shape driver structure */
eligottlieb@4782
    55
struct SDL_ShapeDriver
eligottlieb@4782
    56
{
eligottlieb@4782
    57
    SDL_WindowShaper *(*CreateShaper)(SDL_Window * window);
egottlieb@4849
    58
    int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
eligottlieb@4782
    59
    int (*ResizeWindowShape)(SDL_Window *window);
eligottlieb@4782
    60
};
eligottlieb@4782
    61
slouken@5165
    62
typedef struct SDL_WindowUserData
slouken@5165
    63
{
slouken@5165
    64
    char *name;
slouken@5165
    65
    void *data;
slouken@5165
    66
    struct SDL_WindowUserData *next;
slouken@5165
    67
} SDL_WindowUserData;
slouken@5165
    68
slouken@1895
    69
/* Define the SDL window structure, corresponding to toplevel windows */
slouken@2753
    70
struct SDL_Window
slouken@2753
    71
{
slouken@3695
    72
    const void *magic;
slouken@2753
    73
    Uint32 id;
slouken@2753
    74
    char *title;
slouken@2753
    75
    int x, y;
slouken@2753
    76
    int w, h;
stopiccot@6681
    77
    int min_w, min_h;
slouken@6788
    78
    int max_w, max_h;
slouken@2753
    79
    Uint32 flags;
slouken@1895
    80
slouken@5398
    81
    /* Stored position and size for windowed mode */
slouken@5398
    82
    SDL_Rect windowed;
slouken@5398
    83
slouken@3500
    84
    SDL_DisplayMode fullscreen_mode;
eligottlieb@4782
    85
    
slouken@5466
    86
    float brightness;
slouken@5466
    87
    Uint16 *gamma;
slouken@5466
    88
    Uint16 *saved_gamma;        /* (just offset into gamma) */
slouken@5466
    89
slouken@5166
    90
    SDL_Surface *surface;
slouken@5174
    91
    SDL_bool surface_valid;
slouken@5166
    92
eligottlieb@4782
    93
    SDL_WindowShaper *shaper;
slouken@3500
    94
slouken@5165
    95
    SDL_WindowUserData *data;
slouken@5165
    96
slouken@2753
    97
    void *driverdata;
slouken@3685
    98
slouken@3685
    99
    SDL_Window *prev;
slouken@3685
   100
    SDL_Window *next;
slouken@1895
   101
};
slouken@1895
   102
#define FULLSCREEN_VISIBLE(W) \
slouken@1895
   103
    (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
slouken@1895
   104
     ((W)->flags & SDL_WINDOW_SHOWN) && \
slouken@1895
   105
     !((W)->flags & SDL_WINDOW_MINIMIZED))
slouken@1895
   106
hfutrell@2742
   107
/*
hfutrell@2742
   108
 * Define the SDL display structure This corresponds to physical monitors
hfutrell@2742
   109
 * attached to the system.
slouken@1895
   110
 */
slouken@2753
   111
struct SDL_VideoDisplay
slouken@2753
   112
{
slouken@6787
   113
    char *name;
slouken@2753
   114
    int max_display_modes;
slouken@2753
   115
    int num_display_modes;
slouken@2753
   116
    SDL_DisplayMode *display_modes;
slouken@2753
   117
    SDL_DisplayMode desktop_mode;
slouken@2753
   118
    SDL_DisplayMode current_mode;
slouken@1895
   119
slouken@3517
   120
    SDL_Window *fullscreen_window;
slouken@1895
   121
slouken@2753
   122
    SDL_VideoDevice *device;
slouken@1895
   123
slouken@2753
   124
    void *driverdata;
slouken@1895
   125
};
slouken@1895
   126
slouken@5272
   127
/* Forward declaration */
slouken@5272
   128
struct SDL_SysWMinfo;
slouken@5272
   129
slouken@0
   130
/* Define the SDL video driver structure */
slouken@0
   131
#define _THIS	SDL_VideoDevice *_this
slouken@0
   132
slouken@2753
   133
struct SDL_VideoDevice
slouken@2753
   134
{
slouken@2753
   135
    /* * * */
slouken@2753
   136
    /* The name of this video driver */
slouken@2753
   137
    const char *name;
slouken@0
   138
slouken@2753
   139
    /* * * */
slouken@2753
   140
    /* Initialization/Query functions */
slouken@0
   141
slouken@2753
   142
    /*
slouken@2753
   143
     * Initialize the native video subsystem, filling in the list of
slouken@2753
   144
     * displays for this driver, returning 0 or -1 if there's an error.
slouken@2753
   145
     */
slouken@2753
   146
    int (*VideoInit) (_THIS);
slouken@0
   147
slouken@2753
   148
    /*
slouken@2753
   149
     * Reverse the effects VideoInit() -- called if VideoInit() fails or
slouken@2753
   150
     * if the application is shutting down the video subsystem.
slouken@2753
   151
     */
slouken@2753
   152
    void (*VideoQuit) (_THIS);
slouken@1913
   153
slouken@2753
   154
    /* * * */
slouken@2753
   155
    /*
slouken@2753
   156
     * Display functions
slouken@2753
   157
     */
slouken@0
   158
slouken@2753
   159
    /*
slouken@3528
   160
     * Get the bounds of a display
slouken@3528
   161
     */
slouken@3528
   162
    int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
slouken@3528
   163
slouken@3528
   164
    /*
slouken@5246
   165
     * Get a list of the available display modes for a display.
slouken@2753
   166
     */
slouken@3500
   167
    void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
slouken@0
   168
slouken@2753
   169
    /*
slouken@2753
   170
     * Setting the display mode is independent of creating windows, so
slouken@2753
   171
     * when the display mode is changed, all existing windows should have
slouken@2753
   172
     * their data updated accordingly, including the display surfaces
slouken@2753
   173
     * associated with them.
slouken@2753
   174
     */
slouken@3500
   175
    int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
slouken@0
   176
slouken@2753
   177
    /* * * */
slouken@2753
   178
    /*
slouken@2753
   179
     * Window functions
slouken@2753
   180
     */
slouken@2753
   181
    int (*CreateWindow) (_THIS, SDL_Window * window);
slouken@2753
   182
    int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
slouken@2753
   183
    void (*SetWindowTitle) (_THIS, SDL_Window * window);
slouken@2967
   184
    void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
slouken@2753
   185
    void (*SetWindowPosition) (_THIS, SDL_Window * window);
slouken@2753
   186
    void (*SetWindowSize) (_THIS, SDL_Window * window);
stopiccot@6681
   187
    void (*SetWindowMinimumSize) (_THIS, SDL_Window * window);
slouken@6788
   188
    void (*SetWindowMaximumSize) (_THIS, SDL_Window * window);
slouken@2753
   189
    void (*ShowWindow) (_THIS, SDL_Window * window);
slouken@2753
   190
    void (*HideWindow) (_THIS, SDL_Window * window);
slouken@2753
   191
    void (*RaiseWindow) (_THIS, SDL_Window * window);
slouken@2753
   192
    void (*MaximizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   193
    void (*MinimizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   194
    void (*RestoreWindow) (_THIS, SDL_Window * window);
icculus@6422
   195
    void (*SetWindowBordered) (_THIS, SDL_Window * window, SDL_bool bordered);
slouken@5305
   196
    void (*SetWindowFullscreen) (_THIS, SDL_Window * window, SDL_VideoDisplay * display, SDL_bool fullscreen);
slouken@5466
   197
    int (*SetWindowGammaRamp) (_THIS, SDL_Window * window, const Uint16 * ramp);
slouken@5466
   198
    int (*GetWindowGammaRamp) (_THIS, SDL_Window * window, Uint16 * ramp);
slouken@6662
   199
    void (*SetWindowGrab) (_THIS, SDL_Window * window, SDL_bool grabbed);
slouken@2753
   200
    void (*DestroyWindow) (_THIS, SDL_Window * window);
slouken@5166
   201
    int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);
slouken@5297
   202
    int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, SDL_Rect * rects, int numrects);
slouken@5166
   203
    void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);
slouken@5166
   204
eligottlieb@4782
   205
    /* * * */
eligottlieb@4782
   206
    /*
eligottlieb@4782
   207
     * Shaped-window functions
eligottlieb@4782
   208
     */
eligottlieb@4782
   209
    SDL_ShapeDriver shape_driver;
slouken@0
   210
slouken@2753
   211
    /* Get some platform dependent window information */
slouken@2753
   212
      SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
slouken@2753
   213
                                  struct SDL_SysWMinfo * info);
slouken@0
   214
slouken@2753
   215
    /* * * */
slouken@2753
   216
    /*
slouken@2753
   217
     * OpenGL support
slouken@2753
   218
     */
slouken@2753
   219
    int (*GL_LoadLibrary) (_THIS, const char *path);
slouken@2753
   220
    void *(*GL_GetProcAddress) (_THIS, const char *proc);
slouken@3057
   221
    void (*GL_UnloadLibrary) (_THIS);
slouken@2753
   222
      SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
slouken@2753
   223
    int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
slouken@2753
   224
    int (*GL_SetSwapInterval) (_THIS, int interval);
slouken@2753
   225
    int (*GL_GetSwapInterval) (_THIS);
slouken@2753
   226
    void (*GL_SwapWindow) (_THIS, SDL_Window * window);
slouken@2753
   227
    void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
slouken@0
   228
slouken@2753
   229
    /* * * */
slouken@2753
   230
    /*
slouken@2753
   231
     * Event manager functions
slouken@2753
   232
     */
slouken@2753
   233
    void (*PumpEvents) (_THIS);
slouken@0
   234
slouken@3025
   235
    /* Suspend the screensaver */
slouken@3025
   236
    void (*SuspendScreenSaver) (_THIS);
slouken@3025
   237
slouken@3280
   238
    /* Text input */
slouken@3280
   239
    void (*StartTextInput) (_THIS);
slouken@3280
   240
    void (*StopTextInput) (_THIS);
slouken@3280
   241
    void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
slouken@3280
   242
slouken@6392
   243
    /* Screen keyboard */
slouken@6654
   244
    SDL_bool (*SDL_HasScreenKeyboardSupport) (_THIS);
slouken@6654
   245
    void (*SDL_ShowScreenKeyboard) (_THIS, SDL_Window *window);
slouken@6654
   246
    void (*SDL_HideScreenKeyboard) (_THIS, SDL_Window *window);
slouken@6392
   247
    SDL_bool (*SDL_IsScreenKeyboardShown) (_THIS, SDL_Window *window);
slouken@6392
   248
slouken@4495
   249
    /* Clipboard */
slouken@4495
   250
    int (*SetClipboardText) (_THIS, const char *text);
slouken@4495
   251
    char * (*GetClipboardText) (_THIS);
slouken@4495
   252
    SDL_bool (*HasClipboardText) (_THIS);
slouken@4495
   253
slouken@6602
   254
    /* MessageBox */
slouken@6602
   255
    int (*ShowMessageBox) (_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid);
slouken@6602
   256
slouken@2753
   257
    /* * * */
slouken@2753
   258
    /* Data common to all drivers */
slouken@3025
   259
    SDL_bool suspend_screensaver;
slouken@2753
   260
    int num_displays;
slouken@2753
   261
    SDL_VideoDisplay *displays;
slouken@5246
   262
    SDL_Window *windows;
slouken@3695
   263
    Uint8 window_magic;
slouken@2753
   264
    Uint32 next_object_id;
slouken@4495
   265
    char * clipboard_text;
slouken@0
   266
slouken@2753
   267
    /* * * */
slouken@2753
   268
    /* Data used by the GL drivers */
slouken@2753
   269
    struct
slouken@2753
   270
    {
slouken@2753
   271
        int red_size;
slouken@2753
   272
        int green_size;
slouken@2753
   273
        int blue_size;
slouken@2753
   274
        int alpha_size;
slouken@2753
   275
        int depth_size;
slouken@2753
   276
        int buffer_size;
slouken@2753
   277
        int stencil_size;
slouken@2753
   278
        int double_buffer;
slouken@2753
   279
        int accum_red_size;
slouken@2753
   280
        int accum_green_size;
slouken@2753
   281
        int accum_blue_size;
slouken@2753
   282
        int accum_alpha_size;
slouken@2753
   283
        int stereo;
slouken@2753
   284
        int multisamplebuffers;
slouken@2753
   285
        int multisamplesamples;
slouken@2753
   286
        int accelerated;
slouken@3100
   287
        int major_version;
slouken@3100
   288
        int minor_version;
slouken@6296
   289
        int flags;
slouken@6296
   290
        int profile_mask;
slouken@6370
   291
        int use_egl;
slouken@6393
   292
        int share_with_current_context;
slouken@2753
   293
        int retained_backing;
slouken@2753
   294
        int driver_loaded;
slouken@2753
   295
        char driver_path[256];
slouken@2753
   296
        void *dll_handle;
slouken@2753
   297
    } gl_config;
slouken@0
   298
slouken@2753
   299
    /* * * */
icculus@5563
   300
    /* Cache current GL context; don't call the OS when it hasn't changed. */
icculus@5563
   301
    SDL_Window *current_glwin;
icculus@5563
   302
    SDL_GLContext current_glctx;
icculus@5563
   303
icculus@5563
   304
    /* * * */
slouken@2753
   305
    /* Data private to this driver */
slouken@2753
   306
    void *driverdata;
slouken@2753
   307
    struct SDL_GLDriverData *gl_data;
slouken@0
   308
slouken@6370
   309
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
slouken@3161
   310
    struct SDL_PrivateGLESData *gles_data;
slouken@3161
   311
#endif
slouken@3161
   312
slouken@2753
   313
    /* * * */
slouken@2753
   314
    /* The function used to dispose of this structure */
slouken@2753
   315
    void (*free) (_THIS);
slouken@1895
   316
};
slouken@0
   317
slouken@2753
   318
typedef struct VideoBootStrap
slouken@2753
   319
{
slouken@2753
   320
    const char *name;
slouken@2753
   321
    const char *desc;
slouken@2753
   322
    int (*available) (void);
slouken@2753
   323
    SDL_VideoDevice *(*create) (int devindex);
slouken@2753
   324
} VideoBootStrap;
slouken@0
   325
slouken@1931
   326
#if SDL_VIDEO_DRIVER_COCOA
slouken@1931
   327
extern VideoBootStrap COCOA_bootstrap;
slouken@1361
   328
#endif
slouken@1361
   329
#if SDL_VIDEO_DRIVER_X11
slouken@0
   330
extern VideoBootStrap X11_bootstrap;
slouken@0
   331
#endif
slouken@1361
   332
#if SDL_VIDEO_DRIVER_DIRECTFB
slouken@167
   333
extern VideoBootStrap DirectFB_bootstrap;
slouken@167
   334
#endif
slouken@5062
   335
#if SDL_VIDEO_DRIVER_WINDOWS
slouken@5062
   336
extern VideoBootStrap WINDOWS_bootstrap;
slouken@1361
   337
#endif
slouken@1361
   338
#if SDL_VIDEO_DRIVER_BWINDOW
slouken@1361
   339
extern VideoBootStrap BWINDOW_bootstrap;
slouken@1361
   340
#endif
slouken@5150
   341
#if SDL_VIDEO_DRIVER_PANDORA
slouken@5150
   342
extern VideoBootStrap PND_bootstrap;
slouken@3083
   343
#endif
slouken@5150
   344
#if SDL_VIDEO_DRIVER_NDS
slouken@5150
   345
extern VideoBootStrap NDS_bootstrap;
slouken@1361
   346
#endif
hfutrell@2742
   347
#if SDL_VIDEO_DRIVER_UIKIT
hfutrell@2742
   348
extern VideoBootStrap UIKIT_bootstrap;
hfutrell@2742
   349
#endif
slouken@5150
   350
#if SDL_VIDEO_DRIVER_ANDROID
slouken@5150
   351
extern VideoBootStrap Android_bootstrap;
slouken@5150
   352
#endif
slouken@1361
   353
#if SDL_VIDEO_DRIVER_DUMMY
slouken@173
   354
extern VideoBootStrap DUMMY_bootstrap;
slouken@173
   355
#endif
slouken@1361
   356
slouken@4472
   357
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
slouken@2753
   358
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
slouken@2753
   359
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
slouken@3500
   360
extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
slouken@5246
   361
extern SDL_VideoDisplay *SDL_GetDisplayForWindow(SDL_Window *window);
slouken@1895
   362
slouken@2753
   363
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
slouken@1895
   364
slouken@2753
   365
extern void SDL_OnWindowShown(SDL_Window * window);
slouken@2753
   366
extern void SDL_OnWindowHidden(SDL_Window * window);
slouken@5166
   367
extern void SDL_OnWindowResized(SDL_Window * window);
slouken@3502
   368
extern void SDL_OnWindowMinimized(SDL_Window * window);
slouken@3502
   369
extern void SDL_OnWindowRestored(SDL_Window * window);
slouken@2753
   370
extern void SDL_OnWindowFocusGained(SDL_Window * window);
slouken@2753
   371
extern void SDL_OnWindowFocusLost(SDL_Window * window);
slouken@6662
   372
extern void SDL_UpdateWindowGrab(SDL_Window * window);
slouken@3685
   373
extern SDL_Window * SDL_GetFocusWindow(void);
slouken@0
   374
slouken@6784
   375
extern SDL_bool SDL_ShouldAllowTopmost();
slouken@6784
   376
slouken@2753
   377
#endif /* _SDL_sysvideo_h */
slouken@1895
   378
slouken@1895
   379
/* vi: set ts=4 sw=4 expandtab: */