2 Simple DirectMedia Layer
3 Copyright (C) 1997-2021 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
21 #include "../SDL_internal.h"
23 #ifndef SDL_sysvideo_h_
24 #define SDL_sysvideo_h_
26 #include "SDL_messagebox.h"
27 #include "SDL_shape.h"
28 #include "SDL_thread.h"
29 #include "SDL_metal.h"
31 #include "SDL_vulkan_internal.h"
33 /* The SDL video driver */
35 typedef struct SDL_WindowShaper SDL_WindowShaper;
36 typedef struct SDL_ShapeDriver SDL_ShapeDriver;
37 typedef struct SDL_VideoDisplay SDL_VideoDisplay;
38 typedef struct SDL_VideoDevice SDL_VideoDevice;
40 /* Define the SDL window-shaper structure */
41 struct SDL_WindowShaper
43 /* The window associated with the shaper */
46 /* The user's specified coordinates for the window, for once we give it a shape. */
49 /* The parameters for shape calculation. */
50 SDL_WindowShapeMode mode;
52 /* Has this window been assigned a shape? */
58 /* Define the SDL shape driver structure */
59 struct SDL_ShapeDriver
61 SDL_WindowShaper *(*CreateShaper)(SDL_Window * window);
62 int (*SetWindowShape)(SDL_WindowShaper *shaper,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
63 int (*ResizeWindowShape)(SDL_Window *window);
66 typedef struct SDL_WindowUserData
70 struct SDL_WindowUserData *next;
73 /* Define the SDL window structure, corresponding to toplevel windows */
85 Uint32 last_fullscreen_flags;
87 /* Stored position and size for windowed mode */
90 SDL_DisplayMode fullscreen_mode;
96 Uint16 *saved_gamma; /* (just offset into gamma) */
99 SDL_bool surface_valid;
102 SDL_bool is_destroying;
103 SDL_bool is_dropping; /* drag/drop in progress, expecting SDL_SendDropComplete(). */
105 SDL_WindowShaper *shaper;
107 SDL_HitTest hit_test;
110 SDL_WindowUserData *data;
117 #define FULLSCREEN_VISIBLE(W) \
118 (((W)->flags & SDL_WINDOW_FULLSCREEN) && \
119 ((W)->flags & SDL_WINDOW_SHOWN) && \
120 !((W)->flags & SDL_WINDOW_MINIMIZED))
123 * Define the SDL display structure.
124 * This corresponds to physical monitors attached to the system.
126 struct SDL_VideoDisplay
129 int max_display_modes;
130 int num_display_modes;
131 SDL_DisplayMode *display_modes;
132 SDL_DisplayMode desktop_mode;
133 SDL_DisplayMode current_mode;
134 SDL_DisplayOrientation orientation;
136 SDL_Window *fullscreen_window;
138 SDL_VideoDevice *device;
143 /* Forward declaration */
144 struct SDL_SysWMinfo;
146 /* Define the SDL video driver structure */
147 #define _THIS SDL_VideoDevice *_this
149 struct SDL_VideoDevice
152 /* The name of this video driver */
156 /* Initialization/Query functions */
159 * Initialize the native video subsystem, filling in the list of
160 * displays for this driver, returning 0 or -1 if there's an error.
162 int (*VideoInit) (_THIS);
165 * Reverse the effects VideoInit() -- called if VideoInit() fails or
166 * if the application is shutting down the video subsystem.
168 void (*VideoQuit) (_THIS);
171 * Reinitialize the touch devices -- called if an unknown touch ID occurs.
173 void (*ResetTouch) (_THIS);
181 * Get the bounds of a display
183 int (*GetDisplayBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
186 * Get the usable bounds of a display (bounds minus menubar or whatever)
188 int (*GetDisplayUsableBounds) (_THIS, SDL_VideoDisplay * display, SDL_Rect * rect);
191 * Get the dots/pixels-per-inch of a display
193 int (*GetDisplayDPI) (_THIS, SDL_VideoDisplay * display, float * ddpi, float * hdpi, float * vdpi);
196 * Get a list of the available display modes for a display.
198 void (*GetDisplayModes) (_THIS, SDL_VideoDisplay * display);
201 * Setting the display mode is independent of creating windows, so
202 * when the display mode is changed, all existing windows should have
203 * their data updated accordingly, including the display surfaces
204 * associated with them.
206 int (*SetDisplayMode) (_THIS, SDL_VideoDisplay * display, SDL_DisplayMode * mode);
212 int (*CreateSDLWindow) (_THIS, SDL_Window * window);
213 int (*CreateSDLWindowFrom) (_THIS, SDL_Window * window, const void *data);
214 void (*SetWindowTitle) (_THIS, SDL_Window * window);
215 void (*SetWindowIcon) (_THIS, SDL_Window * window, SDL_Surface * icon);
216 void (*SetWindowPosition) (_THIS, SDL_Window * window);
217 void (*SetWindowSize) (_THIS, SDL_Window * window);
218 void (*SetWindowMinimumSize) (_THIS, SDL_Window * window);
219 void (*SetWindowMaximumSize) (_THIS, SDL_Window * window);
220 int (*GetWindowBordersSize) (_THIS, SDL_Window * window, int *top, int *left, int *bottom, int *right);
221 int (*SetWindowOpacity) (_THIS, SDL_Window * window, float opacity);
222 int (*SetWindowModalFor) (_THIS, SDL_Window * modal_window, SDL_Window * parent_window);
223 int (*SetWindowInputFocus) (_THIS, SDL_Window * window);
224 void (*ShowWindow) (_THIS, SDL_Window * window);
225 void (*HideWindow) (_THIS, SDL_Window * window);
226 void (*RaiseWindow) (_THIS, SDL_Window * window);
227 void (*MaximizeWindow) (_THIS, SDL_Window * window);
228 void (*MinimizeWindow) (_THIS, SDL_Window * window);
229 void (*RestoreWindow) (_THIS, SDL_Window * window);
230 void (*SetWindowBordered) (_THIS, SDL_Window * window, SDL_bool bordered);
231 void (*SetWindowResizable) (_THIS, SDL_Window * window, SDL_bool resizable);
232 void (*SetWindowFullscreen) (_THIS, SDL_Window * window, SDL_VideoDisplay * display, SDL_bool fullscreen);
233 int (*SetWindowGammaRamp) (_THIS, SDL_Window * window, const Uint16 * ramp);
234 int (*GetWindowGammaRamp) (_THIS, SDL_Window * window, Uint16 * ramp);
235 void (*SetWindowGrab) (_THIS, SDL_Window * window, SDL_bool grabbed);
236 void (*DestroyWindow) (_THIS, SDL_Window * window);
237 int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);
238 int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, const SDL_Rect * rects, int numrects);
239 void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);
240 void (*OnWindowEnter) (_THIS, SDL_Window * window);
244 * Shaped-window functions
246 SDL_ShapeDriver shape_driver;
248 /* Get some platform dependent window information */
249 SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,
250 struct SDL_SysWMinfo * info);
256 int (*GL_LoadLibrary) (_THIS, const char *path);
257 void *(*GL_GetProcAddress) (_THIS, const char *proc);
258 void (*GL_UnloadLibrary) (_THIS);
259 SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);
260 int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);
261 void (*GL_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
262 int (*GL_SetSwapInterval) (_THIS, int interval);
263 int (*GL_GetSwapInterval) (_THIS);
264 int (*GL_SwapWindow) (_THIS, SDL_Window * window);
265 void (*GL_DeleteContext) (_THIS, SDL_GLContext context);
266 void (*GL_DefaultProfileConfig) (_THIS, int *mask, int *major, int *minor);
272 int (*Vulkan_LoadLibrary) (_THIS, const char *path);
273 void (*Vulkan_UnloadLibrary) (_THIS);
274 SDL_bool (*Vulkan_GetInstanceExtensions) (_THIS, SDL_Window *window, unsigned *count, const char **names);
275 SDL_bool (*Vulkan_CreateSurface) (_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface);
276 void (*Vulkan_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
282 SDL_MetalView (*Metal_CreateView) (_THIS, SDL_Window * window);
283 void (*Metal_DestroyView) (_THIS, SDL_MetalView view);
284 void *(*Metal_GetLayer) (_THIS, SDL_MetalView view);
285 void (*Metal_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);
289 * Event manager functions
291 void (*PumpEvents) (_THIS);
293 /* Suspend the screensaver */
294 void (*SuspendScreenSaver) (_THIS);
297 void (*StartTextInput) (_THIS);
298 void (*StopTextInput) (_THIS);
299 void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
301 /* Screen keyboard */
302 SDL_bool (*HasScreenKeyboardSupport) (_THIS);
303 void (*ShowScreenKeyboard) (_THIS, SDL_Window *window);
304 void (*HideScreenKeyboard) (_THIS, SDL_Window *window);
305 SDL_bool (*IsScreenKeyboardShown) (_THIS, SDL_Window *window);
308 int (*SetClipboardText) (_THIS, const char *text);
309 char * (*GetClipboardText) (_THIS);
310 SDL_bool (*HasClipboardText) (_THIS);
313 int (*ShowMessageBox) (_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid);
316 int (*SetWindowHitTest)(SDL_Window * window, SDL_bool enabled);
318 /* Tell window that app enabled drag'n'drop events */
319 void (*AcceptDragAndDrop)(SDL_Window * window, SDL_bool accept);
322 /* Data common to all drivers */
324 SDL_bool suspend_screensaver;
326 SDL_VideoDisplay *displays;
328 SDL_Window *grabbed_window;
330 Uint32 next_object_id;
331 char *clipboard_text;
334 /* Data used by the GL drivers */
346 int accum_green_size;
348 int accum_alpha_size;
350 int multisamplebuffers;
351 int multisamplesamples;
357 int share_with_current_context;
358 int release_behavior;
359 int reset_notification;
360 int framebuffer_srgb_capable;
362 int retained_backing;
364 char driver_path[256];
369 /* Cache current GL context; don't call the OS when it hasn't changed. */
370 /* We have the global pointers here so Cocoa continues to work the way
371 it always has, and the thread-local storage for the general case.
373 SDL_Window *current_glwin;
374 SDL_GLContext current_glctx;
375 SDL_TLSID current_glwin_tls;
376 SDL_TLSID current_glctx_tls;
378 /* Flag that stores whether it's allowed to call SDL_GL_MakeCurrent()
379 * with a NULL window, but a non-NULL context. (Not allowed in most cases,
380 * except on EGL under some circumstances.) */
381 SDL_bool gl_allow_no_surface;
384 /* Data used by the Vulkan drivers */
387 PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr;
388 PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties;
390 char loader_path[256];
395 /* Data private to this driver */
397 struct SDL_GLDriverData *gl_data;
399 #if SDL_VIDEO_OPENGL_EGL
400 struct SDL_EGL_VideoData *egl_data;
403 #if SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
404 struct SDL_PrivateGLESData *gles_data;
408 /* The function used to dispose of this structure */
409 void (*free) (_THIS);
412 typedef struct VideoBootStrap
416 SDL_VideoDevice *(*create) (int devindex);
419 /* Not all of these are available in a given build. Use #ifdefs, etc. */
420 extern VideoBootStrap COCOA_bootstrap;
421 extern VideoBootStrap X11_bootstrap;
422 extern VideoBootStrap DirectFB_bootstrap;
423 extern VideoBootStrap WINDOWS_bootstrap;
424 extern VideoBootStrap WINRT_bootstrap;
425 extern VideoBootStrap HAIKU_bootstrap;
426 extern VideoBootStrap PND_bootstrap;
427 extern VideoBootStrap UIKIT_bootstrap;
428 extern VideoBootStrap Android_bootstrap;
429 extern VideoBootStrap PSP_bootstrap;
430 extern VideoBootStrap RPI_bootstrap;
431 extern VideoBootStrap KMSDRM_bootstrap;
432 extern VideoBootStrap KMSDRM_LEGACY_bootstrap;
433 extern VideoBootStrap DUMMY_bootstrap;
434 extern VideoBootStrap Wayland_bootstrap;
435 extern VideoBootStrap NACL_bootstrap;
436 extern VideoBootStrap VIVANTE_bootstrap;
437 extern VideoBootStrap Emscripten_bootstrap;
438 extern VideoBootStrap QNX_bootstrap;
439 extern VideoBootStrap OFFSCREEN_bootstrap;
440 extern VideoBootStrap OS2DIVE_bootstrap;
441 extern VideoBootStrap OS2VMAN_bootstrap;
443 extern SDL_VideoDevice *SDL_GetVideoDevice(void);
444 extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode * desktop_mode);
445 extern int SDL_AddVideoDisplay(const SDL_VideoDisplay * display, SDL_bool send_event);
446 extern void SDL_DelVideoDisplay(int index);
447 extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode * mode);
448 extern int SDL_GetIndexOfDisplay(SDL_VideoDisplay *display);
449 extern SDL_VideoDisplay *SDL_GetDisplay(int displayIndex);
450 extern SDL_VideoDisplay *SDL_GetDisplayForWindow(SDL_Window *window);
451 extern void *SDL_GetDisplayDriverData( int displayIndex );
452 extern SDL_bool SDL_IsVideoContextExternal(void);
454 extern void SDL_GL_DeduceMaxSupportedESProfile(int* major, int* minor);
456 extern int SDL_RecreateWindow(SDL_Window * window, Uint32 flags);
457 extern SDL_bool SDL_HasWindows(void);
459 extern void SDL_OnWindowShown(SDL_Window * window);
460 extern void SDL_OnWindowHidden(SDL_Window * window);
461 extern void SDL_OnWindowResized(SDL_Window * window);
462 extern void SDL_OnWindowMinimized(SDL_Window * window);
463 extern void SDL_OnWindowRestored(SDL_Window * window);
464 extern void SDL_OnWindowEnter(SDL_Window * window);
465 extern void SDL_OnWindowLeave(SDL_Window * window);
466 extern void SDL_OnWindowFocusGained(SDL_Window * window);
467 extern void SDL_OnWindowFocusLost(SDL_Window * window);
468 extern void SDL_UpdateWindowGrab(SDL_Window * window);
469 extern SDL_Window * SDL_GetFocusWindow(void);
471 extern SDL_bool SDL_ShouldAllowTopmost(void);
473 extern float SDL_ComputeDiagonalDPI(int hpix, int vpix, float hinches, float vinches);
475 extern void SDL_ToggleDragAndDropSupport(void);
477 #endif /* SDL_sysvideo_h_ */
479 /* vi: set ts=4 sw=4 expandtab: */