1 /*
2     DSDL
3     Copyright (C) 2025 Inochi2D Project <luna@foxgirls.gay>
4 
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.
8 
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:
12 
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.
20 
21     ==========================================================================
22 
23     Simple DirectMedia Layer
24     Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
25 
26     This software is provided 'as-is', without any express or implied
27     warranty.  In no event will the authors be held liable for any damages
28     arising from the use of this software.
29 
30     Permission is granted to anyone to use this software for any purpose,
31     including commercial applications, and to alter it and redistribute it
32     freely, subject to the following restrictions:
33 
34     1. The origin of this software must not be misrepresented; you must not
35         claim that you wrote the original software. If you use this software
36         in a product, an acknowledgment in the product documentation would be
37         appreciated but is not required.
38     2. Altered source versions must be plainly marked as such, and must not be
39         misrepresented as being the original software.
40     3. This notice may not be removed or altered from any source distribution.
41 */
42 
43 /**
44     SDL Miscellaneous Functions
45 
46     See_Also:
47         $(LINK2 https://wiki.libsdl.org/SDL3/CategoryMisc, SDL3 Misc Documentation)
48     
49     Copyright: © 2025 Inochi2D Project, © 1997-2025 Sam Lantinga
50     License: Subject to the terms of the Zlib License, as written in the LICENSE file.
51     Authors: 
52         Luna Nielsen
53 */
54 module sdl.misc;
55 
56 extern (C) nothrow @nogc:
57 
58 /**
59     Open a URL/URI in the browser or other appropriate external application.
60 
61     Open a URL in a separate, system-provided application. How this works will
62     vary wildly depending on the platform. This will likely launch what makes
63     sense to handle a specific URL's protocol (a web browser for `http://`,
64     etc), but it might also be able to launch file managers for directories and
65     other things.
66 
67     What happens when you open a URL varies wildly as well: your game window
68     may lose focus (and may or may not lose focus if your game was fullscreen
69     or grabbing input at the time). On mobile devices, your app will likely
70     move to the background or your process might be paused. Any given platform
71     may or may not handle a given URL.
72 
73     If this is unimplemented (or simply unavailable) for a platform, this will
74     fail with an error. A successful result does not mean the URL loaded, just
75     that we launched _something_ to handle it (or at least believe we did).
76 
77     All this to say: this function can be useful, but you should definitely
78     test it on every platform you target.
79 
80     Params:
81         url =   A valid URL/URI to open. Use `file:///full/path/to/file`
82                 for local files, if supported.
83     
84     Returns:
85         $(D true) on success or $(D false) on failure; 
86         call SDL_GetError() for more information.
87 */
88 extern bool SDL_OpenURL(const(char)* url);
89