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
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
#include "SDL_mouse.h"
28
#include "SDL_keysym.h"
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/* 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 */
48
49
50
51
int modMode; /**< The texture modulation mode */
int blendMode; /**< The texture blend mode */
int scaleMode; /**< The texture scale mode */
Uint8 r, g, b, a; /**< Texture modulation values */
52
53
54
55
56
57
58
59
60
61
62
SDL_Renderer *renderer;
void *driverdata; /**< Driver specific texture representation */
SDL_Texture *next;
};
/* Define the SDL renderer structure */
struct SDL_Renderer
{
63
int (*ActivateRenderer) (SDL_Renderer * renderer);
64
int (*DisplayModeChanged) (SDL_Renderer * renderer);
65
66
67
68
69
70
71
72
73
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);
74
75
76
77
78
79
80
81
int (*SetTextureColorMod) (SDL_Renderer * renderer,
SDL_Texture * texture);
int (*SetTextureAlphaMod) (SDL_Renderer * renderer,
SDL_Texture * texture);
int (*SetTextureBlendMode) (SDL_Renderer * renderer,
SDL_Texture * texture);
int (*SetTextureScaleMode) (SDL_Renderer * renderer,
SDL_Texture * texture);
82
83
84
85
86
87
88
89
90
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);
91
92
int (*RenderFill) (SDL_Renderer * renderer, Uint8 r, Uint8 g, Uint8 b,
Uint8 a, const SDL_Rect * rect);
93
int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
94
const SDL_Rect * srcrect, const SDL_Rect * dstrect);
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
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;
130
SDL_GLContext context;
131
132
133
134
135
136
137
138
139
140
141
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.
142
*/
143
144
145
146
147
148
149
struct SDL_VideoDisplay
{
int max_display_modes;
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
150
SDL_DisplayMode fullscreen_mode;
151
SDL_Palette *palette;
153
154
Uint16 *gamma;
Uint16 *saved_gamma; /* (just offset into gamma) */
156
157
int num_render_drivers;
SDL_RenderDriver *render_drivers;
159
160
int num_windows;
SDL_Window *windows;
162
SDL_Renderer *current_renderer;
164
165
/* The hash list of textures */
SDL_Texture *textures[64];
167
SDL_VideoDevice *device;
169
170
void *driverdata;
};
172
173
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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);
189
190
191
192
193
/* Reverse the effects VideoInit() -- called if VideoInit() fails
or if the application is shutting down the video subsystem.
*/
void (*VideoQuit) (_THIS);
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
/* * * */
/* 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);
/* * * */
244
245
/* OpenGL support
*/
246
247
int (*GL_LoadLibrary) (_THIS, const char *path);
void *(*GL_GetProcAddress) (_THIS, const char *proc);
248
249
250
251
252
253
SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
int (*GL_SetSwapInterval) (_THIS, int interval);
int (*GL_GetSwapInterval) (_THIS);
void (*GL_SwapWindow) (_THIS, SDL_Window * window);
void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
254
255
/* * * */
256
257
/* Event manager functions
*/
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
void (*PumpEvents) (_THIS);
/* * * */
/* Data common to all drivers */
int num_displays;
SDL_VideoDisplay *displays;
int current_display;
Uint32 next_object_id;
/* * * */
/* 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;
287
int retained_backing;
288
289
290
291
292
293
294
295
int driver_loaded;
char driver_path[256];
void *dll_handle;
} gl_config;
/* * * */
/* Data private to this driver */
void *driverdata;
296
struct SDL_GLDriverData *gl_data;
297
298
299
300
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
301
302
};
303
304
305
306
307
308
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
309
310
} VideoBootStrap;
311
312
#if SDL_VIDEO_DRIVER_COCOA
extern VideoBootStrap COCOA_bootstrap;
313
314
#endif
#if SDL_VIDEO_DRIVER_X11
315
316
extern VideoBootStrap X11_bootstrap;
#endif
317
#if SDL_VIDEO_DRIVER_NANOX
318
319
extern VideoBootStrap NX_bootstrap;
#endif
320
#if SDL_VIDEO_DRIVER_IPOD
321
322
extern VideoBootStrap iPod_bootstrap;
#endif
323
324
325
326
#if SDL_VIDEO_DRIVER_WSCONS
extern VideoBootStrap WSCONS_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_FBCON
327
328
extern VideoBootStrap FBCON_bootstrap;
#endif
329
#if SDL_VIDEO_DRIVER_DIRECTFB
330
331
extern VideoBootStrap DirectFB_bootstrap;
#endif
332
#if SDL_VIDEO_DRIVER_PS2GS
333
334
extern VideoBootStrap PS2GS_bootstrap;
#endif
335
#if SDL_VIDEO_DRIVER_VGL
336
337
extern VideoBootStrap VGL_bootstrap;
#endif
338
#if SDL_VIDEO_DRIVER_SVGALIB
339
340
extern VideoBootStrap SVGALIB_bootstrap;
#endif
341
#if SDL_VIDEO_DRIVER_GAPI
342
343
extern VideoBootStrap GAPI_bootstrap;
#endif
344
345
#if SDL_VIDEO_DRIVER_WIN32
extern VideoBootStrap WIN32_bootstrap;
346
#endif
347
#if SDL_VIDEO_DRIVER_BWINDOW
348
349
extern VideoBootStrap BWINDOW_bootstrap;
#endif
350
#if SDL_VIDEO_DRIVER_PHOTON
351
352
extern VideoBootStrap ph_bootstrap;
#endif
353
#if SDL_VIDEO_DRIVER_EPOC
354
355
extern VideoBootStrap EPOC_bootstrap;
#endif
356
#if SDL_VIDEO_DRIVER_XBIOS
357
358
extern VideoBootStrap XBIOS_bootstrap;
#endif
359
#if SDL_VIDEO_DRIVER_GEM
360
361
extern VideoBootStrap GEM_bootstrap;
#endif
362
#if SDL_VIDEO_DRIVER_DC
363
364
extern VideoBootStrap DC_bootstrap;
#endif
365
#if SDL_VIDEO_DRIVER_RISCOS
366
367
extern VideoBootStrap RISCOS_bootstrap;
#endif
368
#if SDL_VIDEO_DRIVER_OS2FS
369
370
extern VideoBootStrap OS2FSLib_bootstrap;
#endif
371
372
373
#if SDL_VIDEO_DRIVER_UIKIT
extern VideoBootStrap UIKIT_bootstrap;
#endif
374
375
376
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
377
378
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
380
381
382
383
384
385
386
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);
388
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
389
390
391
392
393
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);
394
extern void SDL_OnWindowResized(SDL_Window * window);
395
396
397
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
extern SDL_WindowID SDL_GetFocusWindow(void);
398
399
#endif /* _SDL_sysvideo_h */
400
401
/* vi: set ts=4 sw=4 expandtab: */