src/video/SDL_sysvideo.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 03 Feb 2011 11:16:57 -0800
changeset 5165 2b1989f59674
parent 5154 fb424691cfc7
child 5166 4d39eeaad00b
permissions -rw-r--r--
Extended SDL_SetWindowData() to allow arbitrary named values.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@3697
     3
    Copyright (C) 1997-2010 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@252
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@1402
    22
#include "SDL_config.h"
slouken@0
    23
slouken@0
    24
#ifndef _SDL_sysvideo_h
slouken@0
    25
#define _SDL_sysvideo_h
slouken@0
    26
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;
slouken@2753
    77
    Uint32 flags;
slouken@1895
    78
slouken@3685
    79
    SDL_VideoDisplay *display;
slouken@1895
    80
slouken@3500
    81
    SDL_DisplayMode fullscreen_mode;
eligottlieb@4782
    82
    
eligottlieb@4782
    83
    SDL_WindowShaper *shaper;
slouken@3500
    84
slouken@5165
    85
    SDL_WindowUserData *data;
slouken@5165
    86
slouken@2753
    87
    void *driverdata;
slouken@3685
    88
slouken@3685
    89
    SDL_Window *prev;
slouken@3685
    90
    SDL_Window *next;
slouken@1895
    91
};
slouken@1895
    92
#define FULLSCREEN_VISIBLE(W) \
slouken@1895
    93
    (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
slouken@1895
    94
     ((W)->flags & SDL_WINDOW_SHOWN) && \
slouken@1895
    95
     !((W)->flags & SDL_WINDOW_MINIMIZED))
slouken@1895
    96
hfutrell@2742
    97
/*
hfutrell@2742
    98
 * Define the SDL display structure This corresponds to physical monitors
hfutrell@2742
    99
 * attached to the system.
slouken@1895
   100
 */
slouken@2753
   101
struct SDL_VideoDisplay
slouken@2753
   102
{
slouken@2753
   103
    int max_display_modes;
slouken@2753
   104
    int num_display_modes;
slouken@2753
   105
    SDL_DisplayMode *display_modes;
slouken@2753
   106
    SDL_DisplayMode desktop_mode;
slouken@2753
   107
    SDL_DisplayMode current_mode;
slouken@3502
   108
    SDL_bool updating_fullscreen;
slouken@1895
   109
slouken@2753
   110
    Uint16 *gamma;
slouken@2753
   111
    Uint16 *saved_gamma;        /* (just offset into gamma) */
slouken@1895
   112
slouken@2753
   113
    SDL_Window *windows;
slouken@3517
   114
    SDL_Window *fullscreen_window;
slouken@1895
   115
slouken@2753
   116
    SDL_VideoDevice *device;
slouken@1895
   117
slouken@2753
   118
    void *driverdata;
slouken@1895
   119
};
slouken@1895
   120
slouken@0
   121
/* Define the SDL video driver structure */
slouken@0
   122
#define _THIS	SDL_VideoDevice *_this
slouken@0
   123
slouken@2753
   124
struct SDL_VideoDevice
slouken@2753
   125
{
slouken@2753
   126
    /* * * */
slouken@2753
   127
    /* The name of this video driver */
slouken@2753
   128
    const char *name;
slouken@0
   129
slouken@2753
   130
    /* * * */
slouken@2753
   131
    /* Initialization/Query functions */
slouken@0
   132
slouken@2753
   133
    /*
slouken@2753
   134
     * Initialize the native video subsystem, filling in the list of
slouken@2753
   135
     * displays for this driver, returning 0 or -1 if there's an error.
slouken@2753
   136
     */
slouken@2753
   137
    int (*VideoInit) (_THIS);
slouken@0
   138
slouken@2753
   139
    /*
slouken@2753
   140
     * Reverse the effects VideoInit() -- called if VideoInit() fails or
slouken@2753
   141
     * if the application is shutting down the video subsystem.
slouken@2753
   142
     */
slouken@2753
   143
    void (*VideoQuit) (_THIS);
slouken@1913
   144
slouken@2753
   145
    /* * * */
slouken@2753
   146
    /*
slouken@2753
   147
     * Display functions
slouken@2753
   148
     */
slouken@0
   149
slouken@2753
   150
    /*
slouken@3528
   151
     * Get the bounds of a display
slouken@3528
   152
     */
slouken@3528
   153
    int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
slouken@3528
   154
slouken@3528
   155
    /*
slouken@2753
   156
     * Get a list of the available display modes. e.g.
slouken@2753
   157
     * SDL_AddDisplayMode(_this->current_display, mode)
slouken@2753
   158
     */
slouken@3500
   159
    void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
slouken@0
   160
slouken@2753
   161
    /*
slouken@2753
   162
     * Setting the display mode is independent of creating windows, so
slouken@2753
   163
     * when the display mode is changed, all existing windows should have
slouken@2753
   164
     * their data updated accordingly, including the display surfaces
slouken@2753
   165
     * associated with them.
slouken@2753
   166
     */
slouken@3500
   167
    int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
slouken@0
   168
slouken@2753
   169
    /* Set the gamma ramp */
slouken@3500
   170
    int (*SetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
slouken@0
   171
slouken@2753
   172
    /* Get the gamma ramp */
slouken@3500
   173
    int (*GetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
slouken@0
   174
slouken@2753
   175
    /* * * */
slouken@2753
   176
    /*
slouken@2753
   177
     * Window functions
slouken@2753
   178
     */
slouken@2753
   179
    int (*CreateWindow) (_THIS, SDL_Window * window);
slouken@2753
   180
    int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
slouken@2753
   181
    void (*SetWindowTitle) (_THIS, SDL_Window * window);
slouken@2967
   182
    void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
slouken@2753
   183
    void (*SetWindowPosition) (_THIS, SDL_Window * window);
slouken@2753
   184
    void (*SetWindowSize) (_THIS, SDL_Window * window);
slouken@2753
   185
    void (*ShowWindow) (_THIS, SDL_Window * window);
slouken@2753
   186
    void (*HideWindow) (_THIS, SDL_Window * window);
slouken@2753
   187
    void (*RaiseWindow) (_THIS, SDL_Window * window);
slouken@2753
   188
    void (*MaximizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   189
    void (*MinimizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   190
    void (*RestoreWindow) (_THIS, SDL_Window * window);
slouken@2753
   191
    void (*SetWindowGrab) (_THIS, SDL_Window * window);
slouken@2753
   192
    void (*DestroyWindow) (_THIS, SDL_Window * window);
eligottlieb@4782
   193
    
eligottlieb@4782
   194
    /* * * */
eligottlieb@4782
   195
    /*
eligottlieb@4782
   196
     * Shaped-window functions
eligottlieb@4782
   197
     */
eligottlieb@4782
   198
    SDL_ShapeDriver shape_driver;
slouken@0
   199
slouken@2753
   200
    /* Get some platform dependent window information */
slouken@2753
   201
      SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
slouken@2753
   202
                                  struct SDL_SysWMinfo * info);
slouken@0
   203
slouken@2753
   204
    /* * * */
slouken@2753
   205
    /*
slouken@2753
   206
     * OpenGL support
slouken@2753
   207
     */
slouken@2753
   208
    int (*GL_LoadLibrary) (_THIS, const char *path);
slouken@2753
   209
    void *(*GL_GetProcAddress) (_THIS, const char *proc);
slouken@3057
   210
    void (*GL_UnloadLibrary) (_THIS);
slouken@2753
   211
      SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
slouken@2753
   212
    int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
slouken@2753
   213
    int (*GL_SetSwapInterval) (_THIS, int interval);
slouken@2753
   214
    int (*GL_GetSwapInterval) (_THIS);
slouken@2753
   215
    void (*GL_SwapWindow) (_THIS, SDL_Window * window);
slouken@2753
   216
    void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
slouken@0
   217
slouken@2753
   218
    /* * * */
slouken@2753
   219
    /*
slouken@2753
   220
     * Event manager functions
slouken@2753
   221
     */
slouken@2753
   222
    void (*PumpEvents) (_THIS);
slouken@0
   223
slouken@3025
   224
    /* Suspend the screensaver */
slouken@3025
   225
    void (*SuspendScreenSaver) (_THIS);
slouken@3025
   226
slouken@3280
   227
    /* Text input */
slouken@3280
   228
    void (*StartTextInput) (_THIS);
slouken@3280
   229
    void (*StopTextInput) (_THIS);
slouken@3280
   230
    void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
slouken@3280
   231
slouken@4495
   232
    /* Clipboard */
slouken@4495
   233
    int (*SetClipboardText) (_THIS, const char *text);
slouken@4495
   234
    char * (*GetClipboardText) (_THIS);
slouken@4495
   235
    SDL_bool (*HasClipboardText) (_THIS);
slouken@4495
   236
slouken@2753
   237
    /* * * */
slouken@2753
   238
    /* Data common to all drivers */
slouken@3025
   239
    SDL_bool suspend_screensaver;
slouken@2753
   240
    int num_displays;
slouken@2753
   241
    SDL_VideoDisplay *displays;
slouken@2753
   242
    int current_display;
slouken@3695
   243
    Uint8 window_magic;
slouken@2753
   244
    Uint32 next_object_id;
slouken@4495
   245
    char * clipboard_text;
slouken@0
   246
slouken@2753
   247
    /* * * */
slouken@2753
   248
    /* Data used by the GL drivers */
slouken@2753
   249
    struct
slouken@2753
   250
    {
slouken@2753
   251
        int red_size;
slouken@2753
   252
        int green_size;
slouken@2753
   253
        int blue_size;
slouken@2753
   254
        int alpha_size;
slouken@2753
   255
        int depth_size;
slouken@2753
   256
        int buffer_size;
slouken@2753
   257
        int stencil_size;
slouken@2753
   258
        int double_buffer;
slouken@2753
   259
        int accum_red_size;
slouken@2753
   260
        int accum_green_size;
slouken@2753
   261
        int accum_blue_size;
slouken@2753
   262
        int accum_alpha_size;
slouken@2753
   263
        int stereo;
slouken@2753
   264
        int multisamplebuffers;
slouken@2753
   265
        int multisamplesamples;
slouken@2753
   266
        int accelerated;
slouken@3100
   267
        int major_version;
slouken@3100
   268
        int minor_version;
slouken@2753
   269
        int retained_backing;
slouken@2753
   270
        int driver_loaded;
slouken@2753
   271
        char driver_path[256];
slouken@2753
   272
        void *dll_handle;
slouken@2753
   273
    } gl_config;
slouken@0
   274
slouken@2753
   275
    /* * * */
slouken@2753
   276
    /* Data private to this driver */
slouken@2753
   277
    void *driverdata;
slouken@2753
   278
    struct SDL_GLDriverData *gl_data;
slouken@0
   279
slouken@3161
   280
#if SDL_VIDEO_DRIVER_PANDORA
slouken@3161
   281
    struct SDL_PrivateGLESData *gles_data;
slouken@3161
   282
#endif
slouken@3161
   283
slouken@2753
   284
    /* * * */
slouken@2753
   285
    /* The function used to dispose of this structure */
slouken@2753
   286
    void (*free) (_THIS);
slouken@1895
   287
};
slouken@0
   288
slouken@2753
   289
typedef struct VideoBootStrap
slouken@2753
   290
{
slouken@2753
   291
    const char *name;
slouken@2753
   292
    const char *desc;
slouken@2753
   293
    int (*available) (void);
slouken@2753
   294
    SDL_VideoDevice *(*create) (int devindex);
slouken@2753
   295
} VideoBootStrap;
slouken@0
   296
slouken@1931
   297
#if SDL_VIDEO_DRIVER_COCOA
slouken@1931
   298
extern VideoBootStrap COCOA_bootstrap;
slouken@1361
   299
#endif
slouken@1361
   300
#if SDL_VIDEO_DRIVER_X11
slouken@0
   301
extern VideoBootStrap X11_bootstrap;
slouken@0
   302
#endif
slouken@1361
   303
#if SDL_VIDEO_DRIVER_DIRECTFB
slouken@167
   304
extern VideoBootStrap DirectFB_bootstrap;
slouken@167
   305
#endif
slouken@5062
   306
#if SDL_VIDEO_DRIVER_WINDOWS
slouken@5062
   307
extern VideoBootStrap WINDOWS_bootstrap;
slouken@1361
   308
#endif
slouken@1361
   309
#if SDL_VIDEO_DRIVER_BWINDOW
slouken@1361
   310
extern VideoBootStrap BWINDOW_bootstrap;
slouken@1361
   311
#endif
slouken@5150
   312
#if SDL_VIDEO_DRIVER_PANDORA
slouken@5150
   313
extern VideoBootStrap PND_bootstrap;
slouken@3083
   314
#endif
slouken@5150
   315
#if SDL_VIDEO_DRIVER_NDS
slouken@5150
   316
extern VideoBootStrap NDS_bootstrap;
slouken@1361
   317
#endif
hfutrell@2742
   318
#if SDL_VIDEO_DRIVER_UIKIT
hfutrell@2742
   319
extern VideoBootStrap UIKIT_bootstrap;
hfutrell@2742
   320
#endif
slouken@5150
   321
#if SDL_VIDEO_DRIVER_ANDROID
slouken@5150
   322
extern VideoBootStrap Android_bootstrap;
slouken@5150
   323
#endif
slouken@1361
   324
#if SDL_VIDEO_DRIVER_DUMMY
slouken@173
   325
extern VideoBootStrap DUMMY_bootstrap;
slouken@173
   326
#endif
slouken@1361
   327
slouken@3685
   328
#define SDL_CurrentDisplay	(&_this->displays[_this->current_display])
slouken@0
   329
slouken@4472
   330
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
slouken@2753
   331
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
slouken@2753
   332
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
slouken@3500
   333
extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
slouken@3500
   334
extern int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay * display);
slouken@3500
   335
extern int SDL_GetDisplayModeForDisplay(SDL_VideoDisplay * display, int index, SDL_DisplayMode * mode);
slouken@3500
   336
extern int SDL_GetDesktopDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
slouken@3500
   337
extern int SDL_GetCurrentDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
slouken@3500
   338
extern SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
slouken@3500
   339
extern int SDL_SetDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode);
slouken@3500
   340
extern int SDL_SetGammaRampForDisplay(SDL_VideoDisplay * display, const Uint16 * red, const Uint16 * green, const Uint16 * blue);
slouken@3500
   341
extern int SDL_GetGammaRampForDisplay(SDL_VideoDisplay * display, Uint16 * red, Uint16 * green, Uint16 * blue);
slouken@1895
   342
slouken@2753
   343
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
slouken@1895
   344
slouken@2753
   345
extern void SDL_OnWindowShown(SDL_Window * window);
slouken@2753
   346
extern void SDL_OnWindowHidden(SDL_Window * window);
slouken@3502
   347
extern void SDL_OnWindowMinimized(SDL_Window * window);
slouken@3502
   348
extern void SDL_OnWindowRestored(SDL_Window * window);
slouken@2753
   349
extern void SDL_OnWindowFocusGained(SDL_Window * window);
slouken@2753
   350
extern void SDL_OnWindowFocusLost(SDL_Window * window);
slouken@3685
   351
extern SDL_Window * SDL_GetFocusWindow(void);
slouken@0
   352
slouken@2753
   353
#endif /* _SDL_sysvideo_h */
slouken@1895
   354
slouken@1895
   355
/* vi: set ts=4 sw=4 expandtab: */