src/video/SDL_sysvideo.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 01 Dec 2009 08:56:12 +0000
changeset 3502 98a819296cdc
parent 3501 467e67d301f3
child 3511 42cfa69e351b
permissions -rw-r--r--
Whenever a window becomes fullscreen, shown, unminimized, and has input focus it will change the display to the corresponding fullscreen video mode.
If it loses any of those properties the desktop mode will be restored.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 #include "SDL_config.h"
    23 
    24 #ifndef _SDL_sysvideo_h
    25 #define _SDL_sysvideo_h
    26 
    27 #include "SDL_mouse.h"
    28 #include "SDL_keysym.h"
    29 
    30 /* The SDL video driver */
    31 
    32 typedef struct SDL_Window SDL_Window;
    33 typedef struct SDL_Texture SDL_Texture;
    34 typedef struct SDL_Renderer SDL_Renderer;
    35 typedef struct SDL_RenderDriver SDL_RenderDriver;
    36 typedef struct SDL_VideoDisplay SDL_VideoDisplay;
    37 typedef struct SDL_VideoDevice SDL_VideoDevice;
    38 
    39 /* Define the SDL texture structure */
    40 struct SDL_Texture
    41 {
    42     Uint32 id;
    43 
    44     Uint32 format;              /**< The pixel format of the texture */
    45     int access;                 /**< SDL_TextureAccess */
    46     int w;                      /**< The width of the texture */
    47     int h;                      /**< The height of the texture */
    48     int modMode;                /**< The texture modulation mode */
    49     int blendMode;                      /**< The texture blend mode */
    50     int scaleMode;                      /**< The texture scale mode */
    51     Uint8 r, g, b, a;                   /**< Texture modulation values */
    52 
    53     SDL_Renderer *renderer;
    54 
    55     void *driverdata;                   /**< Driver specific texture representation */
    56 
    57     SDL_Texture *next;
    58 };
    59 
    60 /* Define the SDL renderer structure */
    61 struct SDL_Renderer
    62 {
    63     int (*ActivateRenderer) (SDL_Renderer * renderer);
    64     int (*DisplayModeChanged) (SDL_Renderer * renderer);
    65     int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
    66     int (*QueryTexturePixels) (SDL_Renderer * renderer, SDL_Texture * texture,
    67                                void **pixels, int *pitch);
    68     int (*SetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
    69                               const SDL_Color * colors, int firstcolor,
    70                               int ncolors);
    71     int (*GetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
    72                               SDL_Color * colors, int firstcolor,
    73                               int ncolors);
    74     int (*SetTextureColorMod) (SDL_Renderer * renderer,
    75                                SDL_Texture * texture);
    76     int (*SetTextureAlphaMod) (SDL_Renderer * renderer,
    77                                SDL_Texture * texture);
    78     int (*SetTextureBlendMode) (SDL_Renderer * renderer,
    79                                 SDL_Texture * texture);
    80     int (*SetTextureScaleMode) (SDL_Renderer * renderer,
    81                                 SDL_Texture * texture);
    82     int (*UpdateTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    83                           const SDL_Rect * rect, const void *pixels,
    84                           int pitch);
    85     int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    86                         const SDL_Rect * rect, int markDirty, void **pixels,
    87                         int *pitch);
    88     void (*UnlockTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
    89     void (*DirtyTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    90                           int numrects, const SDL_Rect * rects);
    91     int (*SetDrawColor) (SDL_Renderer * renderer);
    92     int (*SetDrawBlendMode) (SDL_Renderer * renderer);
    93     int (*RenderPoint) (SDL_Renderer * renderer, int x, int y);
    94     int (*RenderLine) (SDL_Renderer * renderer, int x1, int y1, int x2,
    95                        int y2);
    96     int (*RenderFill) (SDL_Renderer * renderer, const SDL_Rect * rect);
    97     int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
    98                        const SDL_Rect * srcrect, const SDL_Rect * dstrect);
    99     int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
   100                              Uint32 format, void * pixels, int pitch);
   101     int (*RenderWritePixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
   102                               Uint32 format, const void * pixels, int pitch);
   103     void (*RenderPresent) (SDL_Renderer * renderer);
   104     void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
   105 
   106     void (*DestroyRenderer) (SDL_Renderer * renderer);
   107 
   108     /* The current renderer info */
   109     SDL_RendererInfo info;
   110 
   111     /* The window associated with the renderer */
   112     SDL_WindowID window;
   113 
   114     Uint8 r, g, b, a;                   /**< Color for drawing operations values */
   115     int blendMode;                      /**< The drawing blend mode */
   116 
   117     void *driverdata;
   118 };
   119 
   120 /* Define the SDL render driver structure */
   121 struct SDL_RenderDriver
   122 {
   123     SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
   124 
   125     /* Info about the renderer capabilities */
   126     SDL_RendererInfo info;
   127 };
   128 
   129 /* Define the SDL window structure, corresponding to toplevel windows */
   130 struct SDL_Window
   131 {
   132     Uint32 id;
   133 
   134     char *title;
   135     int x, y;
   136     int w, h;
   137     Uint32 flags;
   138 
   139     int display;
   140     SDL_Renderer *renderer;
   141 
   142     SDL_DisplayMode fullscreen_mode;
   143 
   144     void *userdata;
   145     void *driverdata;
   146 };
   147 #define FULLSCREEN_VISIBLE(W) \
   148     (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
   149      ((W)->flags & SDL_WINDOW_SHOWN) && \
   150      ((W)->flags & SDL_WINDOW_INPUT_FOCUS) && \
   151      !((W)->flags & SDL_WINDOW_MINIMIZED))
   152 
   153 /*
   154  * Define the SDL display structure This corresponds to physical monitors
   155  * attached to the system.
   156  */
   157 struct SDL_VideoDisplay
   158 {
   159     int max_display_modes;
   160     int num_display_modes;
   161     SDL_DisplayMode *display_modes;
   162     SDL_DisplayMode desktop_mode;
   163     SDL_DisplayMode current_mode;
   164     SDL_bool updating_fullscreen;
   165     SDL_Palette *palette;
   166 
   167     Uint16 *gamma;
   168     Uint16 *saved_gamma;        /* (just offset into gamma) */
   169 
   170     int num_render_drivers;
   171     SDL_RenderDriver *render_drivers;
   172 
   173     int num_windows;
   174     SDL_Window *windows;
   175 
   176     SDL_Renderer *current_renderer;
   177 
   178     /* The hash list of textures */
   179     SDL_Texture *textures[64];
   180 
   181     SDL_VideoDevice *device;
   182 
   183     void *driverdata;
   184 };
   185 
   186 /* Define the SDL video driver structure */
   187 #define _THIS	SDL_VideoDevice *_this
   188 
   189 struct SDL_VideoDevice
   190 {
   191     /* * * */
   192     /* The name of this video driver */
   193     const char *name;
   194 
   195     /* * * */
   196     /* Initialization/Query functions */
   197 
   198     /*
   199      * Initialize the native video subsystem, filling in the list of
   200      * displays for this driver, returning 0 or -1 if there's an error.
   201      */
   202     int (*VideoInit) (_THIS);
   203 
   204     /*
   205      * Reverse the effects VideoInit() -- called if VideoInit() fails or
   206      * if the application is shutting down the video subsystem.
   207      */
   208     void (*VideoQuit) (_THIS);
   209 
   210     /* * * */
   211     /*
   212      * Display functions
   213      */
   214 
   215     /*
   216      * Get a list of the available display modes. e.g.
   217      * SDL_AddDisplayMode(_this->current_display, mode)
   218      */
   219     void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
   220 
   221     /*
   222      * Setting the display mode is independent of creating windows, so
   223      * when the display mode is changed, all existing windows should have
   224      * their data updated accordingly, including the display surfaces
   225      * associated with them.
   226      */
   227     int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   228 
   229     /* Set the color entries of the display palette */
   230     int (*SetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
   231 
   232     /* Get the color entries of the display palette */
   233     int (*GetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
   234 
   235     /* Set the gamma ramp */
   236     int (*SetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
   237 
   238     /* Get the gamma ramp */
   239     int (*GetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
   240 
   241     /* * * */
   242     /*
   243      * Window functions
   244      */
   245     int (*CreateWindow) (_THIS, SDL_Window * window);
   246     int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
   247     void (*SetWindowTitle) (_THIS, SDL_Window * window);
   248     void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
   249     void (*SetWindowPosition) (_THIS, SDL_Window * window);
   250     void (*SetWindowSize) (_THIS, SDL_Window * window);
   251     void (*ShowWindow) (_THIS, SDL_Window * window);
   252     void (*HideWindow) (_THIS, SDL_Window * window);
   253     void (*RaiseWindow) (_THIS, SDL_Window * window);
   254     void (*MaximizeWindow) (_THIS, SDL_Window * window);
   255     void (*MinimizeWindow) (_THIS, SDL_Window * window);
   256     void (*RestoreWindow) (_THIS, SDL_Window * window);
   257     void (*SetWindowGrab) (_THIS, SDL_Window * window);
   258     void (*DestroyWindow) (_THIS, SDL_Window * window);
   259 
   260     /* Get some platform dependent window information */
   261       SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
   262                                   struct SDL_SysWMinfo * info);
   263 
   264     /* * * */
   265     /*
   266      * OpenGL support
   267      */
   268     int (*GL_LoadLibrary) (_THIS, const char *path);
   269     void *(*GL_GetProcAddress) (_THIS, const char *proc);
   270     void (*GL_UnloadLibrary) (_THIS);
   271       SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
   272     int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
   273     int (*GL_SetSwapInterval) (_THIS, int interval);
   274     int (*GL_GetSwapInterval) (_THIS);
   275     void (*GL_SwapWindow) (_THIS, SDL_Window * window);
   276     void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
   277 
   278     /* * * */
   279     /*
   280      * Event manager functions
   281      */
   282     void (*PumpEvents) (_THIS);
   283 
   284     /* Suspend the screensaver */
   285     void (*SuspendScreenSaver) (_THIS);
   286 
   287     /* Text input */
   288     void (*StartTextInput) (_THIS);
   289     void (*StopTextInput) (_THIS);
   290     void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
   291 
   292     /* * * */
   293     /* Data common to all drivers */
   294     SDL_bool suspend_screensaver;
   295     int num_displays;
   296     SDL_VideoDisplay *displays;
   297     int current_display;
   298     Uint32 next_object_id;
   299 
   300     /* * * */
   301     /* Data used by the GL drivers */
   302     struct
   303     {
   304         int red_size;
   305         int green_size;
   306         int blue_size;
   307         int alpha_size;
   308         int depth_size;
   309         int buffer_size;
   310         int stencil_size;
   311         int double_buffer;
   312         int accum_red_size;
   313         int accum_green_size;
   314         int accum_blue_size;
   315         int accum_alpha_size;
   316         int stereo;
   317         int multisamplebuffers;
   318         int multisamplesamples;
   319         int accelerated;
   320         int major_version;
   321         int minor_version;
   322         int retained_backing;
   323         int driver_loaded;
   324         char driver_path[256];
   325         void *dll_handle;
   326     } gl_config;
   327 
   328     /* * * */
   329     /* Data private to this driver */
   330     void *driverdata;
   331     struct SDL_GLDriverData *gl_data;
   332 
   333 #if SDL_VIDEO_DRIVER_PANDORA
   334     struct SDL_PrivateGLESData *gles_data;
   335 #endif
   336 
   337     /* * * */
   338     /* The function used to dispose of this structure */
   339     void (*free) (_THIS);
   340 };
   341 
   342 typedef struct VideoBootStrap
   343 {
   344     const char *name;
   345     const char *desc;
   346     int (*available) (void);
   347     SDL_VideoDevice *(*create) (int devindex);
   348 } VideoBootStrap;
   349 
   350 #if SDL_VIDEO_DRIVER_COCOA
   351 extern VideoBootStrap COCOA_bootstrap;
   352 #endif
   353 #if SDL_VIDEO_DRIVER_X11
   354 extern VideoBootStrap X11_bootstrap;
   355 #endif
   356 #if SDL_VIDEO_DRIVER_FBCON
   357 extern VideoBootStrap FBCON_bootstrap;
   358 #endif
   359 #if SDL_VIDEO_DRIVER_DIRECTFB
   360 extern VideoBootStrap DirectFB_bootstrap;
   361 #endif
   362 #if SDL_VIDEO_DRIVER_PS2GS
   363 extern VideoBootStrap PS2GS_bootstrap;
   364 #endif
   365 #if SDL_VIDEO_DRIVER_PS3
   366 extern VideoBootStrap PS3_bootstrap;
   367 #endif
   368 #if SDL_VIDEO_DRIVER_SVGALIB
   369 extern VideoBootStrap SVGALIB_bootstrap;
   370 #endif
   371 #if SDL_VIDEO_DRIVER_GAPI
   372 extern VideoBootStrap GAPI_bootstrap;
   373 #endif
   374 #if SDL_VIDEO_DRIVER_WIN32
   375 extern VideoBootStrap WIN32_bootstrap;
   376 #endif
   377 #if SDL_VIDEO_DRIVER_BWINDOW
   378 extern VideoBootStrap BWINDOW_bootstrap;
   379 #endif
   380 #if SDL_VIDEO_DRIVER_PHOTON
   381 extern VideoBootStrap photon_bootstrap;
   382 #endif
   383 #if SDL_VIDEO_DRIVER_QNXGF
   384 extern VideoBootStrap qnxgf_bootstrap;
   385 #endif
   386 #if SDL_VIDEO_DRIVER_EPOC
   387 extern VideoBootStrap EPOC_bootstrap;
   388 #endif
   389 #if SDL_VIDEO_DRIVER_RISCOS
   390 extern VideoBootStrap RISCOS_bootstrap;
   391 #endif
   392 #if SDL_VIDEO_DRIVER_UIKIT
   393 extern VideoBootStrap UIKIT_bootstrap;
   394 #endif
   395 #if SDL_VIDEO_DRIVER_DUMMY
   396 extern VideoBootStrap DUMMY_bootstrap;
   397 #endif
   398 #if SDL_VIDEO_DRIVER_NDS
   399 extern VideoBootStrap NDS_bootstrap;
   400 #endif
   401 #if SDL_VIDEO_DRIVER_PANDORA
   402 extern VideoBootStrap PND_bootstrap;
   403 #endif
   404 
   405 #define SDL_CurrentDisplay	(_this->displays[_this->current_display])
   406 #define SDL_CurrentRenderer	(SDL_CurrentDisplay.current_renderer)
   407 
   408 extern SDL_VideoDevice *SDL_GetVideoDevice();
   409 extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
   410 extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
   411 extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
   412 extern int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay * display);
   413 extern int SDL_GetDisplayModeForDisplay(SDL_VideoDisplay * display, int index, SDL_DisplayMode * mode);
   414 extern int SDL_GetDesktopDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   415 extern int SDL_GetCurrentDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   416 extern SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   417 extern int SDL_SetDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode);
   418 extern int SDL_SetPaletteForDisplay(SDL_VideoDisplay * display, const SDL_Color * colors, int firstcolor, int ncolors);
   419 extern int SDL_GetPaletteForDisplay(SDL_VideoDisplay * display, SDL_Color * colors, int firstcolor, int ncolors);
   420 extern int SDL_SetGammaRampForDisplay(SDL_VideoDisplay * display, const Uint16 * red, const Uint16 * green, const Uint16 * blue);
   421 extern int SDL_GetGammaRampForDisplay(SDL_VideoDisplay * display, Uint16 * red, Uint16 * green, Uint16 * blue);
   422 extern void SDL_AddRenderDriver(SDL_VideoDisplay *display, const SDL_RenderDriver * driver);
   423 
   424 extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
   425 extern SDL_Window *SDL_GetWindowFromID(SDL_WindowID windowID);
   426 extern SDL_VideoDisplay *SDL_GetDisplayFromWindow(SDL_Window * window);
   427 
   428 extern void SDL_OnWindowShown(SDL_Window * window);
   429 extern void SDL_OnWindowHidden(SDL_Window * window);
   430 extern void SDL_OnWindowResized(SDL_Window * window);
   431 extern void SDL_OnWindowMinimized(SDL_Window * window);
   432 extern void SDL_OnWindowRestored(SDL_Window * window);
   433 extern void SDL_OnWindowFocusGained(SDL_Window * window);
   434 extern void SDL_OnWindowFocusLost(SDL_Window * window);
   435 extern SDL_WindowID SDL_GetFocusWindow(void);
   436 
   437 #endif /* _SDL_sysvideo_h */
   438 
   439 /* vi: set ts=4 sw=4 expandtab: */