annotate SDL3/SDL_platform.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 /*
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2 Simple DirectMedia Layer
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 This software is provided 'as-is', without any express or implied
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 warranty. In no event will the authors be held liable for any damages
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 arising from the use of this software.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 Permission is granted to anyone to use this software for any purpose,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 including commercial applications, and to alter it and redistribute it
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 freely, subject to the following restrictions:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 1. The origin of this software must not be misrepresented; you must not
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 claim that you wrote the original software. If you use this software
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 in a product, an acknowledgment in the product documentation would be
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 appreciated but is not required.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 2. Altered source versions must be plainly marked as such, and must not be
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 misrepresented as being the original software.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 3. This notice may not be removed or altered from any source distribution.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 /**
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 * # CategoryPlatform
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 * SDL provides a means to identify the app's platform, both at compile time
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 * and runtime.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 #ifndef SDL_platform_h_
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 #define SDL_platform_h_
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 #include <SDL3/SDL_platform_defines.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 #include <SDL3/SDL_begin_code.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 /* Set up for C function definitions, even when using C++ */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 #ifdef __cplusplus
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 extern "C" {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 /**
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 * Get the name of the platform.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 * Here are the names returned for some (but not all) supported platforms:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 * - "Windows"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 * - "macOS"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 * - "Linux"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 * - "iOS"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 * - "Android"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 * \returns the name of the platform. If the correct platform name is not
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 * available, returns a string beginning with the text "Unknown".
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 * \since This function is available since SDL 3.2.0.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 extern SDL_DECLSPEC const char * SDLCALL SDL_GetPlatform(void);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 /* Ends C function definitions when using C++ */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 #ifdef __cplusplus
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 #include <SDL3/SDL_close_code.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 #endif /* SDL_platform_h_ */