diff options
Diffstat (limited to 'src/contrib/SDL-2.30.2/include/SDL_version.h')
| -rw-r--r-- | src/contrib/SDL-2.30.2/include/SDL_version.h | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/src/contrib/SDL-2.30.2/include/SDL_version.h b/src/contrib/SDL-2.30.2/include/SDL_version.h new file mode 100644 index 0000000..c222d77 --- /dev/null +++ b/src/contrib/SDL-2.30.2/include/SDL_version.h | |||
| @@ -0,0 +1,204 @@ | |||
| 1 | /* | ||
| 2 | Simple DirectMedia Layer | ||
| 3 | Copyright (C) 1997-2024 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 | * \file SDL_version.h | ||
| 24 | * | ||
| 25 | * This header defines the current SDL version. | ||
| 26 | */ | ||
| 27 | |||
| 28 | #ifndef SDL_version_h_ | ||
| 29 | #define SDL_version_h_ | ||
| 30 | |||
| 31 | #include "SDL_stdinc.h" | ||
| 32 | |||
| 33 | #include "begin_code.h" | ||
| 34 | /* Set up for C function definitions, even when using C++ */ | ||
| 35 | #ifdef __cplusplus | ||
| 36 | extern "C" { | ||
| 37 | #endif | ||
| 38 | |||
| 39 | /** | ||
| 40 | * Information about the version of SDL in use. | ||
| 41 | * | ||
| 42 | * Represents the library's version as three levels: major revision | ||
| 43 | * (increments with massive changes, additions, and enhancements), | ||
| 44 | * minor revision (increments with backwards-compatible changes to the | ||
| 45 | * major revision), and patchlevel (increments with fixes to the minor | ||
| 46 | * revision). | ||
| 47 | * | ||
| 48 | * \sa SDL_VERSION | ||
| 49 | * \sa SDL_GetVersion | ||
| 50 | */ | ||
| 51 | typedef struct SDL_version | ||
| 52 | { | ||
| 53 | Uint8 major; /**< major version */ | ||
| 54 | Uint8 minor; /**< minor version */ | ||
| 55 | Uint8 patch; /**< update version */ | ||
| 56 | } SDL_version; | ||
| 57 | |||
| 58 | /* Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL | ||
| 59 | */ | ||
| 60 | #define SDL_MAJOR_VERSION 2 | ||
| 61 | #define SDL_MINOR_VERSION 30 | ||
| 62 | #define SDL_PATCHLEVEL 2 | ||
| 63 | |||
| 64 | /** | ||
| 65 | * Macro to determine SDL version program was compiled against. | ||
| 66 | * | ||
| 67 | * This macro fills in a SDL_version structure with the version of the | ||
| 68 | * library you compiled against. This is determined by what header the | ||
| 69 | * compiler uses. Note that if you dynamically linked the library, you might | ||
| 70 | * have a slightly newer or older version at runtime. That version can be | ||
| 71 | * determined with SDL_GetVersion(), which, unlike SDL_VERSION(), | ||
| 72 | * is not a macro. | ||
| 73 | * | ||
| 74 | * \param x A pointer to a SDL_version struct to initialize. | ||
| 75 | * | ||
| 76 | * \sa SDL_version | ||
| 77 | * \sa SDL_GetVersion | ||
| 78 | */ | ||
| 79 | #define SDL_VERSION(x) \ | ||
| 80 | { \ | ||
| 81 | (x)->major = SDL_MAJOR_VERSION; \ | ||
| 82 | (x)->minor = SDL_MINOR_VERSION; \ | ||
| 83 | (x)->patch = SDL_PATCHLEVEL; \ | ||
| 84 | } | ||
| 85 | |||
| 86 | /* TODO: Remove this whole block in SDL 3 */ | ||
| 87 | #if SDL_MAJOR_VERSION < 3 | ||
| 88 | /** | ||
| 89 | * This macro turns the version numbers into a numeric value: | ||
| 90 | * \verbatim | ||
| 91 | (1,2,3) -> (1203) | ||
| 92 | \endverbatim | ||
| 93 | * | ||
| 94 | * This assumes that there will never be more than 100 patchlevels. | ||
| 95 | * | ||
| 96 | * In versions higher than 2.9.0, the minor version overflows into | ||
| 97 | * the thousands digit: for example, 2.23.0 is encoded as 4300, | ||
| 98 | * and 2.255.99 would be encoded as 25799. | ||
| 99 | * This macro will not be available in SDL 3.x. | ||
| 100 | */ | ||
| 101 | #define SDL_VERSIONNUM(X, Y, Z) \ | ||
| 102 | ((X)*1000 + (Y)*100 + (Z)) | ||
| 103 | |||
| 104 | /** | ||
| 105 | * This is the version number macro for the current SDL version. | ||
| 106 | * | ||
| 107 | * In versions higher than 2.9.0, the minor version overflows into | ||
| 108 | * the thousands digit: for example, 2.23.0 is encoded as 4300. | ||
| 109 | * This macro will not be available in SDL 3.x. | ||
| 110 | * | ||
| 111 | * Deprecated, use SDL_VERSION_ATLEAST or SDL_VERSION instead. | ||
| 112 | */ | ||
| 113 | #define SDL_COMPILEDVERSION \ | ||
| 114 | SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL) | ||
| 115 | #endif /* SDL_MAJOR_VERSION < 3 */ | ||
| 116 | |||
| 117 | /** | ||
| 118 | * This macro will evaluate to true if compiled with SDL at least X.Y.Z. | ||
| 119 | */ | ||
| 120 | #define SDL_VERSION_ATLEAST(X, Y, Z) \ | ||
| 121 | ((SDL_MAJOR_VERSION >= X) && \ | ||
| 122 | (SDL_MAJOR_VERSION > X || SDL_MINOR_VERSION >= Y) && \ | ||
| 123 | (SDL_MAJOR_VERSION > X || SDL_MINOR_VERSION > Y || SDL_PATCHLEVEL >= Z)) | ||
| 124 | |||
| 125 | /** | ||
| 126 | * Get the version of SDL that is linked against your program. | ||
| 127 | * | ||
| 128 | * If you are linking to SDL dynamically, then it is possible that the current | ||
| 129 | * version will be different than the version you compiled against. This | ||
| 130 | * function returns the current version, while SDL_VERSION() is a macro that | ||
| 131 | * tells you what version you compiled with. | ||
| 132 | * | ||
| 133 | * This function may be called safely at any time, even before SDL_Init(). | ||
| 134 | * | ||
| 135 | * \param ver the SDL_version structure that contains the version information | ||
| 136 | * | ||
| 137 | * \since This function is available since SDL 2.0.0. | ||
| 138 | * | ||
| 139 | * \sa SDL_GetRevision | ||
| 140 | */ | ||
| 141 | extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver); | ||
| 142 | |||
| 143 | /** | ||
| 144 | * Get the code revision of SDL that is linked against your program. | ||
| 145 | * | ||
| 146 | * This value is the revision of the code you are linked with and may be | ||
| 147 | * different from the code you are compiling with, which is found in the | ||
| 148 | * constant SDL_REVISION. | ||
| 149 | * | ||
| 150 | * The revision is arbitrary string (a hash value) uniquely identifying the | ||
| 151 | * exact revision of the SDL library in use, and is only useful in comparing | ||
| 152 | * against other revisions. It is NOT an incrementing number. | ||
| 153 | * | ||
| 154 | * If SDL wasn't built from a git repository with the appropriate tools, this | ||
| 155 | * will return an empty string. | ||
| 156 | * | ||
| 157 | * Prior to SDL 2.0.16, before development moved to GitHub, this returned a | ||
| 158 | * hash for a Mercurial repository. | ||
| 159 | * | ||
| 160 | * You shouldn't use this function for anything but logging it for debugging | ||
| 161 | * purposes. The string is not intended to be reliable in any way. | ||
| 162 | * | ||
| 163 | * \returns an arbitrary string, uniquely identifying the exact revision of | ||
| 164 | * the SDL library in use. | ||
| 165 | * | ||
| 166 | * \since This function is available since SDL 2.0.0. | ||
| 167 | * | ||
| 168 | * \sa SDL_GetVersion | ||
| 169 | */ | ||
| 170 | extern DECLSPEC const char *SDLCALL SDL_GetRevision(void); | ||
| 171 | |||
| 172 | /** | ||
| 173 | * Obsolete function, do not use. | ||
| 174 | * | ||
| 175 | * When SDL was hosted in a Mercurial repository, and was built carefully, | ||
| 176 | * this would return the revision number that the build was created from. This | ||
| 177 | * number was not reliable for several reasons, but more importantly, SDL is | ||
| 178 | * now hosted in a git repository, which does not offer numbers at all, only | ||
| 179 | * hashes. This function only ever returns zero now. Don't use it. | ||
| 180 | * | ||
| 181 | * Before SDL 2.0.16, this might have returned an unreliable, but non-zero | ||
| 182 | * number. | ||
| 183 | * | ||
| 184 | * \deprecated Use SDL_GetRevision() instead; if SDL was carefully built, it | ||
| 185 | * will return a git hash. | ||
| 186 | * | ||
| 187 | * \returns zero, always, in modern SDL releases. | ||
| 188 | * | ||
| 189 | * \since This function is available since SDL 2.0.0. | ||
| 190 | * | ||
| 191 | * \sa SDL_GetRevision | ||
| 192 | */ | ||
| 193 | extern SDL_DEPRECATED DECLSPEC int SDLCALL SDL_GetRevisionNumber(void); | ||
| 194 | |||
| 195 | |||
| 196 | /* Ends C function definitions when using C++ */ | ||
| 197 | #ifdef __cplusplus | ||
| 198 | } | ||
| 199 | #endif | ||
| 200 | #include "close_code.h" | ||
| 201 | |||
| 202 | #endif /* SDL_version_h_ */ | ||
| 203 | |||
| 204 | /* vi: set ts=4 sw=4 expandtab: */ | ||
