author Sam Lantinga <>
Mon, 29 May 2006 05:08:33 +0000
changeset 1669 9857d21967bb
parent 1668 4da1ee79c9af
child 1670 eef792d31de8
permissions -rw-r--r--
The test programs compile again. The dummy video driver is partially functional now.

    SDL - Simple DirectMedia Layer
    Copyright (C) 1997-2006 Sam Lantinga

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga
#include "SDL_config.h"

#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h

#include "SDL_mouse.h"
#include "SDL_syswm.h"

/* This file prototypes the video driver implementation.
   This is designed to be easily converted to C++ in the future.

#include "SDL_opengl.h"
#endif /* SDL_VIDEO_OPENGL */

/* The SDL video driver */

/* Define the SDL window structure, corresponding to toplevel windows */
typedef struct SDL_Window SDL_Window;

struct SDL_Window
    Uint32 id;

    char *title;
    int x, y;
    int w, h;
    Uint32 flags;

    SDL_Surface *surface;
    SDL_Surface *shadow;
    Uint16 *gamma;

    void *userdata;
    void *driverdata;

/* Define the SDL display structure
   This corresponds to physical monitors attached to the system.
typedef struct SDL_VideoDisplay
    int num_display_modes;
    SDL_DisplayMode *display_modes;
    SDL_DisplayMode desktop_mode;
    SDL_DisplayMode current_mode;

    int max_windows;
    int num_windows;
    SDL_Window *windows;

    void *driverdata;
} SDL_VideoDisplay;

typedef struct SDL_VideoDevice SDL_VideoDevice;

/* Define the SDL video driver structure */
#define _THIS	SDL_VideoDevice *_this

struct SDL_VideoDevice
    /* * * */
    /* The name of this video driver */
    const char *name;

    /* * * */
    /* Initialization/Query functions */

    /* Initialize the native video subsystem, filling in the list
       of displays for this driver, returning 0 or -1 if there's an error.
    int (*VideoInit) (_THIS);

    /* * * */
    /* Display functions
    /* Setting the display mode is independent of creating windows,
     * so when the display mode is changed, all existing windows
     * should have their data updated accordingly, including the
     * display surfaces associated with them.
    int (*SetDisplayMode) (_THIS, const SDL_DisplayMode * mode);

    /* * * */
    /* Window functions
    int (*CreateWindow) (_THIS, SDL_Window * window);
    int (*CreateWindowFrom) (_THIS, SDL_Window * window, void *data);
    void (*SetWindowTitle) (_THIS, SDL_Window * window);
    void (*SetWindowPosition) (_THIS, SDL_Window * window);
    void (*SetWindowSize) (_THIS, SDL_Window * window);
    void (*ShowWindow) (_THIS, SDL_Window * window);
    void (*HideWindow) (_THIS, SDL_Window * window);
    void (*RaiseWindow) (_THIS, SDL_Window * window);
    void (*MaximizeWindow) (_THIS, SDL_Window * window);
    void (*MinimizeWindow) (_THIS, SDL_Window * window);
    void (*RestoreWindow) (_THIS, SDL_Window * window);
    void (*SetWindowGrab) (_THIS, SDL_Window * window);
    void (*DestroyWindow) (_THIS, SDL_Window * window);

    void (*CreateWindowSurface) (_THIS, SDL_Window * window, Uint32 flags);
    void (*UpdateWindowSurface) (_THIS, SDL_Window * window, int numrects,
                                 SDL_Rect * rects);
    void (*FlipWindowSurface) (_THIS, SDL_Window * window);

    /* Sets the color entries { firstcolor .. (firstcolor+ncolors-1) }
       of the physical palette to those in 'colors'. If the device is
       using a software palette (SDL_HWPALETTE not set), then the
       changes are reflected in the logical palette of the screen
       as well.
       The return value is 1 if all entries could be set properly
       or 0 otherwise.
    int (*SetWindowColors) (_THIS, SDL_Window * window,
                            int firstcolor, int ncolors, SDL_Color * colors);

    /* Get some platform dependent window information */
      SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
                                  SDL_SysWMinfo * info);

    /* Create a YUV video surface (possibly overlay) of the given
       format.  The hardware should be able to perform at least 2x
       scaling on display.
    SDL_Overlay *(*CreateYUVOverlay) (_THIS, int width, int height,
                                      Uint32 format, SDL_Surface * display);

    /* Reverse the effects VideoInit() -- called if VideoInit() fails
       or if the application is shutting down the video subsystem.
    void (*VideoQuit) (_THIS);

    /* * * */
    /* Hardware acceleration functions */

    /* Information about the video hardware */
    SDL_VideoInfo info;

    /* The pixel format used when SDL_CreateRGBSurface creates SDL_HWSURFACEs with alpha */
    SDL_PixelFormat *displayformatalphapixel;

    /* Allocates a surface in video memory */
    int (*AllocHWSurface) (_THIS, SDL_Surface * surface);

    /* Sets the hardware accelerated blit function, if any, based
       on the current flags of the surface (colorkey, alpha, etc.)
    int (*CheckHWBlit) (_THIS, SDL_Surface * src, SDL_Surface * dst);

    /* Fills a surface rectangle with the given color */
    int (*FillHWRect) (_THIS, SDL_Surface * dst, SDL_Rect * rect,
                       Uint32 color);

    /* Sets video mem colorkey and accelerated blit function */
    int (*SetHWColorKey) (_THIS, SDL_Surface * surface, Uint32 key);

    /* Sets per surface hardware alpha value */
    int (*SetHWAlpha) (_THIS, SDL_Surface * surface, Uint8 value);

    /* Returns a readable/writable surface */
    int (*LockHWSurface) (_THIS, SDL_Surface * surface);
    void (*UnlockHWSurface) (_THIS, SDL_Surface * surface);

    /* Frees a previously allocated video surface */
    void (*FreeHWSurface) (_THIS, SDL_Surface * surface);

    /* * * */
    /* Gamma support */

    /* Set the gamma correction directly (emulated with gamma ramps) */
    int (*SetGamma) (_THIS, float red, float green, float blue);

    /* Get the gamma correction directly (emulated with gamma ramps) */
    int (*GetGamma) (_THIS, float *red, float *green, float *blue);

    /* Set the gamma ramp */
    int (*SetGammaRamp) (_THIS, Uint16 * ramp);

    /* Get the gamma ramp */
    int (*GetGammaRamp) (_THIS, Uint16 * ramp);

    /* * * */
    /* OpenGL support */

    /* Sets the dll to use for OpenGL and loads it */
    int (*GL_LoadLibrary) (_THIS, const char *path);

    /* Retrieves the address of a function in the gl library */
    void *(*GL_GetProcAddress) (_THIS, const char *proc);

    /* Get attribute information from the windowing system. */
    int (*GL_GetAttribute) (_THIS, SDL_GLattr attrib, int *value);

    /* Make the context associated with this driver current */
    int (*GL_MakeCurrent) (_THIS);

    /* Swap the current buffers in double buffer mode. */
    void (*GL_SwapBuffers) (_THIS);

    /* OpenGL functions for glSDL */
#if !defined(__WIN32__)
#define WINAPI
#define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
#include "SDL_glfuncs.h"
#undef SDL_PROC

    /* Texture id */
    GLuint texture;

    int is_32bit;

    /* * * */
    /* Cursor manager functions */

    /* Free a window manager cursor
       This function can be NULL if CreateWMCursor is also NULL.
    void (*FreeWMCursor) (_THIS, WMcursor * cursor);

    /* If not NULL, create a black/white window manager cursor */
    WMcursor *(*CreateWMCursor) (_THIS,
                                 Uint8 * data, Uint8 * mask, int w, int h,
                                 int hot_x, int hot_y);

    /* Show the specified cursor, or hide if cursor is NULL */
    int (*ShowWMCursor) (_THIS, WMcursor * cursor);

    /* Warp the window manager cursor to (x,y)
       If NULL, a mouse motion event is posted internally.
    void (*WarpWMCursor) (_THIS, Uint16 x, Uint16 y);

    /* If not NULL, this is called when a mouse motion event occurs */
    void (*MoveWMCursor) (_THIS, int x, int y);

    /* Determine whether the mouse should be in relative mode or not.
       This function is called when the input grab state or cursor
       visibility state changes.
       If the cursor is not visible, and the input is grabbed, the
       driver can place the mouse in relative mode, which may result
       in higher accuracy sampling of the pointer motion.
    void (*CheckMouseMode) (_THIS);

    /* * * */
    /* Event manager functions */

    /* Initialize keyboard mapping for this driver */
    void (*InitOSKeymap) (_THIS);

    /* Handle any queued OS events */
    void (*PumpEvents) (_THIS);

    /* * * */
    /* Data common to all drivers */
    int num_displays;
    SDL_VideoDisplay *displays;
    int current_display;
    Uint32 next_window_id;

    /* Driver information flags */

    /* * * */
    /* Data used by the GL drivers */
        int red_size;
        int green_size;
        int blue_size;
        int alpha_size;
        int depth_size;
        int buffer_size;
        int stencil_size;
        int double_buffer;
        int accum_red_size;
        int accum_green_size;
        int accum_blue_size;
        int accum_alpha_size;
        int stereo;
        int multisamplebuffers;
        int multisamplesamples;
        int accelerated;
        int swap_control;
        int driver_loaded;
        char driver_path[256];
        void *dll_handle;
    } gl_config;

    /* * * */
    /* Data private to this driver */
    struct SDL_PrivateVideoData *hidden;
    struct SDL_PrivateGLData *gl_data;

    /* * * */
    /* The function used to dispose of this structure */
    void (*free) (_THIS);
#undef _THIS

typedef struct VideoBootStrap
    const char *name;
    const char *desc;
    int (*available) (void);
    SDL_VideoDevice *(*create) (int devindex);
} VideoBootStrap;

extern VideoBootStrap QZ_bootstrap;
extern VideoBootStrap X11_bootstrap;
extern VideoBootStrap DGA_bootstrap;
extern VideoBootStrap NX_bootstrap;
extern VideoBootStrap iPod_bootstrap;
extern VideoBootStrap Qtopia_bootstrap;
extern VideoBootStrap WSCONS_bootstrap;
extern VideoBootStrap FBCON_bootstrap;
extern VideoBootStrap DirectFB_bootstrap;
extern VideoBootStrap PS2GS_bootstrap;
extern VideoBootStrap GGI_bootstrap;
extern VideoBootStrap VGL_bootstrap;
extern VideoBootStrap SVGALIB_bootstrap;
extern VideoBootStrap GAPI_bootstrap;
extern VideoBootStrap WINDIB_bootstrap;
extern VideoBootStrap DIRECTX_bootstrap;
extern VideoBootStrap BWINDOW_bootstrap;
extern VideoBootStrap TOOLBOX_bootstrap;
extern VideoBootStrap DSp_bootstrap;
extern VideoBootStrap CGX_bootstrap;
extern VideoBootStrap ph_bootstrap;
extern VideoBootStrap EPOC_bootstrap;
extern VideoBootStrap XBIOS_bootstrap;
extern VideoBootStrap GEM_bootstrap;
extern VideoBootStrap PG_bootstrap;
extern VideoBootStrap DC_bootstrap;
extern VideoBootStrap RISCOS_bootstrap;
extern VideoBootStrap OS2FSLib_bootstrap;
extern VideoBootStrap AALIB_bootstrap;
extern VideoBootStrap DUMMY_bootstrap;
extern VideoBootStrap glSDL_bootstrap;

#define SDL_CurrentDisplay	(_this->displays[_this->current_display])
#define SDL_CurrentWindow	([0])
#define SDL_VideoSurface	((_this && SDL_CurrentDisplay.num_windows > 0) ? SDL_CurrentWindow.surface : NULL)
#define SDL_ShadowSurface	((_this && SDL_CurrentDisplay.num_windows > 0) ? SDL_CurrentWindow.shadow : NULL)
#define SDL_PublicSurface	(SDL_ShadowSurface ? SDL_ShadowSurface : SDL_VideoSurface)

extern SDL_VideoDevice *SDL_GetVideoDevice();
extern void SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern void SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
extern void SDL_AddDisplayMode(int display, const SDL_DisplayMode * mode);
extern SDL_Window *SDL_GetWindowFromSurface(SDL_Surface * surface);

#endif /* _SDL_sysvideo_h */

/* vi: set ts=4 sw=4 expandtab: */