This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_sysvideo.h
439 lines (374 loc) · 14.8 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 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
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
#include "SDL_mouse.h"
28
#include "SDL_keysym.h"
29
30
31
32
33
34
35
36
37
38
39
/* 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 */
40
41
42
struct SDL_Texture
{
Uint32 id;
43
44
45
46
47
48
49
50
51
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 */
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
SDL_Renderer *renderer;
54
55
void *driverdata; /**< Driver specific texture representation */
56
57
SDL_Texture *next;
58
59
60
};
/* Define the SDL renderer structure */
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
struct SDL_Renderer
{
int (*ActivateRenderer) (SDL_Renderer * renderer);
int (*DisplayModeChanged) (SDL_Renderer * 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 (*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);
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 (*SetDrawColor) (SDL_Renderer * renderer);
int (*SetDrawBlendMode) (SDL_Renderer * renderer);
93
int (*RenderPoint) (SDL_Renderer * renderer, int x, int y);
94
95
96
int (*RenderLine) (SDL_Renderer * renderer, int x1, int y1, int x2,
int y2);
int (*RenderFill) (SDL_Renderer * renderer, const SDL_Rect * rect);
97
98
int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
const SDL_Rect * srcrect, const SDL_Rect * dstrect);
99
int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
100
Uint32 format, void * pixels, int pitch);
101
int (*RenderWritePixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
102
Uint32 format, const void * pixels, int pitch);
103
104
105
106
107
108
109
110
111
112
113
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;
114
115
116
Uint8 r, g, b, a; /**< Color for drawing operations values */
int blendMode; /**< The drawing blend mode */
117
void *driverdata;
118
119
120
};
/* Define the SDL render driver structure */
121
122
123
struct SDL_RenderDriver
{
SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
124
125
126
/* Info about the renderer capabilities */
SDL_RendererInfo info;
127
128
129
};
/* Define the SDL window structure, corresponding to toplevel windows */
130
131
132
struct SDL_Window
{
Uint32 id;
133
134
135
136
137
char *title;
int x, y;
int w, h;
Uint32 flags;
138
139
140
int display;
SDL_Renderer *renderer;
141
142
143
SDL_DisplayMode fullscreen_mode;
144
145
void *userdata;
void *driverdata;
146
147
148
149
150
151
};
#define FULLSCREEN_VISIBLE(W) \
(((W)->flags & SDL_WINDOW_FULLSCREEN) && \
((W)->flags & SDL_WINDOW_SHOWN) && \
!((W)->flags & SDL_WINDOW_MINIMIZED))
152
153
154
/*
* Define the SDL display structure This corresponds to physical monitors
* attached to the system.
155
*/
156
157
158
159
160
161
162
struct SDL_VideoDisplay
{
int max_display_modes;
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
163
SDL_bool updating_fullscreen;
164
SDL_Palette *palette;
165
166
167
Uint16 *gamma;
Uint16 *saved_gamma; /* (just offset into gamma) */
168
169
170
int num_render_drivers;
SDL_RenderDriver *render_drivers;
171
172
173
int num_windows;
SDL_Window *windows;
174
SDL_Window *fullscreen_window;
175
176
SDL_Renderer *current_renderer;
177
178
179
/* The hash list of textures */
SDL_Texture *textures[64];
180
181
SDL_VideoDevice *device;
182
183
void *driverdata;
184
};
185
186
187
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
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
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);
/*
* Reverse the effects VideoInit() -- called if VideoInit() fails or
* if the application is shutting down the video subsystem.
*/
void (*VideoQuit) (_THIS);
/* * * */
/*
* Display functions
*/
/*
* Get a list of the available display modes. e.g.
* SDL_AddDisplayMode(_this->current_display, mode)
*/
219
void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
220
221
222
223
224
225
226
/*
* 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.
*/
227
int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
228
229
/* Set the color entries of the display palette */
230
int (*SetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
231
232
/* Get the color entries of the display palette */
233
int (*GetDisplayPalette) (_THIS, SDL_VideoDisplay * display, SDL_Palette * palette);
234
235
/* Set the gamma ramp */
236
int (*SetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
237
238
/* Get the gamma ramp */
239
int (*GetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
240
241
242
243
244
245
246
247
/* * * */
/*
* Window functions
*/
int (*CreateWindow) (_THIS, SDL_Window * window);
int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
void (*SetWindowTitle) (_THIS, SDL_Window * window);
248
void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
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);
/* * * */
/*
* OpenGL support
*/
int (*GL_LoadLibrary) (_THIS, const char *path);
void *(*GL_GetProcAddress) (_THIS, const char *proc);
270
void (*GL_UnloadLibrary) (_THIS);
271
272
273
274
275
276
277
278
279
280
281
282
283
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);
/* * * */
/*
* Event manager functions
*/
void (*PumpEvents) (_THIS);
284
285
286
/* Suspend the screensaver */
void (*SuspendScreenSaver) (_THIS);
287
288
289
290
291
/* Text input */
void (*StartTextInput) (_THIS);
void (*StopTextInput) (_THIS);
void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
292
293
/* * * */
/* Data common to all drivers */
294
SDL_bool suspend_screensaver;
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
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;
320
321
int major_version;
int minor_version;
322
323
324
325
326
327
328
329
330
331
332
int retained_backing;
int driver_loaded;
char driver_path[256];
void *dll_handle;
} gl_config;
/* * * */
/* Data private to this driver */
void *driverdata;
struct SDL_GLDriverData *gl_data;
333
334
335
336
#if SDL_VIDEO_DRIVER_PANDORA
struct SDL_PrivateGLESData *gles_data;
#endif
337
338
339
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
340
341
};
342
343
344
345
346
347
348
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
} VideoBootStrap;
349
350
351
#if SDL_VIDEO_DRIVER_COCOA
extern VideoBootStrap COCOA_bootstrap;
352
353
#endif
#if SDL_VIDEO_DRIVER_X11
354
355
extern VideoBootStrap X11_bootstrap;
#endif
356
#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
366
#if SDL_VIDEO_DRIVER_PS3
extern VideoBootStrap PS3_bootstrap;
367
#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
375
#if SDL_VIDEO_DRIVER_WIN32
extern VideoBootStrap WIN32_bootstrap;
376
#endif
377
#if SDL_VIDEO_DRIVER_BWINDOW
378
379
extern VideoBootStrap BWINDOW_bootstrap;
#endif
380
#if SDL_VIDEO_DRIVER_PHOTON
381
382
383
384
extern VideoBootStrap photon_bootstrap;
#endif
#if SDL_VIDEO_DRIVER_QNXGF
extern VideoBootStrap qnxgf_bootstrap;
385
#endif
386
#if SDL_VIDEO_DRIVER_EPOC
387
388
extern VideoBootStrap EPOC_bootstrap;
#endif
389
#if SDL_VIDEO_DRIVER_RISCOS
390
391
extern VideoBootStrap RISCOS_bootstrap;
#endif
392
393
394
#if SDL_VIDEO_DRIVER_UIKIT
extern VideoBootStrap UIKIT_bootstrap;
#endif
395
396
397
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
398
399
#if SDL_VIDEO_DRIVER_NDS
extern VideoBootStrap NDS_bootstrap;
400
401
402
#endif
#if SDL_VIDEO_DRIVER_PANDORA
extern VideoBootStrap PND_bootstrap;
403
#endif
404
405
#define SDL_CurrentDisplay (_this->displays[_this->current_display])
406
#define SDL_CurrentRenderer (SDL_CurrentDisplay.current_renderer)
407
408
extern SDL_VideoDevice *SDL_GetVideoDevice();
409
410
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
411
412
413
414
415
416
417
extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
extern int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay * display);
extern int SDL_GetDisplayModeForDisplay(SDL_VideoDisplay * display, int index, SDL_DisplayMode * mode);
extern int SDL_GetDesktopDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
extern int SDL_GetCurrentDisplayModeForDisplay(SDL_VideoDisplay * display, SDL_DisplayMode * mode);
extern SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
extern int SDL_SetDisplayModeForDisplay(SDL_VideoDisplay * display, const SDL_DisplayMode * mode);
418
419
extern int SDL_SetPaletteForDisplay(SDL_VideoDisplay * display, const SDL_Color * colors, int firstcolor, int ncolors);
extern int SDL_GetPaletteForDisplay(SDL_VideoDisplay * display, SDL_Color * colors, int firstcolor, int ncolors);
420
421
extern int SDL_SetGammaRampForDisplay(SDL_VideoDisplay * display, const Uint16 * red, const Uint16 * green, const Uint16 * blue);
extern int SDL_GetGammaRampForDisplay(SDL_VideoDisplay * display, Uint16 * red, Uint16 * green, Uint16 * blue);
422
extern void SDL_AddRenderDriver(SDL_VideoDisplay *display, const SDL_RenderDriver * driver);
423
424
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
425
426
427
extern SDL_Window *SDL_GetWindowFromID(SDL_WindowID windowID);
extern SDL_VideoDisplay *SDL_GetDisplayFromWindow(SDL_Window * window);
428
429
430
extern void SDL_OnWindowShown(SDL_Window * window);
extern void SDL_OnWindowHidden(SDL_Window * window);
extern void SDL_OnWindowResized(SDL_Window * window);
431
432
extern void SDL_OnWindowMinimized(SDL_Window * window);
extern void SDL_OnWindowRestored(SDL_Window * window);
433
434
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
435
extern SDL_WindowID SDL_GetFocusWindow(void);
436
437
#endif /* _SDL_sysvideo_h */
438
439
/* vi: set ts=4 sw=4 expandtab: */