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