src/video/SDL_sysvideo.h
author Holmes Futrell <hfutrell@umail.ucsb.edu>
Thu, 17 Jul 2008 23:45:58 +0000
branchgsoc2008_iphone
changeset 2360 96411dcd2267
parent 2303 d87417504c75
permissions -rw-r--r--
Added declaration of UIKit video bootstrap. Added retained_backing property to glconfig structure.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 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 (*RenderFill) (SDL_Renderer * renderer, Uint8 r, Uint8 g, Uint8 b,
    92                        Uint8 a, const SDL_Rect * rect);
    93     int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
    94                        const SDL_Rect * srcrect, const SDL_Rect * dstrect);
    95     void (*RenderPresent) (SDL_Renderer * renderer);
    96     void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
    97 
    98     void (*DestroyRenderer) (SDL_Renderer * renderer);
    99 
   100     /* The current renderer info */
   101     SDL_RendererInfo info;
   102 
   103     /* The window associated with the renderer */
   104     SDL_WindowID window;
   105 
   106     void *driverdata;
   107 };
   108 
   109 /* Define the SDL render driver structure */
   110 struct SDL_RenderDriver
   111 {
   112     SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
   113 
   114     /* Info about the renderer capabilities */
   115     SDL_RendererInfo info;
   116 };
   117 
   118 /* Define the SDL window structure, corresponding to toplevel windows */
   119 struct SDL_Window
   120 {
   121     Uint32 id;
   122 
   123     char *title;
   124     int x, y;
   125     int w, h;
   126     Uint32 flags;
   127 
   128     int display;
   129     SDL_Renderer *renderer;
   130     SDL_GLContext context;
   131 
   132     void *userdata;
   133     void *driverdata;
   134 };
   135 #define FULLSCREEN_VISIBLE(W) \
   136     (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
   137      ((W)->flags & SDL_WINDOW_SHOWN) && \
   138      !((W)->flags & SDL_WINDOW_MINIMIZED))
   139 
   140 /* Define the SDL display structure
   141    This corresponds to physical monitors attached to the system.
   142  */
   143 struct SDL_VideoDisplay
   144 {
   145     int max_display_modes;
   146     int num_display_modes;
   147     SDL_DisplayMode *display_modes;
   148     SDL_DisplayMode desktop_mode;
   149     SDL_DisplayMode current_mode;
   150     SDL_DisplayMode fullscreen_mode;
   151     SDL_Palette *palette;
   152 
   153     Uint16 *gamma;
   154     Uint16 *saved_gamma;        /* (just offset into gamma) */
   155 
   156     int num_render_drivers;
   157     SDL_RenderDriver *render_drivers;
   158 
   159     int num_windows;
   160     SDL_Window *windows;
   161 
   162     SDL_Renderer *current_renderer;
   163 
   164     /* The hash list of textures */
   165     SDL_Texture *textures[64];
   166 
   167     SDL_VideoDevice *device;
   168 
   169     void *driverdata;
   170 };
   171 
   172 /* Define the SDL video driver structure */
   173 #define _THIS	SDL_VideoDevice *_this
   174 
   175 struct SDL_VideoDevice
   176 {
   177     /* * * */
   178     /* The name of this video driver */
   179     const char *name;
   180 
   181     /* * * */
   182     /* Initialization/Query functions */
   183 
   184     /* Initialize the native video subsystem, filling in the list
   185        of displays for this driver, returning 0 or -1 if there's an error.
   186      */
   187     int (*VideoInit) (_THIS);
   188 
   189     /* Reverse the effects VideoInit() -- called if VideoInit() fails
   190        or if the application is shutting down the video subsystem.
   191      */
   192     void (*VideoQuit) (_THIS);
   193 
   194     /* * * */
   195     /* Display functions
   196      */
   197 
   198     /* Get a list of the available display modes.
   199      * e.g.  SDL_AddDisplayMode(_this->current_display, mode)
   200      */
   201     void (*GetDisplayModes) (_THIS);
   202 
   203     /* Setting the display mode is independent of creating windows,
   204      * so when the display mode is changed, all existing windows
   205      * should have their data updated accordingly, including the
   206      * display surfaces associated with them.
   207      */
   208     int (*SetDisplayMode) (_THIS, SDL_DisplayMode * mode);
   209 
   210     /* Set the color entries of the display palette */
   211     int (*SetDisplayPalette) (_THIS, SDL_Palette * palette);
   212 
   213     /* Get the color entries of the display palette */
   214     int (*GetDisplayPalette) (_THIS, SDL_Palette * palette);
   215 
   216     /* Set the gamma ramp */
   217     int (*SetDisplayGammaRamp) (_THIS, Uint16 * ramp);
   218 
   219     /* Get the gamma ramp */
   220     int (*GetDisplayGammaRamp) (_THIS, Uint16 * ramp);
   221 
   222     /* * * */
   223     /* Window functions
   224      */
   225     int (*CreateWindow) (_THIS, SDL_Window * window);
   226     int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
   227     void (*SetWindowTitle) (_THIS, SDL_Window * window);
   228     void (*SetWindowPosition) (_THIS, SDL_Window * window);
   229     void (*SetWindowSize) (_THIS, SDL_Window * window);
   230     void (*ShowWindow) (_THIS, SDL_Window * window);
   231     void (*HideWindow) (_THIS, SDL_Window * window);
   232     void (*RaiseWindow) (_THIS, SDL_Window * window);
   233     void (*MaximizeWindow) (_THIS, SDL_Window * window);
   234     void (*MinimizeWindow) (_THIS, SDL_Window * window);
   235     void (*RestoreWindow) (_THIS, SDL_Window * window);
   236     void (*SetWindowGrab) (_THIS, SDL_Window * window);
   237     void (*DestroyWindow) (_THIS, SDL_Window * window);
   238 
   239     /* Get some platform dependent window information */
   240       SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
   241                                   struct SDL_SysWMinfo * info);
   242 
   243     /* * * */
   244     /* OpenGL support
   245      */
   246     int (*GL_LoadLibrary) (_THIS, const char *path);
   247     void *(*GL_GetProcAddress) (_THIS, const char *proc);
   248       SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
   249     int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
   250     int (*GL_SetSwapInterval) (_THIS, int interval);
   251     int (*GL_GetSwapInterval) (_THIS);
   252     void (*GL_SwapWindow) (_THIS, SDL_Window * window);
   253     void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
   254 
   255     /* * * */
   256     /* Event manager functions
   257      */
   258     void (*PumpEvents) (_THIS);
   259 
   260     /* * * */
   261     /* Data common to all drivers */
   262     int num_displays;
   263     SDL_VideoDisplay *displays;
   264     int current_display;
   265     Uint32 next_object_id;
   266 
   267     /* * * */
   268     /* Data used by the GL drivers */
   269     struct
   270     {
   271         int red_size;
   272         int green_size;
   273         int blue_size;
   274         int alpha_size;
   275         int depth_size;
   276         int buffer_size;
   277         int stencil_size;
   278         int double_buffer;
   279         int accum_red_size;
   280         int accum_green_size;
   281         int accum_blue_size;
   282         int accum_alpha_size;
   283         int stereo;
   284         int multisamplebuffers;
   285         int multisamplesamples;
   286         int accelerated;
   287 		int retained_backing;
   288         int driver_loaded;
   289         char driver_path[256];
   290         void *dll_handle;
   291     } gl_config;
   292 
   293     /* * * */
   294     /* Data private to this driver */
   295     void *driverdata;
   296     struct SDL_GLDriverData *gl_data;
   297 
   298     /* * * */
   299     /* The function used to dispose of this structure */
   300     void (*free) (_THIS);
   301 };
   302 
   303 typedef struct VideoBootStrap
   304 {
   305     const char *name;
   306     const char *desc;
   307     int (*available) (void);
   308     SDL_VideoDevice *(*create) (int devindex);
   309 } VideoBootStrap;
   310 
   311 #if SDL_VIDEO_DRIVER_COCOA
   312 extern VideoBootStrap COCOA_bootstrap;
   313 #endif
   314 #if SDL_VIDEO_DRIVER_X11
   315 extern VideoBootStrap X11_bootstrap;
   316 #endif
   317 #if SDL_VIDEO_DRIVER_NANOX
   318 extern VideoBootStrap NX_bootstrap;
   319 #endif
   320 #if SDL_VIDEO_DRIVER_IPOD
   321 extern VideoBootStrap iPod_bootstrap;
   322 #endif
   323 #if SDL_VIDEO_DRIVER_WSCONS
   324 extern VideoBootStrap WSCONS_bootstrap;
   325 #endif
   326 #if SDL_VIDEO_DRIVER_FBCON
   327 extern VideoBootStrap FBCON_bootstrap;
   328 #endif
   329 #if SDL_VIDEO_DRIVER_DIRECTFB
   330 extern VideoBootStrap DirectFB_bootstrap;
   331 #endif
   332 #if SDL_VIDEO_DRIVER_PS2GS
   333 extern VideoBootStrap PS2GS_bootstrap;
   334 #endif
   335 #if SDL_VIDEO_DRIVER_VGL
   336 extern VideoBootStrap VGL_bootstrap;
   337 #endif
   338 #if SDL_VIDEO_DRIVER_SVGALIB
   339 extern VideoBootStrap SVGALIB_bootstrap;
   340 #endif
   341 #if SDL_VIDEO_DRIVER_GAPI
   342 extern VideoBootStrap GAPI_bootstrap;
   343 #endif
   344 #if SDL_VIDEO_DRIVER_WIN32
   345 extern VideoBootStrap WIN32_bootstrap;
   346 #endif
   347 #if SDL_VIDEO_DRIVER_BWINDOW
   348 extern VideoBootStrap BWINDOW_bootstrap;
   349 #endif
   350 #if SDL_VIDEO_DRIVER_PHOTON
   351 extern VideoBootStrap ph_bootstrap;
   352 #endif
   353 #if SDL_VIDEO_DRIVER_EPOC
   354 extern VideoBootStrap EPOC_bootstrap;
   355 #endif
   356 #if SDL_VIDEO_DRIVER_XBIOS
   357 extern VideoBootStrap XBIOS_bootstrap;
   358 #endif
   359 #if SDL_VIDEO_DRIVER_GEM
   360 extern VideoBootStrap GEM_bootstrap;
   361 #endif
   362 #if SDL_VIDEO_DRIVER_DC
   363 extern VideoBootStrap DC_bootstrap;
   364 #endif
   365 #if SDL_VIDEO_DRIVER_RISCOS
   366 extern VideoBootStrap RISCOS_bootstrap;
   367 #endif
   368 #if SDL_VIDEO_DRIVER_OS2FS
   369 extern VideoBootStrap OS2FSLib_bootstrap;
   370 #endif
   371 #if SDL_VIDEO_DRIVER_UIKIT
   372 extern VideoBootStrap UIKIT_bootstrap;
   373 #endif
   374 #if SDL_VIDEO_DRIVER_DUMMY
   375 extern VideoBootStrap DUMMY_bootstrap;
   376 #endif
   377 
   378 #define SDL_CurrentDisplay	(_this->displays[_this->current_display])
   379 
   380 extern SDL_VideoDevice *SDL_GetVideoDevice();
   381 extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
   382 extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
   383 extern SDL_bool SDL_AddDisplayMode(int displayIndex,
   384                                    const SDL_DisplayMode * mode);
   385 extern void SDL_AddRenderDriver(int displayIndex,
   386                                 const SDL_RenderDriver * driver);
   387 
   388 extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
   389 extern SDL_Window *SDL_GetWindowFromID(SDL_WindowID windowID);
   390 extern SDL_VideoDisplay *SDL_GetDisplayFromWindow(SDL_Window * window);
   391 
   392 extern void SDL_OnWindowShown(SDL_Window * window);
   393 extern void SDL_OnWindowHidden(SDL_Window * window);
   394 extern void SDL_OnWindowResized(SDL_Window * window);
   395 extern void SDL_OnWindowFocusGained(SDL_Window * window);
   396 extern void SDL_OnWindowFocusLost(SDL_Window * window);
   397 extern SDL_WindowID SDL_GetFocusWindow(void);
   398 
   399 #endif /* _SDL_sysvideo_h */
   400 
   401 /* vi: set ts=4 sw=4 expandtab: */