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#ifndef SDL_dynapi_h_
23#define SDL_dynapi_h_
24
25/* IMPORTANT:
26 This is the master switch to disabling the dynamic API. We made it so you
27 have to hand-edit an internal source file in SDL to turn it off; you
28 can do it if you want it badly enough, but hopefully you won't want to.
29 You should understand the ramifications of turning this off: it makes it
30 hard to update your SDL in the field, and impossible if you've statically
31 linked SDL into your app. Understand that platforms change, and if we can't
32 drop in an updated SDL, your application can definitely break some time
33 in the future, even if it's fine today.
34 To be sure, as new system-level video and audio APIs are introduced, an
35 updated SDL can transparently take advantage of them, but your program will
36 not without this feature. Think hard before turning it off.
37*/
38#ifdef SDL_DYNAMIC_API // Tried to force it on the command line?
39#error Nope, you have to edit this file to force this off.
40#endif
41
42#ifdef SDL_PLATFORM_APPLE
43#include "TargetConditionals.h"
44#endif
45
46#if defined(SDL_PLATFORM_PRIVATE) // probably not useful on private platforms.
47#define SDL_DYNAMIC_API 0
48#elif defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE // probably not useful on iOS.
49#define SDL_DYNAMIC_API 0
50#elif defined(SDL_PLATFORM_ANDROID) // probably not useful on Android.
51#define SDL_DYNAMIC_API 0
52#elif defined(SDL_PLATFORM_EMSCRIPTEN) // probably not useful on Emscripten.
53#define SDL_DYNAMIC_API 0
54#elif defined(SDL_PLATFORM_PS2) && SDL_PLATFORM_PS2
55#define SDL_DYNAMIC_API 0
56#elif defined(SDL_PLATFORM_PSP) && SDL_PLATFORM_PSP
57#define SDL_DYNAMIC_API 0
58#elif defined(SDL_PLATFORM_RISCOS) // probably not useful on RISC OS, since dlopen() can't be used when using static linking.
59#define SDL_DYNAMIC_API 0
60#elif defined(__clang_analyzer__) || defined(__INTELLISENSE__) || defined(SDL_THREAD_SAFETY_ANALYSIS)
61#define SDL_DYNAMIC_API 0 // Turn off for static analysis, so reports are more clear.
62#elif defined(SDL_PLATFORM_VITA)
63#define SDL_DYNAMIC_API 0 // vitasdk doesn't support dynamic linking
64#elif defined(SDL_PLATFORM_3DS)
65#define SDL_DYNAMIC_API 0 // devkitARM doesn't support dynamic linking
66#elif defined(DYNAPI_NEEDS_DLOPEN) && !defined(HAVE_DLOPEN)
67#define SDL_DYNAMIC_API 0 // we need dlopen(), but don't have it....
68#endif
69
70// everyone else. This is where we turn on the API if nothing forced it off.
71#ifndef SDL_DYNAMIC_API
72#define SDL_DYNAMIC_API 1
73#endif
74
75#endif
76