dependencies/SDL/include/SDL_misc.h in gosu-1.3.0 vs dependencies/SDL/include/SDL_misc.h in gosu-1.4.0
- old
+ new
@@ -1,8 +1,8 @@
/*
Simple DirectMedia Layer
- Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
+ Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
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.
@@ -36,32 +36,36 @@
#ifdef __cplusplus
extern "C" {
#endif
/**
- * \brief Open an URL / URI in the browser or other
+ * Open a URL/URI in the browser or other appropriate external application.
*
* Open a URL in a separate, system-provided application. How this works will
- * vary wildly depending on the platform. This will likely launch what
- * makes sense to handle a specific URL's protocol (a web browser for http://,
- * etc), but it might also be able to launch file managers for directories
- * and other things.
+ * vary wildly depending on the platform. This will likely launch what makes
+ * sense to handle a specific URL's protocol (a web browser for `http://`,
+ * etc), but it might also be able to launch file managers for directories and
+ * other things.
*
* What happens when you open a URL varies wildly as well: your game window
- * may lose focus (and may or may not lose focus if your game was fullscreen
- * or grabbing input at the time). On mobile devices, your app will likely
- * move to the background or your process might be paused. Any given platform
- * may or may not handle a given URL.
+ * may lose focus (and may or may not lose focus if your game was fullscreen
+ * or grabbing input at the time). On mobile devices, your app will likely
+ * move to the background or your process might be paused. Any given platform
+ * may or may not handle a given URL.
*
* If this is unimplemented (or simply unavailable) for a platform, this will
- * fail with an error. A successful result does not mean the URL loaded, just
- * that we launched something to handle it (or at least believe we did).
+ * fail with an error. A successful result does not mean the URL loaded, just
+ * that we launched _something_ to handle it (or at least believe we did).
*
* All this to say: this function can be useful, but you should definitely
- * test it on every platform you target.
+ * test it on every platform you target.
*
- * \param url A valid URL to open.
- * \return 0 on success, or -1 on error.
+ * \param url A valid URL/URI to open. Use `file:///full/path/to/file` for
+ * local files, if supported.
+ * \returns 0 on success, or -1 on error; call SDL_GetError() for more
+ * information.
+ *
+ * \since This function is available since SDL 2.0.14.
*/
extern DECLSPEC int SDLCALL SDL_OpenURL(const char *url);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus