Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
362 lines (302 loc) · 10.9 KB

SDL_sysvideo.h

File metadata and controls

362 lines (302 loc) · 10.9 KB
 
Apr 26, 2001
Apr 26, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Jan 24, 2010
Jan 24, 2010
3
Copyright (C) 1997-2010 Sam Lantinga
Apr 26, 2001
Apr 26, 2001
4
5
This library is free software; you can redistribute it and/or
Feb 1, 2006
Feb 1, 2006
6
modify it under the terms of the GNU Lesser General Public
Apr 26, 2001
Apr 26, 2001
7
License as published by the Free Software Foundation; either
Feb 1, 2006
Feb 1, 2006
8
version 2.1 of the License, or (at your option) any later version.
Apr 26, 2001
Apr 26, 2001
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
Feb 1, 2006
Feb 1, 2006
13
Lesser General Public License for more details.
Apr 26, 2001
Apr 26, 2001
14
Feb 1, 2006
Feb 1, 2006
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
Apr 26, 2001
Apr 26, 2001
18
19
Sam Lantinga
Dec 14, 2001
Dec 14, 2001
20
slouken@libsdl.org
Apr 26, 2001
Apr 26, 2001
21
*/
Feb 21, 2006
Feb 21, 2006
22
#include "SDL_config.h"
Apr 26, 2001
Apr 26, 2001
23
24
25
26
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
Jun 30, 2010
Jun 30, 2010
27
#include "SDL_shape.h"
Apr 26, 2001
Apr 26, 2001
28
Jul 10, 2006
Jul 10, 2006
29
30
/* The SDL video driver */
Jun 30, 2010
Jun 30, 2010
31
32
typedef struct SDL_WindowShaper SDL_WindowShaper;
typedef struct SDL_ShapeDriver SDL_ShapeDriver;
Jul 10, 2006
Jul 10, 2006
33
34
35
typedef struct SDL_VideoDisplay SDL_VideoDisplay;
typedef struct SDL_VideoDevice SDL_VideoDevice;
Jun 30, 2010
Jun 30, 2010
36
37
38
39
40
41
/* Define the SDL window-shaper structure */
struct SDL_WindowShaper
{
/* The window associated with the shaper */
SDL_Window *window;
Aug 15, 2010
Aug 15, 2010
42
43
/* The user's specified coordinates for the window, for once we give it a shape. */
Uint32 userx,usery;
Jun 30, 2010
Jun 30, 2010
44
Jul 23, 2010
Jul 23, 2010
45
46
/* The parameters for shape calculation. */
SDL_WindowShapeMode mode;
Jun 30, 2010
Jun 30, 2010
47
48
49
50
51
52
53
54
55
56
57
/* Has this window been assigned a shape? */
SDL_bool hasshape;
void *driverdata;
};
/* Define the SDL shape driver structure */
struct SDL_ShapeDriver
{
SDL_WindowShaper *(*CreateShaper)(SDL_Window * window);
Aug 14, 2010
Aug 14, 2010
58
int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
Jun 30, 2010
Jun 30, 2010
59
60
61
int (*ResizeWindowShape)(SDL_Window *window);
};
Feb 3, 2011
Feb 3, 2011
62
63
64
65
66
67
68
typedef struct SDL_WindowUserData
{
char *name;
void *data;
struct SDL_WindowUserData *next;
} SDL_WindowUserData;
Jul 10, 2006
Jul 10, 2006
69
/* Define the SDL window structure, corresponding to toplevel windows */
Sep 15, 2008
Sep 15, 2008
70
71
struct SDL_Window
{
Jan 24, 2010
Jan 24, 2010
72
const void *magic;
Sep 15, 2008
Sep 15, 2008
73
74
75
76
77
Uint32 id;
char *title;
int x, y;
int w, h;
Uint32 flags;
Jul 10, 2006
Jul 10, 2006
78
Jan 21, 2010
Jan 21, 2010
79
SDL_VideoDisplay *display;
Jul 10, 2006
Jul 10, 2006
80
Dec 1, 2009
Dec 1, 2009
81
SDL_DisplayMode fullscreen_mode;
Jun 30, 2010
Jun 30, 2010
82
Feb 3, 2011
Feb 3, 2011
83
SDL_Surface *surface;
Feb 4, 2011
Feb 4, 2011
84
SDL_bool surface_valid;
Feb 3, 2011
Feb 3, 2011
85
Jun 30, 2010
Jun 30, 2010
86
SDL_WindowShaper *shaper;
Dec 1, 2009
Dec 1, 2009
87
Feb 3, 2011
Feb 3, 2011
88
89
SDL_WindowUserData *data;
Sep 15, 2008
Sep 15, 2008
90
void *driverdata;
Jan 21, 2010
Jan 21, 2010
91
92
93
SDL_Window *prev;
SDL_Window *next;
Jul 10, 2006
Jul 10, 2006
94
95
96
97
98
99
};
#define FULLSCREEN_VISIBLE(W) \
(((W)->flags & SDL_WINDOW_FULLSCREEN) && \
((W)->flags & SDL_WINDOW_SHOWN) && \
!((W)->flags & SDL_WINDOW_MINIMIZED))
Sep 2, 2008
Sep 2, 2008
100
101
102
/*
* Define the SDL display structure This corresponds to physical monitors
* attached to the system.
Apr 26, 2001
Apr 26, 2001
103
*/
Sep 15, 2008
Sep 15, 2008
104
105
106
107
108
109
110
struct SDL_VideoDisplay
{
int max_display_modes;
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
Dec 1, 2009
Dec 1, 2009
111
SDL_bool updating_fullscreen;
Apr 26, 2001
Apr 26, 2001
112
Sep 15, 2008
Sep 15, 2008
113
114
Uint16 *gamma;
Uint16 *saved_gamma; /* (just offset into gamma) */
Apr 26, 2001
Apr 26, 2001
115
Sep 15, 2008
Sep 15, 2008
116
SDL_Window *windows;
Dec 3, 2009
Dec 3, 2009
117
SDL_Window *fullscreen_window;
Apr 26, 2001
Apr 26, 2001
118
Sep 15, 2008
Sep 15, 2008
119
SDL_VideoDevice *device;
Apr 26, 2001
Apr 26, 2001
120
Sep 15, 2008
Sep 15, 2008
121
void *driverdata;
Jul 10, 2006
Jul 10, 2006
122
};
Apr 26, 2001
Apr 26, 2001
123
Jul 10, 2006
Jul 10, 2006
124
125
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
Apr 26, 2001
Apr 26, 2001
126
Sep 15, 2008
Sep 15, 2008
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
*/
Dec 6, 2009
Dec 6, 2009
153
154
155
156
157
/*
* Get the bounds of a display
*/
int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
Sep 15, 2008
Sep 15, 2008
158
159
160
161
/*
* Get a list of the available display modes. e.g.
* SDL_AddDisplayMode(_this->current_display, mode)
*/
Dec 1, 2009
Dec 1, 2009
162
void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
Sep 15, 2008
Sep 15, 2008
163
164
165
166
167
168
169
/*
* 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.
*/
Dec 1, 2009
Dec 1, 2009
170
int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
Sep 15, 2008
Sep 15, 2008
171
172
/* Set the gamma ramp */
Dec 1, 2009
Dec 1, 2009
173
int (*SetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
Sep 15, 2008
Sep 15, 2008
174
175
/* Get the gamma ramp */
Dec 1, 2009
Dec 1, 2009
176
int (*GetDisplayGammaRamp) (_THIS, SDL_VideoDisplay * display, Uint16 * ramp);
Sep 15, 2008
Sep 15, 2008
177
178
179
180
181
182
183
184
/* * * */
/*
* Window functions
*/
int (*CreateWindow) (_THIS, SDL_Window * window);
int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
void (*SetWindowTitle) (_THIS, SDL_Window * window);
Jan 2, 2009
Jan 2, 2009
185
void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
Sep 15, 2008
Sep 15, 2008
186
187
188
189
190
191
192
193
194
195
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);
Feb 3, 2011
Feb 3, 2011
196
197
198
199
int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);
int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, int numrects, SDL_Rect * rects);
void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);
Jun 30, 2010
Jun 30, 2010
200
201
202
203
204
/* * * */
/*
* Shaped-window functions
*/
SDL_ShapeDriver shape_driver;
Sep 15, 2008
Sep 15, 2008
205
206
207
208
209
210
211
212
213
214
215
/* 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);
Feb 9, 2009
Feb 9, 2009
216
void (*GL_UnloadLibrary) (_THIS);
Sep 15, 2008
Sep 15, 2008
217
218
219
220
221
222
223
224
225
226
227
228
229
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);
Jan 12, 2009
Jan 12, 2009
230
231
232
/* Suspend the screensaver */
void (*SuspendScreenSaver) (_THIS);
Sep 19, 2009
Sep 19, 2009
233
234
235
236
237
/* Text input */
void (*StartTextInput) (_THIS);
void (*StopTextInput) (_THIS);
void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
Jul 8, 2010
Jul 8, 2010
238
239
240
241
242
/* Clipboard */
int (*SetClipboardText) (_THIS, const char *text);
char * (*GetClipboardText) (_THIS);
SDL_bool (*HasClipboardText) (_THIS);
Sep 15, 2008
Sep 15, 2008
243
244
/* * * */
/* Data common to all drivers */
Jan 12, 2009
Jan 12, 2009
245
SDL_bool suspend_screensaver;
Sep 15, 2008
Sep 15, 2008
246
247
248
int num_displays;
SDL_VideoDisplay *displays;
int current_display;
Jan 24, 2010
Jan 24, 2010
249
Uint8 window_magic;
Sep 15, 2008
Sep 15, 2008
250
Uint32 next_object_id;
Jul 8, 2010
Jul 8, 2010
251
char * clipboard_text;
Sep 15, 2008
Sep 15, 2008
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/* * * */
/* 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;
Mar 24, 2009
Mar 24, 2009
273
274
int major_version;
int minor_version;
Sep 15, 2008
Sep 15, 2008
275
276
277
278
279
280
281
282
283
284
285
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;
May 31, 2009
May 31, 2009
286
287
288
289
#if SDL_VIDEO_DRIVER_PANDORA
struct SDL_PrivateGLESData *gles_data;
#endif
Sep 15, 2008
Sep 15, 2008
290
291
292
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
Apr 26, 2001
Apr 26, 2001
293
294
};
Sep 15, 2008
Sep 15, 2008
295
296
297
298
299
300
301
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
} VideoBootStrap;
Apr 26, 2001
Apr 26, 2001
302
Jul 23, 2006
Jul 23, 2006
303
304
#if SDL_VIDEO_DRIVER_COCOA
extern VideoBootStrap COCOA_bootstrap;
Feb 16, 2006
Feb 16, 2006
305
306
#endif
#if SDL_VIDEO_DRIVER_X11
Apr 26, 2001
Apr 26, 2001
307
308
extern VideoBootStrap X11_bootstrap;
#endif
Feb 16, 2006
Feb 16, 2006
309
#if SDL_VIDEO_DRIVER_DIRECTFB
Sep 4, 2001
Sep 4, 2001
310
311
extern VideoBootStrap DirectFB_bootstrap;
#endif
Jan 21, 2011
Jan 21, 2011
312
313
#if SDL_VIDEO_DRIVER_WINDOWS
extern VideoBootStrap WINDOWS_bootstrap;
Apr 26, 2001
Apr 26, 2001
314
#endif
Feb 16, 2006
Feb 16, 2006
315
#if SDL_VIDEO_DRIVER_BWINDOW
Apr 26, 2001
Apr 26, 2001
316
317
extern VideoBootStrap BWINDOW_bootstrap;
#endif
Feb 2, 2011
Feb 2, 2011
318
319
#if SDL_VIDEO_DRIVER_PANDORA
extern VideoBootStrap PND_bootstrap;
Feb 16, 2006
Feb 16, 2006
320
#endif
Aug 27, 2008
Aug 27, 2008
321
322
#if SDL_VIDEO_DRIVER_NDS
extern VideoBootStrap NDS_bootstrap;
May 31, 2009
May 31, 2009
323
#endif
Feb 2, 2011
Feb 2, 2011
324
325
#if SDL_VIDEO_DRIVER_UIKIT
extern VideoBootStrap UIKIT_bootstrap;
Aug 27, 2008
Aug 27, 2008
326
#endif
Jun 10, 2010
Jun 10, 2010
327
328
329
#if SDL_VIDEO_DRIVER_ANDROID
extern VideoBootStrap Android_bootstrap;
#endif
Feb 2, 2011
Feb 2, 2011
330
331
332
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
Jul 10, 2006
Jul 10, 2006
333
Jan 21, 2010
Jan 21, 2010
334
#define SDL_CurrentDisplay (&_this->displays[_this->current_display])
Feb 16, 2006
Feb 16, 2006
335
Jun 26, 2010
Jun 26, 2010
336
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
Sep 15, 2008
Sep 15, 2008
337
338
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
Dec 1, 2009
Dec 1, 2009
339
340
341
342
343
344
345
346
347
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);
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);
Sep 15, 2008
Sep 15, 2008
348
349
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
Jul 10, 2006
Jul 10, 2006
350
Sep 15, 2008
Sep 15, 2008
351
352
extern void SDL_OnWindowShown(SDL_Window * window);
extern void SDL_OnWindowHidden(SDL_Window * window);
Feb 3, 2011
Feb 3, 2011
353
extern void SDL_OnWindowResized(SDL_Window * window);
Dec 1, 2009
Dec 1, 2009
354
355
extern void SDL_OnWindowMinimized(SDL_Window * window);
extern void SDL_OnWindowRestored(SDL_Window * window);
Sep 15, 2008
Sep 15, 2008
356
357
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
Jan 21, 2010
Jan 21, 2010
358
extern SDL_Window * SDL_GetFocusWindow(void);
Apr 26, 2001
Apr 26, 2001
359
Sep 15, 2008
Sep 15, 2008
360
#endif /* _SDL_sysvideo_h */
Jul 10, 2006
Jul 10, 2006
361
362
/* vi: set ts=4 sw=4 expandtab: */