src/video/SDL_sysvideo.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 11 Feb 2011 22:37:15 -0800
changeset 5262 b530ef003506
parent 5261 595814f561f7
child 5272 3c94c559f5c2
permissions -rw-r--r--
Happy 2011! :)
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@5262
     3
    Copyright (C) 1997-2011 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@3500
    79
    SDL_DisplayMode fullscreen_mode;
eligottlieb@4782
    80
    
slouken@5166
    81
    SDL_Surface *surface;
slouken@5174
    82
    SDL_bool surface_valid;
slouken@5166
    83
eligottlieb@4782
    84
    SDL_WindowShaper *shaper;
slouken@3500
    85
slouken@5165
    86
    SDL_WindowUserData *data;
slouken@5165
    87
slouken@2753
    88
    void *driverdata;
slouken@3685
    89
slouken@3685
    90
    SDL_Window *prev;
slouken@3685
    91
    SDL_Window *next;
slouken@1895
    92
};
slouken@1895
    93
#define FULLSCREEN_VISIBLE(W) \
slouken@1895
    94
    (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
slouken@1895
    95
     ((W)->flags & SDL_WINDOW_SHOWN) && \
slouken@1895
    96
     !((W)->flags & SDL_WINDOW_MINIMIZED))
slouken@1895
    97
hfutrell@2742
    98
/*
hfutrell@2742
    99
 * Define the SDL display structure This corresponds to physical monitors
hfutrell@2742
   100
 * attached to the system.
slouken@1895
   101
 */
slouken@2753
   102
struct SDL_VideoDisplay
slouken@2753
   103
{
slouken@2753
   104
    int max_display_modes;
slouken@2753
   105
    int num_display_modes;
slouken@2753
   106
    SDL_DisplayMode *display_modes;
slouken@2753
   107
    SDL_DisplayMode desktop_mode;
slouken@2753
   108
    SDL_DisplayMode current_mode;
slouken@1895
   109
slouken@3517
   110
    SDL_Window *fullscreen_window;
slouken@1895
   111
slouken@2753
   112
    SDL_VideoDevice *device;
slouken@1895
   113
slouken@2753
   114
    void *driverdata;
slouken@1895
   115
};
slouken@1895
   116
slouken@0
   117
/* Define the SDL video driver structure */
slouken@0
   118
#define _THIS	SDL_VideoDevice *_this
slouken@0
   119
slouken@2753
   120
struct SDL_VideoDevice
slouken@2753
   121
{
slouken@2753
   122
    /* * * */
slouken@2753
   123
    /* The name of this video driver */
slouken@2753
   124
    const char *name;
slouken@0
   125
slouken@2753
   126
    /* * * */
slouken@2753
   127
    /* Initialization/Query functions */
slouken@0
   128
slouken@2753
   129
    /*
slouken@2753
   130
     * Initialize the native video subsystem, filling in the list of
slouken@2753
   131
     * displays for this driver, returning 0 or -1 if there's an error.
slouken@2753
   132
     */
slouken@2753
   133
    int (*VideoInit) (_THIS);
slouken@0
   134
slouken@2753
   135
    /*
slouken@2753
   136
     * Reverse the effects VideoInit() -- called if VideoInit() fails or
slouken@2753
   137
     * if the application is shutting down the video subsystem.
slouken@2753
   138
     */
slouken@2753
   139
    void (*VideoQuit) (_THIS);
slouken@1913
   140
slouken@2753
   141
    /* * * */
slouken@2753
   142
    /*
slouken@2753
   143
     * Display functions
slouken@2753
   144
     */
slouken@0
   145
slouken@2753
   146
    /*
slouken@3528
   147
     * Get the bounds of a display
slouken@3528
   148
     */
slouken@3528
   149
    int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
slouken@3528
   150
slouken@3528
   151
    /*
slouken@5246
   152
     * Get a list of the available display modes for a display.
slouken@2753
   153
     */
slouken@3500
   154
    void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
slouken@0
   155
slouken@2753
   156
    /*
slouken@2753
   157
     * Setting the display mode is independent of creating windows, so
slouken@2753
   158
     * when the display mode is changed, all existing windows should have
slouken@2753
   159
     * their data updated accordingly, including the display surfaces
slouken@2753
   160
     * associated with them.
slouken@2753
   161
     */
slouken@3500
   162
    int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
slouken@0
   163
slouken@2753
   164
    /* * * */
slouken@2753
   165
    /*
slouken@2753
   166
     * Window functions
slouken@2753
   167
     */
slouken@2753
   168
    int (*CreateWindow) (_THIS, SDL_Window * window);
slouken@2753
   169
    int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
slouken@2753
   170
    void (*SetWindowTitle) (_THIS, SDL_Window * window);
slouken@2967
   171
    void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
slouken@2753
   172
    void (*SetWindowPosition) (_THIS, SDL_Window * window);
slouken@2753
   173
    void (*SetWindowSize) (_THIS, SDL_Window * window);
slouken@2753
   174
    void (*ShowWindow) (_THIS, SDL_Window * window);
slouken@2753
   175
    void (*HideWindow) (_THIS, SDL_Window * window);
slouken@2753
   176
    void (*RaiseWindow) (_THIS, SDL_Window * window);
slouken@2753
   177
    void (*MaximizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   178
    void (*MinimizeWindow) (_THIS, SDL_Window * window);
slouken@2753
   179
    void (*RestoreWindow) (_THIS, SDL_Window * window);
slouken@5249
   180
    void (*PrepWindowFullscreen) (_THIS, SDL_Window * window);
slouken@5249
   181
    void (*SetWindowFullscreen) (_THIS, SDL_Window * window);
slouken@2753
   182
    void (*SetWindowGrab) (_THIS, SDL_Window * window);
slouken@2753
   183
    void (*DestroyWindow) (_THIS, SDL_Window * window);
slouken@5166
   184
    int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);
slouken@5166
   185
    int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, int numrects, SDL_Rect * rects);
slouken@5166
   186
    void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);
slouken@5166
   187
eligottlieb@4782
   188
    /* * * */
eligottlieb@4782
   189
    /*
eligottlieb@4782
   190
     * Shaped-window functions
eligottlieb@4782
   191
     */
eligottlieb@4782
   192
    SDL_ShapeDriver shape_driver;
slouken@0
   193
slouken@2753
   194
    /* Get some platform dependent window information */
slouken@2753
   195
      SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
slouken@2753
   196
                                  struct SDL_SysWMinfo * info);
slouken@0
   197
slouken@2753
   198
    /* * * */
slouken@2753
   199
    /*
slouken@2753
   200
     * OpenGL support
slouken@2753
   201
     */
slouken@2753
   202
    int (*GL_LoadLibrary) (_THIS, const char *path);
slouken@2753
   203
    void *(*GL_GetProcAddress) (_THIS, const char *proc);
slouken@3057
   204
    void (*GL_UnloadLibrary) (_THIS);
slouken@2753
   205
      SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
slouken@2753
   206
    int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
slouken@2753
   207
    int (*GL_SetSwapInterval) (_THIS, int interval);
slouken@2753
   208
    int (*GL_GetSwapInterval) (_THIS);
slouken@2753
   209
    void (*GL_SwapWindow) (_THIS, SDL_Window * window);
slouken@2753
   210
    void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
slouken@0
   211
slouken@2753
   212
    /* * * */
slouken@2753
   213
    /*
slouken@2753
   214
     * Event manager functions
slouken@2753
   215
     */
slouken@2753
   216
    void (*PumpEvents) (_THIS);
slouken@0
   217
slouken@3025
   218
    /* Suspend the screensaver */
slouken@3025
   219
    void (*SuspendScreenSaver) (_THIS);
slouken@3025
   220
slouken@3280
   221
    /* Text input */
slouken@3280
   222
    void (*StartTextInput) (_THIS);
slouken@3280
   223
    void (*StopTextInput) (_THIS);
slouken@3280
   224
    void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
slouken@3280
   225
slouken@4495
   226
    /* Clipboard */
slouken@4495
   227
    int (*SetClipboardText) (_THIS, const char *text);
slouken@4495
   228
    char * (*GetClipboardText) (_THIS);
slouken@4495
   229
    SDL_bool (*HasClipboardText) (_THIS);
slouken@4495
   230
slouken@2753
   231
    /* * * */
slouken@2753
   232
    /* Data common to all drivers */
slouken@3025
   233
    SDL_bool suspend_screensaver;
slouken@2753
   234
    int num_displays;
slouken@2753
   235
    SDL_VideoDisplay *displays;
slouken@5246
   236
    SDL_Window *windows;
slouken@3695
   237
    Uint8 window_magic;
slouken@2753
   238
    Uint32 next_object_id;
slouken@4495
   239
    char * clipboard_text;
slouken@0
   240
slouken@2753
   241
    /* * * */
slouken@2753
   242
    /* Data used by the GL drivers */
slouken@2753
   243
    struct
slouken@2753
   244
    {
slouken@2753
   245
        int red_size;
slouken@2753
   246
        int green_size;
slouken@2753
   247
        int blue_size;
slouken@2753
   248
        int alpha_size;
slouken@2753
   249
        int depth_size;
slouken@2753
   250
        int buffer_size;
slouken@2753
   251
        int stencil_size;
slouken@2753
   252
        int double_buffer;
slouken@2753
   253
        int accum_red_size;
slouken@2753
   254
        int accum_green_size;
slouken@2753
   255
        int accum_blue_size;
slouken@2753
   256
        int accum_alpha_size;
slouken@2753
   257
        int stereo;
slouken@2753
   258
        int multisamplebuffers;
slouken@2753
   259
        int multisamplesamples;
slouken@2753
   260
        int accelerated;
slouken@3100
   261
        int major_version;
slouken@3100
   262
        int minor_version;
slouken@2753
   263
        int retained_backing;
slouken@2753
   264
        int driver_loaded;
slouken@2753
   265
        char driver_path[256];
slouken@2753
   266
        void *dll_handle;
slouken@2753
   267
    } gl_config;
slouken@0
   268
slouken@2753
   269
    /* * * */
slouken@2753
   270
    /* Data private to this driver */
slouken@2753
   271
    void *driverdata;
slouken@2753
   272
    struct SDL_GLDriverData *gl_data;
slouken@0
   273
slouken@3161
   274
#if SDL_VIDEO_DRIVER_PANDORA
slouken@3161
   275
    struct SDL_PrivateGLESData *gles_data;
slouken@3161
   276
#endif
slouken@3161
   277
slouken@2753
   278
    /* * * */
slouken@2753
   279
    /* The function used to dispose of this structure */
slouken@2753
   280
    void (*free) (_THIS);
slouken@1895
   281
};
slouken@0
   282
slouken@2753
   283
typedef struct VideoBootStrap
slouken@2753
   284
{
slouken@2753
   285
    const char *name;
slouken@2753
   286
    const char *desc;
slouken@2753
   287
    int (*available) (void);
slouken@2753
   288
    SDL_VideoDevice *(*create) (int devindex);
slouken@2753
   289
} VideoBootStrap;
slouken@0
   290
slouken@1931
   291
#if SDL_VIDEO_DRIVER_COCOA
slouken@1931
   292
extern VideoBootStrap COCOA_bootstrap;
slouken@1361
   293
#endif
slouken@1361
   294
#if SDL_VIDEO_DRIVER_X11
slouken@0
   295
extern VideoBootStrap X11_bootstrap;
slouken@0
   296
#endif
slouken@1361
   297
#if SDL_VIDEO_DRIVER_DIRECTFB
slouken@167
   298
extern VideoBootStrap DirectFB_bootstrap;
slouken@167
   299
#endif
slouken@5062
   300
#if SDL_VIDEO_DRIVER_WINDOWS
slouken@5062
   301
extern VideoBootStrap WINDOWS_bootstrap;
slouken@1361
   302
#endif
slouken@1361
   303
#if SDL_VIDEO_DRIVER_BWINDOW
slouken@1361
   304
extern VideoBootStrap BWINDOW_bootstrap;
slouken@1361
   305
#endif
slouken@5150
   306
#if SDL_VIDEO_DRIVER_PANDORA
slouken@5150
   307
extern VideoBootStrap PND_bootstrap;
slouken@3083
   308
#endif
slouken@5150
   309
#if SDL_VIDEO_DRIVER_NDS
slouken@5150
   310
extern VideoBootStrap NDS_bootstrap;
slouken@1361
   311
#endif
hfutrell@2742
   312
#if SDL_VIDEO_DRIVER_UIKIT
hfutrell@2742
   313
extern VideoBootStrap UIKIT_bootstrap;
hfutrell@2742
   314
#endif
slouken@5150
   315
#if SDL_VIDEO_DRIVER_ANDROID
slouken@5150
   316
extern VideoBootStrap Android_bootstrap;
slouken@5150
   317
#endif
slouken@1361
   318
#if SDL_VIDEO_DRIVER_DUMMY
slouken@173
   319
extern VideoBootStrap DUMMY_bootstrap;
slouken@173
   320
#endif
slouken@1361
   321
slouken@4472
   322
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
slouken@2753
   323
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
slouken@2753
   324
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
slouken@3500
   325
extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
slouken@5246
   326
extern SDL_VideoDisplay *SDL_GetDisplayForWindow(SDL_Window *window);
slouken@1895
   327
slouken@2753
   328
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
slouken@1895
   329
slouken@2753
   330
extern void SDL_OnWindowShown(SDL_Window * window);
slouken@2753
   331
extern void SDL_OnWindowHidden(SDL_Window * window);
slouken@5166
   332
extern void SDL_OnWindowResized(SDL_Window * window);
slouken@3502
   333
extern void SDL_OnWindowMinimized(SDL_Window * window);
slouken@3502
   334
extern void SDL_OnWindowRestored(SDL_Window * window);
slouken@2753
   335
extern void SDL_OnWindowFocusGained(SDL_Window * window);
slouken@2753
   336
extern void SDL_OnWindowFocusLost(SDL_Window * window);
slouken@3685
   337
extern SDL_Window * SDL_GetFocusWindow(void);
slouken@0
   338
slouken@2753
   339
#endif /* _SDL_sysvideo_h */
slouken@1895
   340
slouken@1895
   341
/* vi: set ts=4 sw=4 expandtab: */