This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_sysvideo.h
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.
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
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
#include "SDL_mouse.h"
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
120
121
122
123
124
125
126
127
128
129
130
131
132
/* The SDL video driver */
typedef struct SDL_Window SDL_Window;
typedef struct SDL_Texture SDL_Texture;
typedef struct SDL_Renderer SDL_Renderer;
typedef struct SDL_RenderDriver SDL_RenderDriver;
typedef struct SDL_VideoDisplay SDL_VideoDisplay;
typedef struct SDL_VideoDevice SDL_VideoDevice;
/* Define the SDL texture structure */
struct SDL_Texture
{
Uint32 id;
Uint32 format; /**< The pixel format of the texture */
int access; /**< SDL_TextureAccess */
int w; /**< The width of the texture */
int h; /**< The height of the texture */
SDL_Renderer *renderer;
void *driverdata; /**< Driver specific texture representation */
SDL_Texture *next;
};
/* Define the SDL renderer structure */
struct SDL_Renderer
{
int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
int (*QueryTexturePixels) (SDL_Renderer * renderer, SDL_Texture * texture,
void **pixels, int *pitch);
int (*SetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
const SDL_Color * colors, int firstcolor,
int ncolors);
int (*GetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
SDL_Color * colors, int firstcolor,
int ncolors);
int (*UpdateTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
const SDL_Rect * rect, const void *pixels,
int pitch);
int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
const SDL_Rect * rect, int markDirty, void **pixels,
int *pitch);
void (*UnlockTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
void (*DirtyTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
int numrects, const SDL_Rect * rects);
void (*SelectRenderTexture) (SDL_Renderer * renderer,
SDL_Texture * texture);
int (*RenderFill) (SDL_Renderer * renderer, const SDL_Rect * rect,
Uint32 color);
int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
const SDL_Rect * srcrect, const SDL_Rect * dstrect,
int blendMode, int scaleMode);
int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
void *pixels, int pitch);
int (*RenderWritePixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
const void *pixels, int pitch);
void (*RenderPresent) (SDL_Renderer * renderer);
void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
void (*DestroyRenderer) (SDL_Renderer * renderer);
/* The current renderer info */
SDL_RendererInfo info;
/* The window associated with the renderer */
SDL_WindowID window;
void *driverdata;
};
/* Define the SDL render driver structure */
struct SDL_RenderDriver
{
SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
/* Info about the renderer capabilities */
SDL_RendererInfo info;
};
/* Define the SDL window structure, corresponding to toplevel windows */
struct SDL_Window
{
Uint32 id;
char *title;
int x, y;
int w, h;
Uint32 flags;
int display;
SDL_Renderer *renderer;
void *userdata;
void *driverdata;
};
#define FULLSCREEN_VISIBLE(W) \
(((W)->flags & SDL_WINDOW_FULLSCREEN) && \
((W)->flags & SDL_WINDOW_SHOWN) && \
!((W)->flags & SDL_WINDOW_MINIMIZED))
/* Define the SDL display structure
This corresponds to physical monitors attached to the system.
133
*/
134
135
136
137
138
139
140
141
142
143
struct SDL_VideoDisplay
{
int max_display_modes;
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
SDL_DisplayMode desired_mode;
SDL_DisplayMode *fullscreen_mode;
SDL_Palette *palette;
145
146
Uint16 *gamma;
Uint16 *saved_gamma; /* (just offset into gamma) */
148
149
int num_render_drivers;
SDL_RenderDriver *render_drivers;
151
152
int num_windows;
SDL_Window *windows;
154
SDL_Renderer *current_renderer;
156
157
/* The hash list of textures */
SDL_Texture *textures[64];
159
SDL_VideoDevice *device;
161
162
void *driverdata;
};
164
165
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
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
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
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
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
*/
/* Get a list of the available display modes.
* e.g. SDL_AddDisplayMode(_this->current_display, mode)
*/
void (*GetDisplayModes) (_THIS);
/* 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, SDL_DisplayMode * mode);
/* Set the color entries of the display palette */
int (*SetDisplayPalette) (_THIS, SDL_Palette * palette);
/* Get the color entries of the display palette */
int (*GetDisplayPalette) (_THIS, SDL_Palette * palette);
/* Set the gamma ramp */
int (*SetDisplayGammaRamp) (_THIS, Uint16 * ramp);
/* Get the gamma ramp */
int (*GetDisplayGammaRamp) (_THIS, Uint16 * ramp);
/* * * */
/* Window functions
*/
int (*CreateWindow) (_THIS, SDL_Window * window);
int (*CreateWindowFrom) (_THIS, SDL_Window * window, const 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);
/* Get some platform dependent window information */
SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
struct SDL_SysWMinfo * info);
/* Reverse the effects VideoInit() -- called if VideoInit() fails
or if the application is shutting down the video subsystem.
*/
void (*VideoQuit) (_THIS);
/* * * */
/* 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);
/* 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 */
/* Handle any queued OS events */
void (*PumpEvents) (_THIS);
/* * * */
/* Data common to all drivers */
int num_displays;
SDL_VideoDisplay *displays;
int current_display;
Uint32 next_object_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 driver_loaded;
char driver_path[256];
void *dll_handle;
} gl_config;
/* * * */
/* Data private to this driver */
void *driverdata;
struct SDL_PrivateGLData *gl_data;
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
310
311
};
312
313
314
315
316
317
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
318
319
} 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
#if SDL_VIDEO_DRIVER_GGI
351
352
extern VideoBootStrap GGI_bootstrap;
#endif
353
#if SDL_VIDEO_DRIVER_VGL
354
355
extern VideoBootStrap VGL_bootstrap;
#endif
356
#if SDL_VIDEO_DRIVER_SVGALIB
357
358
extern VideoBootStrap SVGALIB_bootstrap;
#endif
359
#if SDL_VIDEO_DRIVER_GAPI
360
361
extern VideoBootStrap GAPI_bootstrap;
#endif
362
363
#if SDL_VIDEO_DRIVER_WIN32
extern VideoBootStrap WIN32_bootstrap;
364
#endif
365
#if SDL_VIDEO_DRIVER_BWINDOW
366
367
extern VideoBootStrap BWINDOW_bootstrap;
#endif
368
#if SDL_VIDEO_DRIVER_TOOLBOX
369
370
extern VideoBootStrap TOOLBOX_bootstrap;
#endif
371
#if SDL_VIDEO_DRIVER_DRAWSPROCKET
372
373
extern VideoBootStrap DSp_bootstrap;
#endif
374
#if SDL_VIDEO_DRIVER_CYBERGRAPHICS
375
376
extern VideoBootStrap CGX_bootstrap;
#endif
377
#if SDL_VIDEO_DRIVER_PHOTON
378
379
extern VideoBootStrap ph_bootstrap;
#endif
380
#if SDL_VIDEO_DRIVER_EPOC
381
382
extern VideoBootStrap EPOC_bootstrap;
#endif
383
#if SDL_VIDEO_DRIVER_XBIOS
384
385
extern VideoBootStrap XBIOS_bootstrap;
#endif
386
#if SDL_VIDEO_DRIVER_GEM
387
388
extern VideoBootStrap GEM_bootstrap;
#endif
389
#if SDL_VIDEO_DRIVER_PICOGUI
390
391
extern VideoBootStrap PG_bootstrap;
#endif
392
#if SDL_VIDEO_DRIVER_DC
393
394
extern VideoBootStrap DC_bootstrap;
#endif
395
#if SDL_VIDEO_DRIVER_RISCOS
396
397
extern VideoBootStrap RISCOS_bootstrap;
#endif
398
#if SDL_VIDEO_DRIVER_OS2FS
399
400
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
401
402
403
404
405
406
#if SDL_VIDEO_DRIVER_AALIB
extern VideoBootStrap AALIB_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
407
408
409
410
411
#if SDL_VIDEO_DRIVER_GLSDL
extern VideoBootStrap glSDL_bootstrap;
#endif
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
413
414
415
416
417
418
419
extern SDL_VideoDevice *SDL_GetVideoDevice();
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
extern SDL_bool SDL_AddDisplayMode(int displayIndex,
const SDL_DisplayMode * mode);
extern void SDL_AddRenderDriver(int displayIndex,
const SDL_RenderDriver * driver);
421
422
423
424
425
426
427
428
extern SDL_Window *SDL_GetWindowFromID(SDL_WindowID windowID);
extern SDL_VideoDisplay *SDL_GetDisplayFromWindow(SDL_Window * window);
extern void SDL_OnWindowShown(SDL_Window * window);
extern void SDL_OnWindowHidden(SDL_Window * window);
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
extern SDL_WindowID SDL_GetFocusWindow(void);
429
430
#endif /* _SDL_sysvideo_h */
431
432
/* vi: set ts=4 sw=4 expandtab: */