/
SDL_sysvideo.h
424 lines (353 loc) · 12 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2012 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
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
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
18
19
Sam Lantinga
20
slouken@libsdl.org
21
*/
22
#include "SDL_config.h"
23
24
25
26
27
28
29
30
31
32
33
34
35
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
#include "SDL_mouse.h"
#define SDL_PROTOTYPES_ONLY
#include "SDL_syswm.h"
#undef SDL_PROTOTYPES_ONLY
/* This file prototypes the video driver implementation.
This is designed to be easily converted to C++ in the future.
*/
36
#if SDL_VIDEO_OPENGL
37
#include "SDL_opengl.h"
38
#endif /* SDL_VIDEO_OPENGL */
39
40
41
42
43
44
45
46
47
48
49
/* The SDL video driver */
typedef struct SDL_VideoDevice SDL_VideoDevice;
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
#ifndef _STATUS
#define _STATUS SDL_status *status
#endif
struct SDL_VideoDevice {
/* * * */
50
/* The name of this video driver */
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
const char *name;
/* * * */
/* Initialization/Query functions */
/* Initialize the native video subsystem, filling 'vformat' with the
"best" display pixel format, returning 0 or -1 if there's an error.
*/
int (*VideoInit)(_THIS, SDL_PixelFormat *vformat);
/* List the available video modes for the given pixel format, sorted
from largest to smallest.
*/
SDL_Rect **(*ListModes)(_THIS, SDL_PixelFormat *format, Uint32 flags);
/* Set the requested video mode, returning a surface which will be
set to the SDL_VideoSurface. The width and height will already
be verified by ListModes(), and the video subsystem is free to
set the mode to a supported bit depth different from the one
specified -- the desired bpp will be emulated with a shadow
surface if necessary. If a new mode is returned, this function
should take care of cleaning up the current mode.
*/
SDL_Surface *(*SetVideoMode)(_THIS, SDL_Surface *current,
int width, int height, int bpp, Uint32 flags);
/* Toggle the fullscreen mode */
int (*ToggleFullScreen)(_THIS, int on);
/* This is called after the video mode has been set, to get the
initial mouse state. It should queue events as necessary to
properly represent the current mouse focus and position.
*/
void (*UpdateMouse)(_THIS);
/* 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);
/* 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 (*SetColors)(_THIS, int firstcolor, int ncolors,
SDL_Color *colors);
/* This pointer should exist in the native video subsystem and should
point to an appropriate update function for the current video mode
*/
void (*UpdateRects)(_THIS, int numrects, SDL_Rect *rects);
/* 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;
120
121
122
/* The pixel format used when SDL_CreateRGBSurface creates SDL_HWSURFACEs with alpha */
SDL_PixelFormat* displayformatalphapixel;
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/* 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);
/* Performs hardware flipping */
int (*FlipHWSurface)(_THIS, SDL_Surface *surface);
/* Frees a previously allocated video surface */
void (*FreeHWSurface)(_THIS, SDL_Surface *surface);
/* * * */
/* Gamma support */
Uint16 *gamma;
/* 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);
176
177
/* Get attribute information from the windowing system. */
int (*GL_GetAttribute)(_THIS, SDL_GLattr attrib, int* value);
178
179
180
/* Make the context associated with this driver current */
int (*GL_MakeCurrent)(_THIS);
181
182
183
184
185
/* Swap the current buffers in double buffer mode. */
void (*GL_SwapBuffers)(_THIS);
/* OpenGL functions for SDL_OPENGLBLIT */
186
#if SDL_VIDEO_OPENGL
187
#if !defined(__WIN32__)
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
#define WINAPI
#endif
#define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
#include "SDL_glfuncs.h"
#undef SDL_PROC
/* Texture id */
GLuint texture;
#endif
int is_32bit;
/* * * */
/* Window manager functions */
/* Set the title and icon text */
void (*SetCaption)(_THIS, const char *title, const char *icon);
/* Set the window icon image */
void (*SetIcon)(_THIS, SDL_Surface *icon, Uint8 *mask);
/* Iconify the window.
This function returns 1 if there is a window manager and the
window was actually iconified, it returns 0 otherwise.
*/
int (*IconifyWindow)(_THIS);
/* Grab or ungrab keyboard and mouse input */
SDL_GrabMode (*GrabInput)(_THIS, SDL_GrabMode mode);
/* Get some platform dependent window information */
int (*GetWMInfo)(_THIS, SDL_SysWMinfo *info);
/* * * */
/* 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 */
SDL_Surface *screen;
SDL_Surface *shadow;
SDL_Surface *visible;
SDL_Palette *physpal; /* physical palette, if != logical palette */
SDL_Color *gammacols; /* gamma-corrected colours, or NULL */
char *wm_title;
char *wm_icon;
int offset_x;
int offset_y;
SDL_GrabMode input_grab;
/* Driver information flags */
int handles_any_size; /* Driver handles any size video mode */
/* * * */
/* Data used by the GL drivers */
struct {
int red_size;
int green_size;
int blue_size;
int alpha_size;
int depth_size;
285
int buffer_size;
286
287
int stencil_size;
int double_buffer;
288
289
290
291
292
int accum_red_size;
int accum_green_size;
int accum_blue_size;
int accum_alpha_size;
int stereo;
293
294
int multisamplebuffers;
int multisamplesamples;
295
int accelerated;
296
int swap_control;
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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;
320
321
322
323
#if SDL_VIDEO_DRIVER_QUARTZ
extern VideoBootStrap QZ_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_X11
324
325
extern VideoBootStrap X11_bootstrap;
#endif
326
#if SDL_VIDEO_DRIVER_DGA
327
328
extern VideoBootStrap DGA_bootstrap;
#endif
329
#if SDL_VIDEO_DRIVER_NANOX
330
331
extern VideoBootStrap NX_bootstrap;
#endif
332
#if SDL_VIDEO_DRIVER_IPOD
333
334
extern VideoBootStrap iPod_bootstrap;
#endif
335
336
337
338
339
340
341
#if SDL_VIDEO_DRIVER_QTOPIA
extern VideoBootStrap Qtopia_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_WSCONS
extern VideoBootStrap WSCONS_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_FBCON
342
343
extern VideoBootStrap FBCON_bootstrap;
#endif
344
#if SDL_VIDEO_DRIVER_DIRECTFB
345
346
extern VideoBootStrap DirectFB_bootstrap;
#endif
347
#if SDL_VIDEO_DRIVER_PS2GS
348
349
extern VideoBootStrap PS2GS_bootstrap;
#endif
350
351
352
#if SDL_VIDEO_DRIVER_PS3
extern VideoBootStrap PS3_bootstrap;
#endif
353
#if SDL_VIDEO_DRIVER_GGI
354
355
extern VideoBootStrap GGI_bootstrap;
#endif
356
#if SDL_VIDEO_DRIVER_VGL
357
358
extern VideoBootStrap VGL_bootstrap;
#endif
359
#if SDL_VIDEO_DRIVER_SVGALIB
360
361
extern VideoBootStrap SVGALIB_bootstrap;
#endif
362
#if SDL_VIDEO_DRIVER_GAPI
363
364
extern VideoBootStrap GAPI_bootstrap;
#endif
365
#if SDL_VIDEO_DRIVER_WINDIB
366
367
extern VideoBootStrap WINDIB_bootstrap;
#endif
368
#if SDL_VIDEO_DRIVER_DDRAW
369
370
extern VideoBootStrap DIRECTX_bootstrap;
#endif
371
#if SDL_VIDEO_DRIVER_BWINDOW
372
373
extern VideoBootStrap BWINDOW_bootstrap;
#endif
374
#if SDL_VIDEO_DRIVER_TOOLBOX
375
376
extern VideoBootStrap TOOLBOX_bootstrap;
#endif
377
#if SDL_VIDEO_DRIVER_DRAWSPROCKET
378
379
extern VideoBootStrap DSp_bootstrap;
#endif
380
#if SDL_VIDEO_DRIVER_PHOTON
381
382
extern VideoBootStrap ph_bootstrap;
#endif
383
#if SDL_VIDEO_DRIVER_EPOC
384
385
extern VideoBootStrap EPOC_bootstrap;
#endif
386
#if SDL_VIDEO_DRIVER_XBIOS
387
388
extern VideoBootStrap XBIOS_bootstrap;
#endif
389
#if SDL_VIDEO_DRIVER_GEM
390
391
extern VideoBootStrap GEM_bootstrap;
#endif
392
#if SDL_VIDEO_DRIVER_PICOGUI
393
394
extern VideoBootStrap PG_bootstrap;
#endif
395
#if SDL_VIDEO_DRIVER_DC
396
397
extern VideoBootStrap DC_bootstrap;
#endif
398
399
400
#if SDL_VIDEO_DRIVER_NDS
extern VideoBootStrap NDS_bootstrap;
#endif
401
#if SDL_VIDEO_DRIVER_RISCOS
402
403
extern VideoBootStrap RISCOS_bootstrap;
#endif
404
#if SDL_VIDEO_DRIVER_OS2FS
405
406
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
407
408
409
#if SDL_VIDEO_DRIVER_AALIB
extern VideoBootStrap AALIB_bootstrap;
#endif
410
411
412
#if SDL_VIDEO_DRIVER_CACA
extern VideoBootStrap CACA_bootstrap;
#endif
413
414
415
416
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
417
418
419
420
421
422
423
424
/* This is the current video device */
extern SDL_VideoDevice *current_video;
#define SDL_VideoSurface (current_video->screen)
#define SDL_ShadowSurface (current_video->shadow)
#define SDL_PublicSurface (current_video->visible)
#endif /* _SDL_sysvideo_h */