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 * # CategoryPlatform
24 *
25 * SDL provides a means to identify the app's platform, both at compile time
26 * and runtime.
27 */
28
29#ifndef SDL_platform_h_
30#define SDL_platform_h_
31
32#include <SDL3/SDL_platform_defines.h>
33
34#include <SDL3/SDL_begin_code.h>
35/* Set up for C function definitions, even when using C++ */
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/**
41 * Get the name of the platform.
42 *
43 * Here are the names returned for some (but not all) supported platforms:
44 *
45 * - "Windows"
46 * - "macOS"
47 * - "Linux"
48 * - "iOS"
49 * - "Android"
50 *
51 * \returns the name of the platform. If the correct platform name is not
52 * available, returns a string beginning with the text "Unknown".
53 *
54 * \since This function is available since SDL 3.2.0.
55 */
56extern SDL_DECLSPEC const char * SDLCALL SDL_GetPlatform(void);
57
58/* Ends C function definitions when using C++ */
59#ifdef __cplusplus
60}
61#endif
62#include <SDL3/SDL_close_code.h>
63
64#endif /* SDL_platform_h_ */
65