Skip to content

Latest commit

 

History

History
475 lines (397 loc) · 15.2 KB

SDL_sysvideo.h

File metadata and controls

475 lines (397 loc) · 15.2 KB
 
1
2
/*
Simple DirectMedia Layer
Jan 17, 2020
Jan 17, 2020
3
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#include "../SDL_internal.h"
Nov 21, 2016
Nov 21, 2016
23
24
#ifndef SDL_sysvideo_h_
#define SDL_sysvideo_h_
25
26
27
28
#include "SDL_messagebox.h"
#include "SDL_shape.h"
#include "SDL_thread.h"
Aug 5, 2019
Aug 5, 2019
29
#include "SDL_metal.h"
Aug 28, 2017
Aug 28, 2017
30
31
#include "SDL_vulkan_internal.h"
32
33
34
35
36
37
38
39
40
41
42
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/* The SDL video driver */
typedef struct SDL_WindowShaper SDL_WindowShaper;
typedef struct SDL_ShapeDriver SDL_ShapeDriver;
typedef struct SDL_VideoDisplay SDL_VideoDisplay;
typedef struct SDL_VideoDevice SDL_VideoDevice;
/* Define the SDL window-shaper structure */
struct SDL_WindowShaper
{
/* The window associated with the shaper */
SDL_Window *window;
/* The user's specified coordinates for the window, for once we give it a shape. */
Uint32 userx,usery;
/* The parameters for shape calculation. */
SDL_WindowShapeMode mode;
/* 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);
int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
int (*ResizeWindowShape)(SDL_Window *window);
};
typedef struct SDL_WindowUserData
{
char *name;
void *data;
struct SDL_WindowUserData *next;
} SDL_WindowUserData;
/* Define the SDL window structure, corresponding to toplevel windows */
struct SDL_Window
{
const void *magic;
Uint32 id;
char *title;
SDL_Surface *icon;
int x, y;
int w, h;
int min_w, min_h;
int max_w, max_h;
Uint32 flags;
Uint32 last_fullscreen_flags;
/* Stored position and size for windowed mode */
SDL_Rect windowed;
SDL_DisplayMode fullscreen_mode;
Jan 5, 2016
Jan 5, 2016
92
93
float opacity;
94
95
96
97
98
99
100
101
102
float brightness;
Uint16 *gamma;
Uint16 *saved_gamma; /* (just offset into gamma) */
SDL_Surface *surface;
SDL_bool surface_valid;
SDL_bool is_hiding;
SDL_bool is_destroying;
Jan 5, 2016
Jan 5, 2016
103
SDL_bool is_dropping; /* drag/drop in progress, expecting SDL_SendDropComplete(). */
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
SDL_WindowShaper *shaper;
SDL_HitTest hit_test;
void *hit_test_data;
SDL_WindowUserData *data;
void *driverdata;
SDL_Window *prev;
SDL_Window *next;
};
#define FULLSCREEN_VISIBLE(W) \
(((W)->flags & SDL_WINDOW_FULLSCREEN) && \
((W)->flags & SDL_WINDOW_SHOWN) && \
!((W)->flags & SDL_WINDOW_MINIMIZED))
/*
Aug 23, 2018
Aug 23, 2018
123
124
* Define the SDL display structure.
* This corresponds to physical monitors attached to the system.
125
126
127
128
129
130
131
132
133
*/
struct SDL_VideoDisplay
{
char *name;
int max_display_modes;
int num_display_modes;
SDL_DisplayMode *display_modes;
SDL_DisplayMode desktop_mode;
SDL_DisplayMode current_mode;
Aug 23, 2018
Aug 23, 2018
134
SDL_DisplayOrientation orientation;
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
SDL_Window *fullscreen_window;
SDL_VideoDevice *device;
void *driverdata;
};
/* Forward declaration */
struct SDL_SysWMinfo;
/* Define the SDL video driver structure */
#define _THIS SDL_VideoDevice *_this
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);
Feb 11, 2017
Feb 11, 2017
170
171
172
173
174
/*
* Reinitialize the touch devices -- called if an unknown touch ID occurs.
*/
void (*ResetTouch) (_THIS);
175
176
177
178
179
180
181
182
183
184
/* * * */
/*
* Display functions
*/
/*
* Get the bounds of a display
*/
int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
Jul 30, 2015
Jul 30, 2015
185
/*
Aug 23, 2018
Aug 23, 2018
186
* Get the usable bounds of a display (bounds minus menubar or whatever)
Jul 30, 2015
Jul 30, 2015
187
*/
Aug 23, 2018
Aug 23, 2018
188
int (*GetDisplayUsableBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
Jul 30, 2015
Jul 30, 2015
189
Jan 5, 2016
Jan 5, 2016
190
/*
Aug 23, 2018
Aug 23, 2018
191
* Get the dots/pixels-per-inch of a display
Jan 5, 2016
Jan 5, 2016
192
*/
Aug 23, 2018
Aug 23, 2018
193
int (*GetDisplayDPI) (_THIS, SDL_VideoDisplay * display, float * ddpi, float * hdpi, float * vdpi);
Jan 5, 2016
Jan 5, 2016
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
* Get a list of the available display modes for a display.
*/
void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
/*
* 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_VideoDisplay * display, SDL_DisplayMode * mode);
/* * * */
/*
* Window functions
*/
Aug 28, 2017
Aug 28, 2017
212
213
int (*CreateSDLWindow) (_THIS, SDL_Window * window);
int (*CreateSDLWindowFrom) (_THIS, SDL_Window * window, const void *data);
214
215
216
217
218
219
void (*SetWindowTitle) (_THIS, SDL_Window * window);
void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
void (*SetWindowPosition) (_THIS, SDL_Window * window);
void (*SetWindowSize) (_THIS, SDL_Window * window);
void (*SetWindowMinimumSize) (_THIS, SDL_Window * window);
void (*SetWindowMaximumSize) (_THIS, SDL_Window * window);
Jan 5, 2016
Jan 5, 2016
220
int (*GetWindowBordersSize) (_THIS, SDL_Window * window, int *top, int *left, int *bottom, int *right);
Jan 5, 2016
Jan 5, 2016
221
int (*SetWindowOpacity) (_THIS, SDL_Window * window, float opacity);
Apr 21, 2015
Apr 21, 2015
222
int (*SetWindowModalFor) (_THIS, SDL_Window * modal_window, SDL_Window * parent_window);
Jan 5, 2016
Jan 5, 2016
223
int (*SetWindowInputFocus) (_THIS, SDL_Window * window);
224
225
226
227
228
229
230
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 (*SetWindowBordered) (_THIS, SDL_Window * window, SDL_bool bordered);
Sep 30, 2016
Sep 30, 2016
231
void (*SetWindowResizable) (_THIS, SDL_Window * window, SDL_bool resizable);
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
void (*SetWindowFullscreen) (_THIS, SDL_Window * window, SDL_VideoDisplay * display, SDL_bool fullscreen);
int (*SetWindowGammaRamp) (_THIS, SDL_Window * window, const Uint16 * ramp);
int (*GetWindowGammaRamp) (_THIS, SDL_Window * window, Uint16 * ramp);
void (*SetWindowGrab) (_THIS, SDL_Window * window, SDL_bool grabbed);
void (*DestroyWindow) (_THIS, SDL_Window * window);
int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);
int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, const SDL_Rect * rects, int numrects);
void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);
void (*OnWindowEnter) (_THIS, SDL_Window * window);
/* * * */
/*
* Shaped-window functions
*/
SDL_ShapeDriver shape_driver;
/* 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);
void (*GL_UnloadLibrary) (_THIS);
SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
void (*GL_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
int (*GL_SetSwapInterval) (_THIS, int interval);
int (*GL_GetSwapInterval) (_THIS);
Dec 9, 2016
Dec 9, 2016
264
int (*GL_SwapWindow) (_THIS, SDL_Window * window);
265
void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
Sep 2, 2017
Sep 2, 2017
266
void (*GL_DefaultProfileConfig) (_THIS, int *mask, int *major, int *minor);
Aug 28, 2017
Aug 28, 2017
268
269
270
271
272
273
274
275
276
277
/* * * */
/*
* Vulkan support
*/
int (*Vulkan_LoadLibrary) (_THIS, const char *path);
void (*Vulkan_UnloadLibrary) (_THIS);
SDL_bool (*Vulkan_GetInstanceExtensions) (_THIS, SDL_Window *window, unsigned *count, const char **names);
SDL_bool (*Vulkan_CreateSurface) (_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface);
void (*Vulkan_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
Aug 5, 2019
Aug 5, 2019
278
279
280
281
282
283
/* * * */
/*
* Metal support
*/
SDL_MetalView (*Metal_CreateView) (_THIS, SDL_Window * window);
void (*Metal_DestroyView) (_THIS, SDL_MetalView view);
Apr 10, 2020
Apr 10, 2020
284
285
void *(*Metal_GetLayer) (_THIS, SDL_MetalView view);
void (*Metal_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
Aug 5, 2019
Aug 5, 2019
286
287
288
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
/* * * */
/*
* Event manager functions
*/
void (*PumpEvents) (_THIS);
/* Suspend the screensaver */
void (*SuspendScreenSaver) (_THIS);
/* Text input */
void (*StartTextInput) (_THIS);
void (*StopTextInput) (_THIS);
void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
/* Screen keyboard */
SDL_bool (*HasScreenKeyboardSupport) (_THIS);
void (*ShowScreenKeyboard) (_THIS, SDL_Window *window);
void (*HideScreenKeyboard) (_THIS, SDL_Window *window);
SDL_bool (*IsScreenKeyboardShown) (_THIS, SDL_Window *window);
/* Clipboard */
int (*SetClipboardText) (_THIS, const char *text);
char * (*GetClipboardText) (_THIS);
SDL_bool (*HasClipboardText) (_THIS);
/* MessageBox */
int (*ShowMessageBox) (_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid);
/* Hit-testing */
int (*SetWindowHitTest)(SDL_Window * window, SDL_bool enabled);
Aug 2, 2018
Aug 2, 2018
318
319
320
/* Tell window that app enabled drag'n'drop events */
void (*AcceptDragAndDrop)(SDL_Window * window, SDL_bool accept);
321
322
/* * * */
/* Data common to all drivers */
Dec 11, 2016
Dec 11, 2016
323
SDL_bool is_dummy;
324
325
326
327
328
329
330
SDL_bool suspend_screensaver;
int num_displays;
SDL_VideoDisplay *displays;
SDL_Window *windows;
SDL_Window *grabbed_window;
Uint8 window_magic;
Uint32 next_object_id;
Dec 11, 2016
Dec 11, 2016
331
char *clipboard_text;
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
/* * * */
/* 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 major_version;
int minor_version;
int flags;
int profile_mask;
int share_with_current_context;
int release_behavior;
Aug 19, 2017
Aug 19, 2017
359
int reset_notification;
360
int framebuffer_srgb_capable;
Aug 25, 2017
Aug 25, 2017
361
int no_error;
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
int retained_backing;
int driver_loaded;
char driver_path[256];
void *dll_handle;
} gl_config;
/* * * */
/* Cache current GL context; don't call the OS when it hasn't changed. */
/* We have the global pointers here so Cocoa continues to work the way
it always has, and the thread-local storage for the general case.
*/
SDL_Window *current_glwin;
SDL_GLContext current_glctx;
SDL_TLSID current_glwin_tls;
SDL_TLSID current_glctx_tls;
Apr 13, 2020
Apr 13, 2020
378
379
380
/* Flag that stores whether it's allowed to call SDL_GL_MakeCurrent()
* with a NULL window, but a non-NULL context. (Not allowed in most cases,
* except on EGL under some circumstances.) */
Apr 13, 2020
Apr 13, 2020
381
SDL_bool gl_allow_no_surface;
Apr 13, 2020
Apr 13, 2020
382
Aug 28, 2017
Aug 28, 2017
383
384
385
386
/* * * */
/* Data used by the Vulkan drivers */
struct
{
Jan 31, 2018
Jan 31, 2018
387
388
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr;
PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties;
Aug 28, 2017
Aug 28, 2017
389
390
391
392
393
int loader_loaded;
char loader_path[256];
void *loader_handle;
} vulkan_config;
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
/* * * */
/* Data private to this driver */
void *driverdata;
struct SDL_GLDriverData *gl_data;
#if SDL_VIDEO_OPENGL_EGL
struct SDL_EGL_VideoData *egl_data;
#endif
#if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
struct SDL_PrivateGLESData *gles_data;
#endif
/* * * */
/* The function used to dispose of this structure */
void (*free) (_THIS);
};
typedef struct VideoBootStrap
{
const char *name;
const char *desc;
SDL_VideoDevice *(*create) (int devindex);
} VideoBootStrap;
Feb 26, 2017
Feb 26, 2017
419
/* Not all of these are available in a given build. Use #ifdefs, etc. */
420
421
422
423
424
425
426
427
428
429
430
extern VideoBootStrap COCOA_bootstrap;
extern VideoBootStrap X11_bootstrap;
extern VideoBootStrap DirectFB_bootstrap;
extern VideoBootStrap WINDOWS_bootstrap;
extern VideoBootStrap WINRT_bootstrap;
extern VideoBootStrap HAIKU_bootstrap;
extern VideoBootStrap PND_bootstrap;
extern VideoBootStrap UIKIT_bootstrap;
extern VideoBootStrap Android_bootstrap;
extern VideoBootStrap PSP_bootstrap;
extern VideoBootStrap RPI_bootstrap;
Aug 2, 2017
Aug 2, 2017
431
extern VideoBootStrap KMSDRM_bootstrap;
432
433
434
435
436
extern VideoBootStrap DUMMY_bootstrap;
extern VideoBootStrap Wayland_bootstrap;
extern VideoBootStrap NACL_bootstrap;
extern VideoBootStrap VIVANTE_bootstrap;
extern VideoBootStrap Emscripten_bootstrap;
Jul 1, 2017
Jul 1, 2017
437
extern VideoBootStrap QNX_bootstrap;
Sep 24, 2019
Sep 24, 2019
438
extern VideoBootStrap OFFSCREEN_bootstrap;
439
440
441
442
443
extern SDL_VideoDevice *SDL_GetVideoDevice(void);
extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display);
extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
Aug 23, 2018
Aug 23, 2018
444
445
extern int SDL_GetIndexOfDisplay(SDL_VideoDisplay *display);
extern SDL_VideoDisplay *SDL_GetDisplay(int displayIndex);
446
447
extern SDL_VideoDisplay *SDL_GetDisplayForWindow(SDL_Window *window);
extern void *SDL_GetDisplayDriverData( int displayIndex );
Dec 8, 2019
Dec 8, 2019
448
extern SDL_bool SDL_IsVideoContextExternal(void);
Jan 10, 2017
Jan 10, 2017
450
451
extern void SDL_GL_DeduceMaxSupportedESProfile(int* major, int* minor);
452
extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
Aug 15, 2017
Aug 15, 2017
453
extern SDL_bool SDL_HasWindows(void);
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
extern void SDL_OnWindowShown(SDL_Window * window);
extern void SDL_OnWindowHidden(SDL_Window * window);
extern void SDL_OnWindowResized(SDL_Window * window);
extern void SDL_OnWindowMinimized(SDL_Window * window);
extern void SDL_OnWindowRestored(SDL_Window * window);
extern void SDL_OnWindowEnter(SDL_Window * window);
extern void SDL_OnWindowLeave(SDL_Window * window);
extern void SDL_OnWindowFocusGained(SDL_Window * window);
extern void SDL_OnWindowFocusLost(SDL_Window * window);
extern void SDL_UpdateWindowGrab(SDL_Window * window);
extern SDL_Window * SDL_GetFocusWindow(void);
extern SDL_bool SDL_ShouldAllowTopmost(void);
Jul 30, 2015
Jul 30, 2015
469
470
extern float SDL_ComputeDiagonalDPI(int hpix, int vpix, float hinches, float vinches);
Aug 2, 2018
Aug 2, 2018
471
472
extern void SDL_ToggleDragAndDropSupport(void);
Nov 21, 2016
Nov 21, 2016
473
#endif /* SDL_sysvideo_h_ */
474
475
/* vi: set ts=4 sw=4 expandtab: */