2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997-2009 Sam Lantinga
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.
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.
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
22 #include "SDL_config.h"
24 #ifndef _SDL_sysvideo_h
25 #define _SDL_sysvideo_h
27 #include "SDL_mouse.h"
28 #define SDL_PROTOTYPES_ONLY
29 #include "SDL_syswm.h"
30 #undef SDL_PROTOTYPES_ONLY
32 /* This file prototypes the video driver implementation.
33 This is designed to be easily converted to C++ in the future.
37 #include "SDL_opengl.h"
38 #endif /* SDL_VIDEO_OPENGL */
40 /* The SDL video driver */
41 typedef struct SDL_VideoDevice SDL_VideoDevice;
43 /* Define the SDL video driver structure */
44 #define _THIS SDL_VideoDevice *_this
46 #define _STATUS SDL_status *status
48 struct SDL_VideoDevice {
50 /* The name of this video driver */
54 /* Initialization/Query functions */
56 /* Initialize the native video subsystem, filling 'vformat' with the
57 "best" display pixel format, returning 0 or -1 if there's an error.
59 int (*VideoInit)(_THIS, SDL_PixelFormat *vformat);
61 /* List the available video modes for the given pixel format, sorted
62 from largest to smallest.
64 SDL_Rect **(*ListModes)(_THIS, SDL_PixelFormat *format, Uint32 flags);
66 /* Set the requested video mode, returning a surface which will be
67 set to the SDL_VideoSurface. The width and height will already
68 be verified by ListModes(), and the video subsystem is free to
69 set the mode to a supported bit depth different from the one
70 specified -- the desired bpp will be emulated with a shadow
71 surface if necessary. If a new mode is returned, this function
72 should take care of cleaning up the current mode.
74 SDL_Surface *(*SetVideoMode)(_THIS, SDL_Surface *current,
75 int width, int height, int bpp, Uint32 flags);
77 /* Toggle the fullscreen mode */
78 int (*ToggleFullScreen)(_THIS, int on);
80 /* This is called after the video mode has been set, to get the
81 initial mouse state. It should queue events as necessary to
82 properly represent the current mouse focus and position.
84 void (*UpdateMouse)(_THIS);
86 /* Create a YUV video surface (possibly overlay) of the given
87 format. The hardware should be able to perform at least 2x
90 SDL_Overlay *(*CreateYUVOverlay)(_THIS, int width, int height,
91 Uint32 format, SDL_Surface *display);
93 /* Sets the color entries { firstcolor .. (firstcolor+ncolors-1) }
94 of the physical palette to those in 'colors'. If the device is
95 using a software palette (SDL_HWPALETTE not set), then the
96 changes are reflected in the logical palette of the screen
98 The return value is 1 if all entries could be set properly
101 int (*SetColors)(_THIS, int firstcolor, int ncolors,
104 /* This pointer should exist in the native video subsystem and should
105 point to an appropriate update function for the current video mode
107 void (*UpdateRects)(_THIS, int numrects, SDL_Rect *rects);
109 /* Reverse the effects VideoInit() -- called if VideoInit() fails
110 or if the application is shutting down the video subsystem.
112 void (*VideoQuit)(_THIS);
115 /* Hardware acceleration functions */
117 /* Information about the video hardware */
120 /* The pixel format used when SDL_CreateRGBSurface creates SDL_HWSURFACEs with alpha */
121 SDL_PixelFormat* displayformatalphapixel;
123 /* Allocates a surface in video memory */
124 int (*AllocHWSurface)(_THIS, SDL_Surface *surface);
126 /* Sets the hardware accelerated blit function, if any, based
127 on the current flags of the surface (colorkey, alpha, etc.)
129 int (*CheckHWBlit)(_THIS, SDL_Surface *src, SDL_Surface *dst);
131 /* Fills a surface rectangle with the given color */
132 int (*FillHWRect)(_THIS, SDL_Surface *dst, SDL_Rect *rect, Uint32 color);
134 /* Sets video mem colorkey and accelerated blit function */
135 int (*SetHWColorKey)(_THIS, SDL_Surface *surface, Uint32 key);
137 /* Sets per surface hardware alpha value */
138 int (*SetHWAlpha)(_THIS, SDL_Surface *surface, Uint8 value);
140 /* Returns a readable/writable surface */
141 int (*LockHWSurface)(_THIS, SDL_Surface *surface);
142 void (*UnlockHWSurface)(_THIS, SDL_Surface *surface);
144 /* Performs hardware flipping */
145 int (*FlipHWSurface)(_THIS, SDL_Surface *surface);
147 /* Frees a previously allocated video surface */
148 void (*FreeHWSurface)(_THIS, SDL_Surface *surface);
155 /* Set the gamma correction directly (emulated with gamma ramps) */
156 int (*SetGamma)(_THIS, float red, float green, float blue);
158 /* Get the gamma correction directly (emulated with gamma ramps) */
159 int (*GetGamma)(_THIS, float *red, float *green, float *blue);
161 /* Set the gamma ramp */
162 int (*SetGammaRamp)(_THIS, Uint16 *ramp);
164 /* Get the gamma ramp */
165 int (*GetGammaRamp)(_THIS, Uint16 *ramp);
170 /* Sets the dll to use for OpenGL and loads it */
171 int (*GL_LoadLibrary)(_THIS, const char *path);
173 /* Retrieves the address of a function in the gl library */
174 void* (*GL_GetProcAddress)(_THIS, const char *proc);
176 /* Get attribute information from the windowing system. */
177 int (*GL_GetAttribute)(_THIS, SDL_GLattr attrib, int* value);
179 /* Make the context associated with this driver current */
180 int (*GL_MakeCurrent)(_THIS);
182 /* Swap the current buffers in double buffer mode. */
183 void (*GL_SwapBuffers)(_THIS);
185 /* OpenGL functions for SDL_OPENGLBLIT */
187 #if !defined(__WIN32__)
190 #define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
191 #include "SDL_glfuncs.h"
200 /* Window manager functions */
202 /* Set the title and icon text */
203 void (*SetCaption)(_THIS, const char *title, const char *icon);
205 /* Set the window icon image */
206 void (*SetIcon)(_THIS, SDL_Surface *icon, Uint8 *mask);
208 /* Iconify the window.
209 This function returns 1 if there is a window manager and the
210 window was actually iconified, it returns 0 otherwise.
212 int (*IconifyWindow)(_THIS);
214 /* Grab or ungrab keyboard and mouse input */
215 SDL_GrabMode (*GrabInput)(_THIS, SDL_GrabMode mode);
217 /* Get some platform dependent window information */
218 int (*GetWMInfo)(_THIS, SDL_SysWMinfo *info);
221 /* Cursor manager functions */
223 /* Free a window manager cursor
224 This function can be NULL if CreateWMCursor is also NULL.
226 void (*FreeWMCursor)(_THIS, WMcursor *cursor);
228 /* If not NULL, create a black/white window manager cursor */
229 WMcursor *(*CreateWMCursor)(_THIS,
230 Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y);
232 /* Show the specified cursor, or hide if cursor is NULL */
233 int (*ShowWMCursor)(_THIS, WMcursor *cursor);
235 /* Warp the window manager cursor to (x,y)
236 If NULL, a mouse motion event is posted internally.
238 void (*WarpWMCursor)(_THIS, Uint16 x, Uint16 y);
240 /* If not NULL, this is called when a mouse motion event occurs */
241 void (*MoveWMCursor)(_THIS, int x, int y);
243 /* Determine whether the mouse should be in relative mode or not.
244 This function is called when the input grab state or cursor
245 visibility state changes.
246 If the cursor is not visible, and the input is grabbed, the
247 driver can place the mouse in relative mode, which may result
248 in higher accuracy sampling of the pointer motion.
250 void (*CheckMouseMode)(_THIS);
253 /* Event manager functions */
255 /* Initialize keyboard mapping for this driver */
256 void (*InitOSKeymap)(_THIS);
258 /* Handle any queued OS events */
259 void (*PumpEvents)(_THIS);
262 /* Data common to all drivers */
265 SDL_Surface *visible;
266 SDL_Palette *physpal; /* physical palette, if != logical palette */
267 SDL_Color *gammacols; /* gamma-corrected colours, or NULL */
272 SDL_GrabMode input_grab;
274 /* Driver information flags */
275 int handles_any_size; /* Driver handles any size video mode */
278 /* Data used by the GL drivers */
289 int accum_green_size;
291 int accum_alpha_size;
293 int multisamplebuffers;
294 int multisamplesamples;
298 char driver_path[256];
303 /* Data private to this driver */
304 struct SDL_PrivateVideoData *hidden;
305 struct SDL_PrivateGLData *gl_data;
308 /* The function used to dispose of this structure */
313 typedef struct VideoBootStrap {
316 int (*available)(void);
317 SDL_VideoDevice *(*create)(int devindex);
320 #if SDL_VIDEO_DRIVER_QUARTZ
321 extern VideoBootStrap QZ_bootstrap;
323 #if SDL_VIDEO_DRIVER_X11
324 extern VideoBootStrap X11_bootstrap;
326 #if SDL_VIDEO_DRIVER_DGA
327 extern VideoBootStrap DGA_bootstrap;
329 #if SDL_VIDEO_DRIVER_NANOX
330 extern VideoBootStrap NX_bootstrap;
332 #if SDL_VIDEO_DRIVER_IPOD
333 extern VideoBootStrap iPod_bootstrap;
335 #if SDL_VIDEO_DRIVER_QTOPIA
336 extern VideoBootStrap Qtopia_bootstrap;
338 #if SDL_VIDEO_DRIVER_WSCONS
339 extern VideoBootStrap WSCONS_bootstrap;
341 #if SDL_VIDEO_DRIVER_FBCON
342 extern VideoBootStrap FBCON_bootstrap;
344 #if SDL_VIDEO_DRIVER_DIRECTFB
345 extern VideoBootStrap DirectFB_bootstrap;
347 #if SDL_VIDEO_DRIVER_PS2GS
348 extern VideoBootStrap PS2GS_bootstrap;
350 #if SDL_VIDEO_DRIVER_PS3
351 extern VideoBootStrap PS3_bootstrap;
353 #if SDL_VIDEO_DRIVER_GGI
354 extern VideoBootStrap GGI_bootstrap;
356 #if SDL_VIDEO_DRIVER_VGL
357 extern VideoBootStrap VGL_bootstrap;
359 #if SDL_VIDEO_DRIVER_SVGALIB
360 extern VideoBootStrap SVGALIB_bootstrap;
362 #if SDL_VIDEO_DRIVER_GAPI
363 extern VideoBootStrap GAPI_bootstrap;
365 #if SDL_VIDEO_DRIVER_WINDIB
366 extern VideoBootStrap WINDIB_bootstrap;
368 #if SDL_VIDEO_DRIVER_DDRAW
369 extern VideoBootStrap DIRECTX_bootstrap;
371 #if SDL_VIDEO_DRIVER_BWINDOW
372 extern VideoBootStrap BWINDOW_bootstrap;
374 #if SDL_VIDEO_DRIVER_TOOLBOX
375 extern VideoBootStrap TOOLBOX_bootstrap;
377 #if SDL_VIDEO_DRIVER_DRAWSPROCKET
378 extern VideoBootStrap DSp_bootstrap;
380 #if SDL_VIDEO_DRIVER_PHOTON
381 extern VideoBootStrap ph_bootstrap;
383 #if SDL_VIDEO_DRIVER_EPOC
384 extern VideoBootStrap EPOC_bootstrap;
386 #if SDL_VIDEO_DRIVER_XBIOS
387 extern VideoBootStrap XBIOS_bootstrap;
389 #if SDL_VIDEO_DRIVER_GEM
390 extern VideoBootStrap GEM_bootstrap;
392 #if SDL_VIDEO_DRIVER_PICOGUI
393 extern VideoBootStrap PG_bootstrap;
395 #if SDL_VIDEO_DRIVER_DC
396 extern VideoBootStrap DC_bootstrap;
398 #if SDL_VIDEO_DRIVER_NDS
399 extern VideoBootStrap NDS_bootstrap;
401 #if SDL_VIDEO_DRIVER_RISCOS
402 extern VideoBootStrap RISCOS_bootstrap;
404 #if SDL_VIDEO_DRIVER_OS2FS
405 extern VideoBootStrap OS2FSLib_bootstrap;
407 #if SDL_VIDEO_DRIVER_AALIB
408 extern VideoBootStrap AALIB_bootstrap;
410 #if SDL_VIDEO_DRIVER_CACA
411 extern VideoBootStrap CACA_bootstrap;
413 #if SDL_VIDEO_DRIVER_OMAPDSS
414 extern VideoBootStrap omapdss_bootstrap;
416 #if SDL_VIDEO_DRIVER_DUMMY
417 extern VideoBootStrap DUMMY_bootstrap;
420 /* This is the current video device */
421 extern SDL_VideoDevice *current_video;
423 #define SDL_VideoSurface (current_video->screen)
424 #define SDL_ShadowSurface (current_video->shadow)
425 #define SDL_PublicSurface (current_video->visible)
427 #endif /* _SDL_sysvideo_h */