mirror of
https://github.com/shadps4-emu/ext-SDL.git
synced 2024-12-12 21:08:14 +00:00
e23257307e
This declares that any `const char *` returned from SDL is owned by SDL, and promises to be valid _at least_ until the next time the event queue runs, or SDL_Quit() is called, even if the thing that owns the string gets destroyed or changed before then. This is noted in the headers as "the SDL_GetStringRule", so this will both be greppable to find a detailed explaination in docs/README-strings.md and wikiheaders will automatically turn it into a link we can point at the appropriate documentation. Fixes #9902. (and several FIXMEs, both known and yet-undocumented.)
67 lines
1.9 KiB
C
67 lines
1.9 KiB
C
/*
|
|
Simple DirectMedia Layer
|
|
Copyright (C) 1997-2024 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.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
/**
|
|
* # CategoryPlatform
|
|
*
|
|
* SDL provides a means to identify the app's platform, both at compile time
|
|
* and runtime.
|
|
*/
|
|
|
|
#ifndef SDL_platform_h_
|
|
#define SDL_platform_h_
|
|
|
|
#include <SDL3/SDL_platform_defines.h>
|
|
|
|
#include <SDL3/SDL_begin_code.h>
|
|
/* Set up for C function definitions, even when using C++ */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Get the name of the platform.
|
|
*
|
|
* Here are the names returned for some (but not all) supported platforms:
|
|
*
|
|
* - "Windows"
|
|
* - "macOS"
|
|
* - "Linux"
|
|
* - "iOS"
|
|
* - "Android"
|
|
*
|
|
* The returned string follows the SDL_GetStringRule.
|
|
*
|
|
* \returns the name of the platform. If the correct platform name is not
|
|
* available, returns a string beginning with the text "Unknown".
|
|
*
|
|
* \since This function is available since SDL 3.0.0.
|
|
*/
|
|
extern SDL_DECLSPEC const char * SDLCALL SDL_GetPlatform(void);
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#include <SDL3/SDL_close_code.h>
|
|
|
|
#endif /* SDL_platform_h_ */
|