This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_sysvideo.h
351 lines (294 loc) · 10.3 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 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
#ifndef _SDL_sysvideo_h
#define _SDL_sysvideo_h
27
#include "SDL_shape.h"
28
29
30
/* The SDL video driver */
31
32
typedef struct SDL_WindowShaper SDL_WindowShaper;
typedef struct SDL_ShapeDriver SDL_ShapeDriver;
33
34
35
typedef struct SDL_VideoDisplay SDL_VideoDisplay;
typedef struct SDL_VideoDevice SDL_VideoDevice;
36
37
38
39
40
41
/* Define the SDL window-shaper structure */
struct SDL_WindowShaper
{
/* The window associated with the shaper */
SDL_Window *window;
42
43
/* The user's specified coordinates for the window, for once we give it a shape. */
Uint32 userx,usery;
44
45
46
/* The parameters for shape calculation. */
SDL_WindowShapeMode mode;
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);
58
int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
59
60
61
int (*ResizeWindowShape)(SDL_Window *window);
};
62
63
64
65
66
67
68
typedef struct SDL_WindowUserData
{
char *name;
void *data;
struct SDL_WindowUserData *next;
} SDL_WindowUserData;
69
/* Define the SDL window structure, corresponding to toplevel windows */
70
71
struct SDL_Window
{
72
const void *magic;
73
74
75
76
77
Uint32 id;
char *title;
int x, y;
int w, h;
Uint32 flags;
78
79
SDL_VideoDisplay *display;
80
81
SDL_DisplayMode fullscreen_mode;
82
83
SDL_Surface *surface;
84
SDL_bool surface_valid;
85
86
SDL_WindowShaper *shaper;
87
88
89
SDL_WindowUserData *data;
90
void *driverdata;
91
92
93
SDL_Window *prev;
SDL_Window *next;
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))
100
101
102
/*
* Define the SDL display structure This corresponds to physical monitors
* attached to the system.
103
*/
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;
111
SDL_bool updating_fullscreen;
112
113
SDL_Window *windows;
114
SDL_Window *fullscreen_window;
115
116
SDL_VideoDevice *device;
117
118
void *driverdata;
119
};
120
121
122
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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
*/
150
151
152
153
154
/*
* Get the bounds of a display
*/
int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
155
156
157
158
/*
* Get a list of the available display modes. e.g.
* SDL_AddDisplayMode(_this->current_display, mode)
*/
159
void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
160
161
162
163
164
165
166
/*
* 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.
*/
167
int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
168
169
170
171
172
173
174
175
/* * * */
/*
* Window functions
*/
int (*CreateWindow) (_THIS, SDL_Window * window);
int (*CreateWindowFrom) (_THIS, SDL_Window * window, const void *data);
void (*SetWindowTitle) (_THIS, SDL_Window * window);
176
void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
177
178
179
180
181
182
183
184
185
186
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);
187
188
189
190
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);
191
192
193
194
195
/* * * */
/*
* Shaped-window functions
*/
SDL_ShapeDriver shape_driver;
196
197
198
199
200
201
202
203
204
205
206
/* 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);
207
void (*GL_UnloadLibrary) (_THIS);
208
209
210
211
212
213
214
215
216
217
218
219
220
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);
221
222
223
/* Suspend the screensaver */
void (*SuspendScreenSaver) (_THIS);
224
225
226
227
228
/* Text input */
void (*StartTextInput) (_THIS);
void (*StopTextInput) (_THIS);
void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
229
230
231
232
233
/* Clipboard */
int (*SetClipboardText) (_THIS, const char *text);
char * (*GetClipboardText) (_THIS);
SDL_bool (*HasClipboardText) (_THIS);
234
235
/* * * */
/* Data common to all drivers */
236
SDL_bool suspend_screensaver;
237
238
239
int num_displays;
SDL_VideoDisplay *displays;
int current_display;
240
Uint8 window_magic;
241
Uint32 next_object_id;
242
char * clipboard_text;
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/* * * */
/* 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;
264
265
int major_version;
int minor_version;
266
267
268
269
270
271
272
273
274
275
276
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;
277
278
279
280
#if SDL_VIDEO_DRIVER_PANDORA
struct SDL_PrivateGLESData *gles_data;
#endif
281
282
283
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
284
285
};
286
287
288
289
290
291
292
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
int (*available) (void);
SDL_VideoDevice *(*create) (int devindex);
} VideoBootStrap;
293
294
295
#if SDL_VIDEO_DRIVER_COCOA
extern VideoBootStrap COCOA_bootstrap;
296
297
#endif
#if SDL_VIDEO_DRIVER_X11
298
299
extern VideoBootStrap X11_bootstrap;
#endif
300
#if SDL_VIDEO_DRIVER_DIRECTFB
301
302
extern VideoBootStrap DirectFB_bootstrap;
#endif
303
304
#if SDL_VIDEO_DRIVER_WINDOWS
extern VideoBootStrap WINDOWS_bootstrap;
305
#endif
306
#if SDL_VIDEO_DRIVER_BWINDOW
307
308
extern VideoBootStrap BWINDOW_bootstrap;
#endif
309
310
#if SDL_VIDEO_DRIVER_PANDORA
extern VideoBootStrap PND_bootstrap;
311
#endif
312
313
#if SDL_VIDEO_DRIVER_NDS
extern VideoBootStrap NDS_bootstrap;
314
#endif
315
316
#if SDL_VIDEO_DRIVER_UIKIT
extern VideoBootStrap UIKIT_bootstrap;
317
#endif
318
319
320
#if SDL_VIDEO_DRIVER_ANDROID
extern VideoBootStrap Android_bootstrap;
#endif
321
322
323
#if SDL_VIDEO_DRIVER_DUMMY
extern VideoBootStrap DUMMY_bootstrap;
#endif
324
325
#define SDL_CurrentDisplay (&_this->displays[_this->current_display])
326
327
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
328
329
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
330
331
332
333
334
335
336
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);
337
338
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
339
340
341
extern void SDL_OnWindowShown(SDL_Window * window);
extern void SDL_OnWindowHidden(SDL_Window * window);
342
extern void SDL_OnWindowResized(SDL_Window * window);
343
344
extern void SDL_OnWindowMinimized(SDL_Window * window);
extern void SDL_OnWindowRestored(SDL_Window * window);
345
346
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
347
extern SDL_Window * SDL_GetFocusWindow(void);
348
349
#endif /* _SDL_sysvideo_h */
350
351
/* vi: set ts=4 sw=4 expandtab: */