src/video/SDL_sysvideo.h
author Eli Gottlieb <eligottlieb@gmail.com>
Mon, 26 Jul 2010 17:27:04 -0400
changeset 4809 329708ffe2a7
parent 4807 c9eb95f29770
child 4810 7a602fd2121f
permissions -rw-r--r--
Rejiggering the way shaped windows are created as preparation for OS X implementation. Fixed overdrive bug in test program that appears to have been introduced by someone other than myself.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 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 #include "SDL_shape.h"
    30 
    31 /* The SDL video driver */
    32 
    33 typedef struct SDL_Renderer SDL_Renderer;
    34 typedef struct SDL_RenderDriver SDL_RenderDriver;
    35 typedef struct SDL_WindowShaper SDL_WindowShaper;
    36 typedef struct SDL_ShapeDriver SDL_ShapeDriver;
    37 typedef struct SDL_VideoDisplay SDL_VideoDisplay;
    38 typedef struct SDL_VideoDevice SDL_VideoDevice;
    39 
    40 /* Define the SDL texture structure */
    41 struct SDL_Texture
    42 {
    43     const void *magic;
    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 *prev;
    58     SDL_Texture *next;
    59 };
    60 
    61 /* Define the SDL renderer structure */
    62 struct SDL_Renderer
    63 {
    64     int (*ActivateRenderer) (SDL_Renderer * renderer);
    65     int (*DisplayModeChanged) (SDL_Renderer * renderer);
    66     int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
    67     int (*QueryTexturePixels) (SDL_Renderer * renderer, SDL_Texture * texture,
    68                                void **pixels, int *pitch);
    69     int (*SetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
    70                               const SDL_Color * colors, int firstcolor,
    71                               int ncolors);
    72     int (*GetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
    73                               SDL_Color * colors, int firstcolor,
    74                               int ncolors);
    75     int (*SetTextureColorMod) (SDL_Renderer * renderer,
    76                                SDL_Texture * texture);
    77     int (*SetTextureAlphaMod) (SDL_Renderer * renderer,
    78                                SDL_Texture * texture);
    79     int (*SetTextureBlendMode) (SDL_Renderer * renderer,
    80                                 SDL_Texture * texture);
    81     int (*SetTextureScaleMode) (SDL_Renderer * renderer,
    82                                 SDL_Texture * texture);
    83     int (*UpdateTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    84                           const SDL_Rect * rect, const void *pixels,
    85                           int pitch);
    86     int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    87                         const SDL_Rect * rect, int markDirty, void **pixels,
    88                         int *pitch);
    89     void (*UnlockTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
    90     void (*DirtyTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
    91                           int numrects, const SDL_Rect * rects);
    92     int (*SetDrawColor) (SDL_Renderer * renderer);
    93     int (*SetDrawBlendMode) (SDL_Renderer * renderer);
    94     int (*RenderClear) (SDL_Renderer * renderer);
    95     int (*RenderDrawPoints) (SDL_Renderer * renderer, const SDL_Point * points,
    96                              int count);
    97     int (*RenderDrawLines) (SDL_Renderer * renderer, const SDL_Point * points,
    98                             int count);
    99     int (*RenderDrawRects) (SDL_Renderer * renderer, const SDL_Rect ** rects,
   100                             int count);
   101     int (*RenderFillRects) (SDL_Renderer * renderer, const SDL_Rect ** rects,
   102                             int count);
   103     int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
   104                        const SDL_Rect * srcrect, const SDL_Rect * dstrect);
   105     int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
   106                              Uint32 format, void * pixels, int pitch);
   107     int (*RenderWritePixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
   108                               Uint32 format, const void * pixels, int pitch);
   109     void (*RenderPresent) (SDL_Renderer * renderer);
   110     void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
   111 
   112     void (*DestroyRenderer) (SDL_Renderer * renderer);
   113 
   114     /* The current renderer info */
   115     SDL_RendererInfo info;
   116 
   117     /* The window associated with the renderer */
   118     SDL_Window *window;
   119 
   120     /* The list of textures */
   121     SDL_Texture *textures;
   122 
   123     Uint8 r, g, b, a;                   /**< Color for drawing operations values */
   124     int blendMode;                      /**< The drawing blend mode */
   125 
   126     void *driverdata;
   127 };
   128 
   129 /* Define the SDL render driver structure */
   130 struct SDL_RenderDriver
   131 {
   132     SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
   133 
   134     /* Info about the renderer capabilities */
   135     SDL_RendererInfo info;
   136 };
   137 
   138 /* Define the SDL window-shaper structure */
   139 struct SDL_WindowShaper
   140 {   
   141     /* The window associated with the shaper */
   142     SDL_Window *window;
   143     
   144     /* The user's specified SDL_WINDOW_SHOWN flag, for use once the user gives the window a shape. */
   145     Uint32 usershownflag;
   146     
   147     /* The parameters for shape calculation. */
   148     SDL_WindowShapeMode mode;
   149     
   150     /* Has this window been assigned a shape? */
   151     SDL_bool hasshape;
   152     
   153     void *driverdata;
   154 };
   155 
   156 /* Define the SDL shape driver structure */
   157 struct SDL_ShapeDriver
   158 {
   159     SDL_Window *(*CreateShapedWindow)(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
   160     SDL_WindowShaper *(*CreateShaper)(SDL_Window * window);
   161     int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shapeMode);
   162     int (*ResizeWindowShape)(SDL_Window *window);
   163 };
   164 
   165 /* Define the SDL window structure, corresponding to toplevel windows */
   166 struct SDL_Window
   167 {
   168     const void *magic;
   169     Uint32 id;
   170     char *title;
   171     int x, y;
   172     int w, h;
   173     Uint32 flags;
   174 
   175     SDL_VideoDisplay *display;
   176     SDL_Renderer *renderer;
   177 
   178     SDL_DisplayMode fullscreen_mode;
   179     
   180     SDL_WindowShaper *shaper;
   181 
   182     void *userdata;
   183     void *driverdata;
   184 
   185     SDL_Window *prev;
   186     SDL_Window *next;
   187 };
   188 #define FULLSCREEN_VISIBLE(W) \
   189     (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
   190      ((W)->flags & SDL_WINDOW_SHOWN) && \
   191      !((W)->flags & SDL_WINDOW_MINIMIZED))
   192 
   193 /*
   194  * Define the SDL display structure This corresponds to physical monitors
   195  * attached to the system.
   196  */
   197 struct SDL_VideoDisplay
   198 {
   199     int max_display_modes;
   200     int num_display_modes;
   201     SDL_DisplayMode *display_modes;
   202     SDL_DisplayMode desktop_mode;
   203     SDL_DisplayMode current_mode;
   204     SDL_bool updating_fullscreen;
   205     SDL_Palette *palette;
   206 
   207     Uint16 *gamma;
   208     Uint16 *saved_gamma;        /* (just offset into gamma) */
   209 
   210     int num_render_drivers;
   211     SDL_RenderDriver *render_drivers;
   212 
   213     SDL_Window *windows;
   214     SDL_Window *fullscreen_window;
   215 
   216     SDL_Renderer *current_renderer;
   217 
   218     SDL_VideoDevice *device;
   219 
   220     void *driverdata;
   221 };
   222 
   223 /* Define the SDL video driver structure */
   224 #define _THIS	SDL_VideoDevice *_this
   225 
   226 struct SDL_VideoDevice
   227 {
   228     /* * * */
   229     /* The name of this video driver */
   230     const char *name;
   231 
   232     /* * * */
   233     /* Initialization/Query functions */
   234 
   235     /*
   236      * Initialize the native video subsystem, filling in the list of
   237      * displays for this driver, returning 0 or -1 if there's an error.
   238      */
   239     int (*VideoInit) (_THIS);
   240 
   241     /*
   242      * Reverse the effects VideoInit() -- called if VideoInit() fails or
   243      * if the application is shutting down the video subsystem.
   244      */
   245     void (*VideoQuit) (_THIS);
   246 
   247     /* * * */
   248     /*
   249      * Display functions
   250      */
   251 
   252     /*
   253      * Get the bounds of a display
   254      */
   255     int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
   256 
   257     /*
   258      * Get a list of the available display modes. e.g.
   259      * SDL_AddDisplayMode(_this->current_display, mode)
   260      */
   261     void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
   262 
   263     /*
   264      * Setting the display mode is independent of creating windows, so
   265      * when the display mode is changed, all existing windows should have
   266      * their data updated accordingly, including the display surfaces
   267      * associated with them.
   268      */
   269     int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   270 
   271     /* Set the color entries of the display palette */
   272     int (*SetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
   273 
   274     /* Get the color entries of the display palette */
   275     int (*GetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
   276 
   277     /* Set the gamma ramp */
   278     int (*SetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
   279 
   280     /* Get the gamma ramp */
   281     int (*GetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
   282 
   283     /* * * */
   284     /*
   285      * Window functions
   286      */
   287     int (*CreateWindow) (_THIS, SDL_Window * window);
   288     int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
   289     void (*SetWindowTitle) (_THIS, SDL_Window * window);
   290     void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
   291     void (*SetWindowPosition) (_THIS, SDL_Window * window);
   292     void (*SetWindowSize) (_THIS, SDL_Window * window);
   293     void (*ShowWindow) (_THIS, SDL_Window * window);
   294     void (*HideWindow) (_THIS, SDL_Window * window);
   295     void (*RaiseWindow) (_THIS, SDL_Window * window);
   296     void (*MaximizeWindow) (_THIS, SDL_Window * window);
   297     void (*MinimizeWindow) (_THIS, SDL_Window * window);
   298     void (*RestoreWindow) (_THIS, SDL_Window * window);
   299     void (*SetWindowGrab) (_THIS, SDL_Window * window);
   300     void (*DestroyWindow) (_THIS, SDL_Window * window);
   301     
   302     /* * * */
   303     /*
   304      * Shaped-window functions
   305      */
   306     SDL_ShapeDriver shape_driver;
   307 
   308     /* Get some platform dependent window information */
   309       SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
   310                                   struct SDL_SysWMinfo * info);
   311 
   312     /* * * */
   313     /*
   314      * OpenGL support
   315      */
   316     int (*GL_LoadLibrary) (_THIS, const char *path);
   317     void *(*GL_GetProcAddress) (_THIS, const char *proc);
   318     void (*GL_UnloadLibrary) (_THIS);
   319       SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
   320     int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
   321     int (*GL_SetSwapInterval) (_THIS, int interval);
   322     int (*GL_GetSwapInterval) (_THIS);
   323     void (*GL_SwapWindow) (_THIS, SDL_Window * window);
   324     void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
   325 
   326     /* * * */
   327     /*
   328      * Event manager functions
   329      */
   330     void (*PumpEvents) (_THIS);
   331 
   332     /* Suspend the screensaver */
   333     void (*SuspendScreenSaver) (_THIS);
   334 
   335     /* Text input */
   336     void (*StartTextInput) (_THIS);
   337     void (*StopTextInput) (_THIS);
   338     void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
   339 
   340     /* * * */
   341     /* Data common to all drivers */
   342     SDL_bool suspend_screensaver;
   343     int num_displays;
   344     SDL_VideoDisplay *displays;
   345     int current_display;
   346     Uint8 window_magic;
   347     Uint8 texture_magic;
   348     Uint32 next_object_id;
   349 
   350     /* * * */
   351     /* Data used by the GL drivers */
   352     struct
   353     {
   354         int red_size;
   355         int green_size;
   356         int blue_size;
   357         int alpha_size;
   358         int depth_size;
   359         int buffer_size;
   360         int stencil_size;
   361         int double_buffer;
   362         int accum_red_size;
   363         int accum_green_size;
   364         int accum_blue_size;
   365         int accum_alpha_size;
   366         int stereo;
   367         int multisamplebuffers;
   368         int multisamplesamples;
   369         int accelerated;
   370         int major_version;
   371         int minor_version;
   372         int retained_backing;
   373         int driver_loaded;
   374         char driver_path[256];
   375         void *dll_handle;
   376     } gl_config;
   377 
   378     /* * * */
   379     /* Data private to this driver */
   380     void *driverdata;
   381     struct SDL_GLDriverData *gl_data;
   382 
   383 #if SDL_VIDEO_DRIVER_PANDORA
   384     struct SDL_PrivateGLESData *gles_data;
   385 #endif
   386 
   387     /* * * */
   388     /* The function used to dispose of this structure */
   389     void (*free) (_THIS);
   390 };
   391 
   392 typedef struct VideoBootStrap
   393 {
   394     const char *name;
   395     const char *desc;
   396     int (*available) (void);
   397     SDL_VideoDevice *(*create) (int devindex);
   398 } VideoBootStrap;
   399 
   400 #if SDL_VIDEO_DRIVER_COCOA
   401 extern VideoBootStrap COCOA_bootstrap;
   402 #endif
   403 #if SDL_VIDEO_DRIVER_X11
   404 extern VideoBootStrap X11_bootstrap;
   405 #endif
   406 #if SDL_VIDEO_DRIVER_FBCON
   407 extern VideoBootStrap FBCON_bootstrap;
   408 #endif
   409 #if SDL_VIDEO_DRIVER_DIRECTFB
   410 extern VideoBootStrap DirectFB_bootstrap;
   411 #endif
   412 #if SDL_VIDEO_DRIVER_PS3
   413 extern VideoBootStrap PS3_bootstrap;
   414 #endif
   415 #if SDL_VIDEO_DRIVER_SVGALIB
   416 extern VideoBootStrap SVGALIB_bootstrap;
   417 #endif
   418 #if SDL_VIDEO_DRIVER_GAPI
   419 extern VideoBootStrap GAPI_bootstrap;
   420 #endif
   421 #if SDL_VIDEO_DRIVER_WIN32
   422 extern VideoBootStrap WIN32_bootstrap;
   423 #endif
   424 #if SDL_VIDEO_DRIVER_BWINDOW
   425 extern VideoBootStrap BWINDOW_bootstrap;
   426 #endif
   427 #if SDL_VIDEO_DRIVER_PHOTON
   428 extern VideoBootStrap photon_bootstrap;
   429 #endif
   430 #if SDL_VIDEO_DRIVER_QNXGF
   431 extern VideoBootStrap qnxgf_bootstrap;
   432 #endif
   433 #if SDL_VIDEO_DRIVER_EPOC
   434 extern VideoBootStrap EPOC_bootstrap;
   435 #endif
   436 #if SDL_VIDEO_DRIVER_RISCOS
   437 extern VideoBootStrap RISCOS_bootstrap;
   438 #endif
   439 #if SDL_VIDEO_DRIVER_UIKIT
   440 extern VideoBootStrap UIKIT_bootstrap;
   441 #endif
   442 #if SDL_VIDEO_DRIVER_DUMMY
   443 extern VideoBootStrap DUMMY_bootstrap;
   444 #endif
   445 #if SDL_VIDEO_DRIVER_NDS
   446 extern VideoBootStrap NDS_bootstrap;
   447 #endif
   448 #if SDL_VIDEO_DRIVER_PANDORA
   449 extern VideoBootStrap PND_bootstrap;
   450 #endif
   451 
   452 #define SDL_CurrentDisplay	(&_this->displays[_this->current_display])
   453 #define SDL_CurrentRenderer	(SDL_CurrentDisplay->current_renderer)
   454 
   455 extern SDL_VideoDevice *SDL_GetVideoDevice();
   456 extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
   457 extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
   458 extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
   459 extern int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay * display);
   460 extern int SDL_GetDisplayModeForDisplay(SDL_VideoDisplay * display, int index, SDL_DisplayMode * mode);
   461 extern int SDL_GetDesktopDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   462 extern int SDL_GetCurrentDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
   463 extern SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   464 extern int SDL_SetDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode);
   465 extern int SDL_SetPaletteForDisplay(SDL_VideoDisplay * display, const SDL_Color * colors, int firstcolor, int ncolors);
   466 extern int SDL_GetPaletteForDisplay(SDL_VideoDisplay * display, SDL_Color * colors, int firstcolor, int ncolors);
   467 extern int SDL_SetGammaRampForDisplay(SDL_VideoDisplay * display, const Uint16 * red, const Uint16 * green, const Uint16 * blue);
   468 extern int SDL_GetGammaRampForDisplay(SDL_VideoDisplay * display, Uint16 * red, Uint16 * green, Uint16 * blue);
   469 extern void SDL_AddRenderDriver(SDL_VideoDisplay *display, const SDL_RenderDriver * driver);
   470 
   471 extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
   472 
   473 extern void SDL_OnWindowShown(SDL_Window * window);
   474 extern void SDL_OnWindowHidden(SDL_Window * window);
   475 extern void SDL_OnWindowResized(SDL_Window * window);
   476 extern void SDL_OnWindowMinimized(SDL_Window * window);
   477 extern void SDL_OnWindowRestored(SDL_Window * window);
   478 extern void SDL_OnWindowFocusGained(SDL_Window * window);
   479 extern void SDL_OnWindowFocusLost(SDL_Window * window);
   480 extern SDL_Window * SDL_GetFocusWindow(void);
   481 
   482 #endif /* _SDL_sysvideo_h */
   483 
   484 /* vi: set ts=4 sw=4 expandtab: */