src/video/SDL_sysvideo.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 09 Nov 2009 05:20:11 +0000
changeset 3427 36cf454ba065
parent 3417 64a60c5d502e
child 3435 9f62f47d989b
permissions -rw-r--r--
Work in progress on implementation of SDL_RenderReadPixels() and SDL_RenderWritePixels(), code untested.
     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                              void * pixels, int pitch);
   101     int (*RenderWritePixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
   102                               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     void *userdata;
   143     void *driverdata;
   144 };
   145 #define FULLSCREEN_VISIBLE(W) \
   146     (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
   147      ((W)->flags & SDL_WINDOW_SHOWN) && \
   148      !((W)->flags & SDL_WINDOW_MINIMIZED))
   149 
   150 /*
   151  * Define the SDL display structure This corresponds to physical monitors
   152  * attached to the system.
   153  */
   154 struct SDL_VideoDisplay
   155 {
   156     int max_display_modes;
   157     int num_display_modes;
   158     SDL_DisplayMode *display_modes;
   159     SDL_DisplayMode desktop_mode;
   160     SDL_DisplayMode current_mode;
   161     SDL_DisplayMode fullscreen_mode;
   162     SDL_Palette *palette;
   163 
   164     Uint16 *gamma;
   165     Uint16 *saved_gamma;        /* (just offset into gamma) */
   166 
   167     int num_render_drivers;
   168     SDL_RenderDriver *render_drivers;
   169 
   170     int num_windows;
   171     SDL_Window *windows;
   172 
   173     SDL_Renderer *current_renderer;
   174 
   175     /* The hash list of textures */
   176     SDL_Texture *textures[64];
   177 
   178     SDL_VideoDevice *device;
   179 
   180     void *driverdata;
   181 };
   182 
   183 /* Define the SDL video driver structure */
   184 #define _THIS	SDL_VideoDevice *_this
   185 
   186 struct SDL_VideoDevice
   187 {
   188     /* * * */
   189     /* The name of this video driver */
   190     const char *name;
   191 
   192     /* * * */
   193     /* Initialization/Query functions */
   194 
   195     /*
   196      * Initialize the native video subsystem, filling in the list of
   197      * displays for this driver, returning 0 or -1 if there's an error.
   198      */
   199     int (*VideoInit) (_THIS);
   200 
   201     /*
   202      * Reverse the effects VideoInit() -- called if VideoInit() fails or
   203      * if the application is shutting down the video subsystem.
   204      */
   205     void (*VideoQuit) (_THIS);
   206 
   207     /* * * */
   208     /*
   209      * Display functions
   210      */
   211 
   212     /*
   213      * Get a list of the available display modes. e.g.
   214      * SDL_AddDisplayMode(_this->current_display, mode)
   215      */
   216     void (*GetDisplayModes) (_THIS);
   217 
   218     /*
   219      * Setting the display mode is independent of creating windows, so
   220      * when the display mode is changed, all existing windows should have
   221      * their data updated accordingly, including the display surfaces
   222      * associated with them.
   223      */
   224     int (*SetDisplayMode) (_THIS, SDL_DisplayMode * mode);
   225 
   226     /* Set the color entries of the display palette */
   227     int (*SetDisplayPalette) (_THIS, SDL_Palette * palette);
   228 
   229     /* Get the color entries of the display palette */
   230     int (*GetDisplayPalette) (_THIS, SDL_Palette * palette);
   231 
   232     /* Set the gamma ramp */
   233     int (*SetDisplayGammaRamp) (_THIS, Uint16 * ramp);
   234 
   235     /* Get the gamma ramp */
   236     int (*GetDisplayGammaRamp) (_THIS, Uint16 * ramp);
   237 
   238     /* * * */
   239     /*
   240      * Window functions
   241      */
   242     int (*CreateWindow) (_THIS, SDL_Window * window);
   243     int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
   244     void (*SetWindowTitle) (_THIS, SDL_Window * window);
   245     void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
   246     void (*SetWindowPosition) (_THIS, SDL_Window * window);
   247     void (*SetWindowSize) (_THIS, SDL_Window * window);
   248     void (*ShowWindow) (_THIS, SDL_Window * window);
   249     void (*HideWindow) (_THIS, SDL_Window * window);
   250     void (*RaiseWindow) (_THIS, SDL_Window * window);
   251     void (*MaximizeWindow) (_THIS, SDL_Window * window);
   252     void (*MinimizeWindow) (_THIS, SDL_Window * window);
   253     void (*RestoreWindow) (_THIS, SDL_Window * window);
   254     void (*SetWindowGrab) (_THIS, SDL_Window * window);
   255     void (*DestroyWindow) (_THIS, SDL_Window * window);
   256 
   257     /* Get some platform dependent window information */
   258       SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
   259                                   struct SDL_SysWMinfo * info);
   260 
   261     /* * * */
   262     /*
   263      * OpenGL support
   264      */
   265     int (*GL_LoadLibrary) (_THIS, const char *path);
   266     void *(*GL_GetProcAddress) (_THIS, const char *proc);
   267     void (*GL_UnloadLibrary) (_THIS);
   268       SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
   269     int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
   270     int (*GL_SetSwapInterval) (_THIS, int interval);
   271     int (*GL_GetSwapInterval) (_THIS);
   272     void (*GL_SwapWindow) (_THIS, SDL_Window * window);
   273     void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
   274 
   275     /* * * */
   276     /*
   277      * Event manager functions
   278      */
   279     void (*PumpEvents) (_THIS);
   280 
   281     /* Suspend the screensaver */
   282     void (*SuspendScreenSaver) (_THIS);
   283 
   284     /* Text input */
   285     void (*StartTextInput) (_THIS);
   286     void (*StopTextInput) (_THIS);
   287     void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
   288 
   289     /* * * */
   290     /* Data common to all drivers */
   291     SDL_bool suspend_screensaver;
   292     int num_displays;
   293     SDL_VideoDisplay *displays;
   294     int current_display;
   295     Uint32 next_object_id;
   296 
   297     /* * * */
   298     /* Data used by the GL drivers */
   299     struct
   300     {
   301         int red_size;
   302         int green_size;
   303         int blue_size;
   304         int alpha_size;
   305         int depth_size;
   306         int buffer_size;
   307         int stencil_size;
   308         int double_buffer;
   309         int accum_red_size;
   310         int accum_green_size;
   311         int accum_blue_size;
   312         int accum_alpha_size;
   313         int stereo;
   314         int multisamplebuffers;
   315         int multisamplesamples;
   316         int accelerated;
   317         int major_version;
   318         int minor_version;
   319         int retained_backing;
   320         int driver_loaded;
   321         char driver_path[256];
   322         void *dll_handle;
   323     } gl_config;
   324 
   325     /* * * */
   326     /* Data private to this driver */
   327     void *driverdata;
   328     struct SDL_GLDriverData *gl_data;
   329 
   330 #if SDL_VIDEO_DRIVER_PANDORA
   331     struct SDL_PrivateGLESData *gles_data;
   332 #endif
   333 
   334     /* * * */
   335     /* The function used to dispose of this structure */
   336     void (*free) (_THIS);
   337 };
   338 
   339 typedef struct VideoBootStrap
   340 {
   341     const char *name;
   342     const char *desc;
   343     int (*available) (void);
   344     SDL_VideoDevice *(*create) (int devindex);
   345 } VideoBootStrap;
   346 
   347 #if SDL_VIDEO_DRIVER_COCOA
   348 extern VideoBootStrap COCOA_bootstrap;
   349 #endif
   350 #if SDL_VIDEO_DRIVER_X11
   351 extern VideoBootStrap X11_bootstrap;
   352 #endif
   353 #if SDL_VIDEO_DRIVER_FBCON
   354 extern VideoBootStrap FBCON_bootstrap;
   355 #endif
   356 #if SDL_VIDEO_DRIVER_DIRECTFB
   357 extern VideoBootStrap DirectFB_bootstrap;
   358 #endif
   359 #if SDL_VIDEO_DRIVER_PS2GS
   360 extern VideoBootStrap PS2GS_bootstrap;
   361 #endif
   362 #if SDL_VIDEO_DRIVER_PS3
   363 extern VideoBootStrap PS3_bootstrap;
   364 #endif
   365 #if SDL_VIDEO_DRIVER_SVGALIB
   366 extern VideoBootStrap SVGALIB_bootstrap;
   367 #endif
   368 #if SDL_VIDEO_DRIVER_GAPI
   369 extern VideoBootStrap GAPI_bootstrap;
   370 #endif
   371 #if SDL_VIDEO_DRIVER_WIN32
   372 extern VideoBootStrap WIN32_bootstrap;
   373 #endif
   374 #if SDL_VIDEO_DRIVER_BWINDOW
   375 extern VideoBootStrap BWINDOW_bootstrap;
   376 #endif
   377 #if SDL_VIDEO_DRIVER_PHOTON
   378 extern VideoBootStrap photon_bootstrap;
   379 #endif
   380 #if SDL_VIDEO_DRIVER_QNXGF
   381 extern VideoBootStrap qnxgf_bootstrap;
   382 #endif
   383 #if SDL_VIDEO_DRIVER_EPOC
   384 extern VideoBootStrap EPOC_bootstrap;
   385 #endif
   386 #if SDL_VIDEO_DRIVER_RISCOS
   387 extern VideoBootStrap RISCOS_bootstrap;
   388 #endif
   389 #if SDL_VIDEO_DRIVER_UIKIT
   390 extern VideoBootStrap UIKIT_bootstrap;
   391 #endif
   392 #if SDL_VIDEO_DRIVER_DUMMY
   393 extern VideoBootStrap DUMMY_bootstrap;
   394 #endif
   395 #if SDL_VIDEO_DRIVER_NDS
   396 extern VideoBootStrap NDS_bootstrap;
   397 #endif
   398 #if SDL_VIDEO_DRIVER_PANDORA
   399 extern VideoBootStrap PND_bootstrap;
   400 #endif
   401 
   402 #define SDL_CurrentDisplay	(_this->displays[_this->current_display])
   403 #define SDL_CurrentRenderer	(SDL_CurrentDisplay.current_renderer)
   404 
   405 extern SDL_VideoDevice *SDL_GetVideoDevice();
   406 extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
   407 extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
   408 extern SDL_bool
   409 SDL_AddDisplayMode(int displayIndex, const SDL_DisplayMode * mode);
   410 extern void
   411 SDL_AddRenderDriver(int displayIndex, const SDL_RenderDriver * driver);
   412 
   413 extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
   414 extern SDL_Window *SDL_GetWindowFromID(SDL_WindowID windowID);
   415 extern SDL_VideoDisplay *SDL_GetDisplayFromWindow(SDL_Window * window);
   416 
   417 extern void SDL_OnWindowShown(SDL_Window * window);
   418 extern void SDL_OnWindowHidden(SDL_Window * window);
   419 extern void SDL_OnWindowResized(SDL_Window * window);
   420 extern void SDL_OnWindowFocusGained(SDL_Window * window);
   421 extern void SDL_OnWindowFocusLost(SDL_Window * window);
   422 extern SDL_WindowID SDL_GetFocusWindow(void);
   423 
   424 #endif /* _SDL_sysvideo_h */
   425 
   426 /* vi: set ts=4 sw=4 expandtab: */