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
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 */
42
typedef struct SDL_Window SDL_Window;
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
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_Texture * texture);
int (*UpdateTexture) (SDL_Texture * texture, SDL_Rect * rect,
const void *pixels, int pitch);
int (*LockTexture) (SDL_Texture * texture, SDL_Rect * rect, int markDirty,
void **pixels, int *pitch);
void (*UnlockTexture) (SDL_Texture * texture);
void (*DirtyTexture) (SDL_Texture * texture, int numrects,
SDL_Rect * rects);
void (*SelectRenderTexture) (SDL_Texture * texture);
void (*RenderFill) (SDL_Rect * rect, Uint32 color);
int (*RenderCopy) (SDL_Texture * texture, SDL_Rect * srcrect,
SDL_Rect * dstrect, int blendMode, int scaleMode);
int (*RenderReadPixels) (SDL_Rect * rect, void *pixels, int pitch);
int (*RenderWritePixels) (SDL_Rect * rect, const void *pixels, int pitch);
void (*RenderPresent) (void);
void (*DestroyTexture) (SDL_Texture * texture);
void (*DestroyRenderer) (SDL_Renderer * renderer);
/* The current renderer info */
SDL_RendererInfo info;
/* The window associated with the renderer */
SDL_Window *window;
94
95
96
97
98
99
100
101
102
103
104
105
106
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 */
107
108
109
struct SDL_Window
{
Uint32 id;
111
112
113
114
char *title;
int x, y;
int w, h;
Uint32 flags;
116
Uint16 *gamma;
118
119
SDL_Renderer *renderer;
120
121
122
void *userdata;
void *driverdata;
};
124
125
126
/* Define the SDL display structure
This corresponds to physical monitors attached to the system.
*/
127
struct SDL_VideoDisplay
128
129
130
131
132
{
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
134
135
136
int num_render_drivers;
SDL_RenderDriver *render_drivers;
137
138
int num_windows;
SDL_Window *windows;
140
SDL_Renderer *current_renderer;
142
143
144
145
146
/* The hash list of textures */
SDL_Texture *textures[64];
void *driverdata;
};
148
149
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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);
175
176
177
178
179
180
181
/* Sets the color entries { firstcolor .. (firstcolor+ncolors-1) }
of the physical palette to those in 'colors'. The return value
is 0 if all entries could be set properly or -1 otherwise.
*/
int (*SetDisplayColors) (_THIS, int firstcolor, int ncolors,
SDL_Color * colors);
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/* * * */
/* 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);
/* Get some platform dependent window information */
200
201
SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
SDL_SysWMinfo * info);
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
/* 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);
/* * * */
/* 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);
239
240
/* Get attribute information from the windowing system. */
int (*GL_GetAttribute) (_THIS, SDL_GLattr attrib, int *value);
242
243
/* Make the context associated with this driver current */
int (*GL_MakeCurrent) (_THIS);
245
246
/* Swap the current buffers in double buffer mode. */
void (*GL_SwapBuffers) (_THIS);
248
/* OpenGL functions for glSDL */
249
#if SDL_VIDEO_OPENGL
250
#if !defined(__WIN32__)
251
252
253
254
255
256
#define WINAPI
#endif
#define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
#include "SDL_glfuncs.h"
#undef SDL_PROC
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
/* Texture id */
GLuint texture;
int is_32bit;
#endif
/* 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;
283
Uint32 next_object_id;
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
/* 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);
321
322
323
};
#undef _THIS
324
325
326
327
328
329
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
330
331
} VideoBootStrap;
332
333
334
335
#if SDL_VIDEO_DRIVER_QUARTZ
extern VideoBootStrap QZ_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_X11
336
337
extern VideoBootStrap X11_bootstrap;
#endif
338
#if SDL_VIDEO_DRIVER_DGA
339
340
extern VideoBootStrap DGA_bootstrap;
#endif
341
#if SDL_VIDEO_DRIVER_NANOX
342
343
extern VideoBootStrap NX_bootstrap;
#endif
344
#if SDL_VIDEO_DRIVER_IPOD
345
346
extern VideoBootStrap iPod_bootstrap;
#endif
347
348
349
350
351
352
353
#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
354
355
extern VideoBootStrap FBCON_bootstrap;
#endif
356
#if SDL_VIDEO_DRIVER_DIRECTFB
357
358
extern VideoBootStrap DirectFB_bootstrap;
#endif
359
#if SDL_VIDEO_DRIVER_PS2GS
360
361
extern VideoBootStrap PS2GS_bootstrap;
#endif
362
#if SDL_VIDEO_DRIVER_GGI
363
364
extern VideoBootStrap GGI_bootstrap;
#endif
365
#if SDL_VIDEO_DRIVER_VGL
366
367
extern VideoBootStrap VGL_bootstrap;
#endif
368
#if SDL_VIDEO_DRIVER_SVGALIB
369
370
extern VideoBootStrap SVGALIB_bootstrap;
#endif
371
#if SDL_VIDEO_DRIVER_GAPI
372
373
extern VideoBootStrap GAPI_bootstrap;
#endif
374
#if SDL_VIDEO_DRIVER_WINDIB
375
376
extern VideoBootStrap WINDIB_bootstrap;
#endif
377
#if SDL_VIDEO_DRIVER_DDRAW
378
379
extern VideoBootStrap DIRECTX_bootstrap;
#endif
380
#if SDL_VIDEO_DRIVER_BWINDOW
381
382
extern VideoBootStrap BWINDOW_bootstrap;
#endif
383
#if SDL_VIDEO_DRIVER_TOOLBOX
384
385
extern VideoBootStrap TOOLBOX_bootstrap;
#endif
386
#if SDL_VIDEO_DRIVER_DRAWSPROCKET
387
388
extern VideoBootStrap DSp_bootstrap;
#endif
389
#if SDL_VIDEO_DRIVER_CYBERGRAPHICS
390
391
extern VideoBootStrap CGX_bootstrap;
#endif
392
#if SDL_VIDEO_DRIVER_PHOTON
393
394
extern VideoBootStrap ph_bootstrap;
#endif
395
#if SDL_VIDEO_DRIVER_EPOC
396
397
extern VideoBootStrap EPOC_bootstrap;
#endif
398
#if SDL_VIDEO_DRIVER_XBIOS
399
400
extern VideoBootStrap XBIOS_bootstrap;
#endif
401
#if SDL_VIDEO_DRIVER_GEM
402
403
extern VideoBootStrap GEM_bootstrap;
#endif
404
#if SDL_VIDEO_DRIVER_PICOGUI
405
406
extern VideoBootStrap PG_bootstrap;
#endif
407
#if SDL_VIDEO_DRIVER_DC
408
409
extern VideoBootStrap DC_bootstrap;
#endif
410
#if SDL_VIDEO_DRIVER_RISCOS
411
412
extern VideoBootStrap RISCOS_bootstrap;
#endif
413
#if SDL_VIDEO_DRIVER_OS2FS
414
415
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
416
417
418
419
420
421
#if SDL_VIDEO_DRIVER_AALIB
extern VideoBootStrap AALIB_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
422
423
424
#if SDL_VIDEO_DRIVER_GLSDL
extern VideoBootStrap glSDL_bootstrap;
#endif
426
427
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
#define SDL_CurrentWindow (SDL_CurrentDisplay.windows[0])
429
430
extern SDL_VideoDevice *SDL_GetVideoDevice();
extern void SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
431
extern void SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
432
433
434
435
extern void SDL_AddDisplayMode(int displayIndex,
const SDL_DisplayMode * mode);
extern void SDL_AddRenderDriver(int displayIndex,
const SDL_RenderDriver * driver);
436
437
#endif /* _SDL_sysvideo_h */
438
439
/* vi: set ts=4 sw=4 expandtab: */