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
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
{
69
int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
70
71
int (*QueryTexturePixels) (SDL_Renderer * renderer, SDL_Texture * texture,
void **pixels, int *pitch);
72
73
74
int (*SetTexturePalette) (SDL_Renderer * renderer, SDL_Texture * texture,
SDL_Color * colors, int firstcolor,
int ncolors);
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
int (*UpdateTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
SDL_Rect * rect, const void *pixels, int pitch);
int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
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, SDL_Rect * rects);
void (*SelectRenderTexture) (SDL_Renderer * renderer,
SDL_Texture * texture);
void (*RenderFill) (SDL_Renderer * renderer, SDL_Rect * rect,
Uint32 color);
int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
SDL_Rect * srcrect, SDL_Rect * dstrect, int blendMode,
int scaleMode);
int (*RenderReadPixels) (SDL_Renderer * renderer, SDL_Rect * rect,
void *pixels, int pitch);
int (*RenderWritePixels) (SDL_Renderer * renderer, SDL_Rect * rect,
const void *pixels, int pitch);
void (*RenderPresent) (SDL_Renderer * renderer);
void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
96
97
98
99
100
101
102
103
void (*DestroyRenderer) (SDL_Renderer * renderer);
/* The current renderer info */
SDL_RendererInfo info;
/* The window associated with the renderer */
SDL_Window *window;
105
106
107
108
109
110
111
112
113
114
115
116
117
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 */
118
119
120
struct SDL_Window
{
Uint32 id;
122
123
124
125
char *title;
int x, y;
int w, h;
Uint32 flags;
127
Uint16 *gamma;
129
SDL_VideoDisplay *display;
130
131
SDL_Renderer *renderer;
132
133
134
void *userdata;
void *driverdata;
};
136
137
138
/* Define the SDL display structure
This corresponds to physical monitors attached to the system.
*/
139
struct SDL_VideoDisplay
140
141
142
143
144
{
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
146
147
148
int num_render_drivers;
SDL_RenderDriver *render_drivers;
149
150
int num_windows;
SDL_Window *windows;
152
SDL_Renderer *current_renderer;
154
155
156
157
158
/* The hash list of textures */
SDL_Texture *textures[64];
void *driverdata;
};
160
161
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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);
187
188
189
190
191
192
193
/* 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);
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* * * */
/* 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 */
212
213
SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
SDL_SysWMinfo * info);
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
/* 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);
244
245
/* Get attribute information from the windowing system. */
int (*GL_GetAttribute) (_THIS, SDL_GLattr attrib, int *value);
247
248
/* Make the context associated with this driver current */
int (*GL_MakeCurrent) (_THIS);
250
251
/* Swap the current buffers in double buffer mode. */
void (*GL_SwapBuffers) (_THIS);
253
/* OpenGL functions for glSDL */
254
#if SDL_VIDEO_OPENGL
255
#if !defined(__WIN32__)
256
257
258
259
260
261
#define WINAPI
#endif
#define SDL_PROC(ret,func,params) ret (WINAPI *func) params;
#include "SDL_glfuncs.h"
#undef SDL_PROC
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
/* 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;
288
Uint32 next_object_id;
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
324
325
/* 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);
326
327
328
};
#undef _THIS
329
330
331
332
333
334
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
335
336
} VideoBootStrap;
337
338
339
340
#if SDL_VIDEO_DRIVER_QUARTZ
extern VideoBootStrap QZ_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_X11
341
342
extern VideoBootStrap X11_bootstrap;
#endif
343
#if SDL_VIDEO_DRIVER_DGA
344
345
extern VideoBootStrap DGA_bootstrap;
#endif
346
#if SDL_VIDEO_DRIVER_NANOX
347
348
extern VideoBootStrap NX_bootstrap;
#endif
349
#if SDL_VIDEO_DRIVER_IPOD
350
351
extern VideoBootStrap iPod_bootstrap;
#endif
352
353
354
355
356
357
358
#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
359
360
extern VideoBootStrap FBCON_bootstrap;
#endif
361
#if SDL_VIDEO_DRIVER_DIRECTFB
362
363
extern VideoBootStrap DirectFB_bootstrap;
#endif
364
#if SDL_VIDEO_DRIVER_PS2GS
365
366
extern VideoBootStrap PS2GS_bootstrap;
#endif
367
#if SDL_VIDEO_DRIVER_GGI
368
369
extern VideoBootStrap GGI_bootstrap;
#endif
370
#if SDL_VIDEO_DRIVER_VGL
371
372
extern VideoBootStrap VGL_bootstrap;
#endif
373
#if SDL_VIDEO_DRIVER_SVGALIB
374
375
extern VideoBootStrap SVGALIB_bootstrap;
#endif
376
#if SDL_VIDEO_DRIVER_GAPI
377
378
extern VideoBootStrap GAPI_bootstrap;
#endif
379
#if SDL_VIDEO_DRIVER_WINDIB
380
381
extern VideoBootStrap WINDIB_bootstrap;
#endif
382
#if SDL_VIDEO_DRIVER_DDRAW
383
384
extern VideoBootStrap DIRECTX_bootstrap;
#endif
385
#if SDL_VIDEO_DRIVER_BWINDOW
386
387
extern VideoBootStrap BWINDOW_bootstrap;
#endif
388
#if SDL_VIDEO_DRIVER_TOOLBOX
389
390
extern VideoBootStrap TOOLBOX_bootstrap;
#endif
391
#if SDL_VIDEO_DRIVER_DRAWSPROCKET
392
393
extern VideoBootStrap DSp_bootstrap;
#endif
394
#if SDL_VIDEO_DRIVER_CYBERGRAPHICS
395
396
extern VideoBootStrap CGX_bootstrap;
#endif
397
#if SDL_VIDEO_DRIVER_PHOTON
398
399
extern VideoBootStrap ph_bootstrap;
#endif
400
#if SDL_VIDEO_DRIVER_EPOC
401
402
extern VideoBootStrap EPOC_bootstrap;
#endif
403
#if SDL_VIDEO_DRIVER_XBIOS
404
405
extern VideoBootStrap XBIOS_bootstrap;
#endif
406
#if SDL_VIDEO_DRIVER_GEM
407
408
extern VideoBootStrap GEM_bootstrap;
#endif
409
#if SDL_VIDEO_DRIVER_PICOGUI
410
411
extern VideoBootStrap PG_bootstrap;
#endif
412
#if SDL_VIDEO_DRIVER_DC
413
414
extern VideoBootStrap DC_bootstrap;
#endif
415
#if SDL_VIDEO_DRIVER_RISCOS
416
417
extern VideoBootStrap RISCOS_bootstrap;
#endif
418
#if SDL_VIDEO_DRIVER_OS2FS
419
420
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
421
422
423
424
425
426
#if SDL_VIDEO_DRIVER_AALIB
extern VideoBootStrap AALIB_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
427
428
429
#if SDL_VIDEO_DRIVER_GLSDL
extern VideoBootStrap glSDL_bootstrap;
#endif
431
432
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
#define SDL_CurrentWindow (SDL_CurrentDisplay.windows[0])
434
extern SDL_VideoDevice *SDL_GetVideoDevice();
435
436
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
437
438
439
440
extern void SDL_AddDisplayMode(int displayIndex,
const SDL_DisplayMode * mode);
extern void SDL_AddRenderDriver(int displayIndex,
const SDL_RenderDriver * driver);
441
442
#endif /* _SDL_sysvideo_h */
443
444
/* vi: set ts=4 sw=4 expandtab: */