This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_sysvideo.h
443 lines (369 loc) · 13.2 KB
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
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
/* The SDL video driver */
41
42
43
/* Define the SDL window structure, corresponding to toplevel windows */
typedef struct SDL_Window SDL_Window;
44
45
46
47
struct SDL_Window
{
Uint32 id;
48
49
50
51
52
char *title;
int x, y;
int w, h;
Uint32 flags;
53
54
55
56
SDL_Surface *surface;
SDL_Surface *shadow;
Uint16 *gamma;
57
58
59
60
void *userdata;
void *driverdata;
};
61
62
63
64
65
66
67
68
69
70
/* 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;
71
72
73
74
int max_windows;
int num_windows;
SDL_Window *windows;
75
76
77
void *driverdata;
} SDL_VideoDisplay;
78
79
typedef struct SDL_VideoDevice SDL_VideoDevice;
80
81
82
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
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
120
121
122
123
124
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);
125
void (*CreateWindowSurface) (_THIS, SDL_Window * window, Uint32 flags);
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
176
177
178
179
180
181
182
183
184
185
186
187
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
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);
214
215
216
/* Get attribute information from the windowing system. */
int (*GL_GetAttribute) (_THIS, SDL_GLattr attrib, int *value);
217
218
219
/* Make the context associated with this driver current */
int (*GL_MakeCurrent) (_THIS);
220
221
222
/* Swap the current buffers in double buffer mode. */
void (*GL_SwapBuffers) (_THIS);
223
224
/* OpenGL functions for glSDL */
225
#if SDL_VIDEO_OPENGL
226
#if !defined(__WIN32__)
227
228
229
230
231
232
#define WINAPI
#endif
#define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
#include "SDL_glfuncs.h"
#undef SDL_PROC
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/* Texture id */
GLuint texture;
int is_32bit;
#endif
/* * * */
/* 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 */
struct
{
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);
324
325
326
};
#undef _THIS
327
328
329
330
331
332
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
333
334
} VideoBootStrap;
335
336
337
338
#if SDL_VIDEO_DRIVER_QUARTZ
extern VideoBootStrap QZ_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_X11
339
340
extern VideoBootStrap X11_bootstrap;
#endif
341
#if SDL_VIDEO_DRIVER_DGA
342
343
extern VideoBootStrap DGA_bootstrap;
#endif
344
#if SDL_VIDEO_DRIVER_NANOX
345
346
extern VideoBootStrap NX_bootstrap;
#endif
347
#if SDL_VIDEO_DRIVER_IPOD
348
349
extern VideoBootStrap iPod_bootstrap;
#endif
350
351
352
353
354
355
356
#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
357
358
extern VideoBootStrap FBCON_bootstrap;
#endif
359
#if SDL_VIDEO_DRIVER_DIRECTFB
360
361
extern VideoBootStrap DirectFB_bootstrap;
#endif
362
#if SDL_VIDEO_DRIVER_PS2GS
363
364
extern VideoBootStrap PS2GS_bootstrap;
#endif
365
#if SDL_VIDEO_DRIVER_GGI
366
367
extern VideoBootStrap GGI_bootstrap;
#endif
368
#if SDL_VIDEO_DRIVER_VGL
369
370
extern VideoBootStrap VGL_bootstrap;
#endif
371
#if SDL_VIDEO_DRIVER_SVGALIB
372
373
extern VideoBootStrap SVGALIB_bootstrap;
#endif
374
#if SDL_VIDEO_DRIVER_GAPI
375
376
extern VideoBootStrap GAPI_bootstrap;
#endif
377
#if SDL_VIDEO_DRIVER_WINDIB
378
379
extern VideoBootStrap WINDIB_bootstrap;
#endif
380
#if SDL_VIDEO_DRIVER_DDRAW
381
382
extern VideoBootStrap DIRECTX_bootstrap;
#endif
383
#if SDL_VIDEO_DRIVER_BWINDOW
384
385
extern VideoBootStrap BWINDOW_bootstrap;
#endif
386
#if SDL_VIDEO_DRIVER_TOOLBOX
387
388
extern VideoBootStrap TOOLBOX_bootstrap;
#endif
389
#if SDL_VIDEO_DRIVER_DRAWSPROCKET
390
391
extern VideoBootStrap DSp_bootstrap;
#endif
392
#if SDL_VIDEO_DRIVER_CYBERGRAPHICS
393
394
extern VideoBootStrap CGX_bootstrap;
#endif
395
#if SDL_VIDEO_DRIVER_PHOTON
396
397
extern VideoBootStrap ph_bootstrap;
#endif
398
#if SDL_VIDEO_DRIVER_EPOC
399
400
extern VideoBootStrap EPOC_bootstrap;
#endif
401
#if SDL_VIDEO_DRIVER_XBIOS
402
403
extern VideoBootStrap XBIOS_bootstrap;
#endif
404
#if SDL_VIDEO_DRIVER_GEM
405
406
extern VideoBootStrap GEM_bootstrap;
#endif
407
#if SDL_VIDEO_DRIVER_PICOGUI
408
409
extern VideoBootStrap PG_bootstrap;
#endif
410
#if SDL_VIDEO_DRIVER_DC
411
412
extern VideoBootStrap DC_bootstrap;
#endif
413
#if SDL_VIDEO_DRIVER_RISCOS
414
415
extern VideoBootStrap RISCOS_bootstrap;
#endif
416
#if SDL_VIDEO_DRIVER_OS2FS
417
418
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
419
420
421
422
423
424
#if SDL_VIDEO_DRIVER_AALIB
extern VideoBootStrap AALIB_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
425
426
427
#if SDL_VIDEO_DRIVER_GLSDL
extern VideoBootStrap glSDL_bootstrap;
#endif
428
429
430
431
432
433
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
#define SDL_CurrentWindow (SDL_CurrentDisplay.windows[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)
434
435
436
437
438
439
extern SDL_VideoDevice *SDL_GetVideoDevice ();
extern void SDL_AddBasicVideoDisplay (const SDL_DisplayMode * desktop_mode);
extern void SDL_AddVideoDisplay (SDL_VideoDisplay * display);
extern void SDL_AddDisplayMode (int display, const SDL_DisplayMode * mode);
extern SDL_Window *SDL_GetWindowFromSurface (SDL_Surface * surface);
440
441
#endif /* _SDL_sysvideo_h */
442
443
/* vi: set ts=4 sw=4 expandtab: */