|
1
|
1 /*
|
|
|
2 Simple DirectMedia Layer
|
|
|
3 Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
|
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 * # CategoryMisc
|
|
|
24 *
|
|
|
25 * SDL API functions that don't fit elsewhere.
|
|
|
26 */
|
|
|
27
|
|
|
28 #ifndef SDL_misc_h_
|
|
|
29 #define SDL_misc_h_
|
|
|
30
|
|
|
31 #include <SDL3/SDL_stdinc.h>
|
|
|
32 #include <SDL3/SDL_error.h>
|
|
|
33
|
|
|
34 #include <SDL3/SDL_begin_code.h>
|
|
|
35
|
|
|
36 /* Set up for C function definitions, even when using C++ */
|
|
|
37 #ifdef __cplusplus
|
|
|
38 extern "C" {
|
|
|
39 #endif
|
|
|
40
|
|
|
41 /**
|
|
|
42 * Open a URL/URI in the browser or other appropriate external application.
|
|
|
43 *
|
|
|
44 * Open a URL in a separate, system-provided application. How this works will
|
|
|
45 * vary wildly depending on the platform. This will likely launch what makes
|
|
|
46 * sense to handle a specific URL's protocol (a web browser for `http://`,
|
|
|
47 * etc), but it might also be able to launch file managers for directories and
|
|
|
48 * other things.
|
|
|
49 *
|
|
|
50 * What happens when you open a URL varies wildly as well: your game window
|
|
|
51 * may lose focus (and may or may not lose focus if your game was fullscreen
|
|
|
52 * or grabbing input at the time). On mobile devices, your app will likely
|
|
|
53 * move to the background or your process might be paused. Any given platform
|
|
|
54 * may or may not handle a given URL.
|
|
|
55 *
|
|
|
56 * If this is unimplemented (or simply unavailable) for a platform, this will
|
|
|
57 * fail with an error. A successful result does not mean the URL loaded, just
|
|
|
58 * that we launched _something_ to handle it (or at least believe we did).
|
|
|
59 *
|
|
|
60 * All this to say: this function can be useful, but you should definitely
|
|
|
61 * test it on every platform you target.
|
|
|
62 *
|
|
|
63 * \param url a valid URL/URI to open. Use `file:///full/path/to/file` for
|
|
|
64 * local files, if supported.
|
|
|
65 * \returns true on success or false on failure; call SDL_GetError() for more
|
|
|
66 * information.
|
|
|
67 *
|
|
|
68 * \since This function is available since SDL 3.2.0.
|
|
|
69 */
|
|
|
70 extern SDL_DECLSPEC bool SDLCALL SDL_OpenURL(const char *url);
|
|
|
71
|
|
|
72 /* Ends C function definitions when using C++ */
|
|
|
73 #ifdef __cplusplus
|
|
|
74 }
|
|
|
75 #endif
|
|
|
76 #include <SDL3/SDL_close_code.h>
|
|
|
77
|
|
|
78 #endif /* SDL_misc_h_ */
|
