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