1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2022 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
36extern "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 */
51typedef 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 0
62#define SDL_PATCHLEVEL 20
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/**
87 * This macro turns the version numbers into a numeric value:
88 * \verbatim
89 (1,2,3) -> (1203)
90 \endverbatim
91 *
92 * This assumes that there will never be more than 100 patchlevels.
93 */
94#define SDL_VERSIONNUM(X, Y, Z) \
95 ((X)*1000 + (Y)*100 + (Z))
96
97/**
98 * This is the version number macro for the current SDL version.
99 */
100#define SDL_COMPILEDVERSION \
101 SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
102
103/**
104 * This macro will evaluate to true if compiled with SDL at least X.Y.Z.
105 */
106#define SDL_VERSION_ATLEAST(X, Y, Z) \
107 (SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
108
109/**
110 * Get the version of SDL that is linked against your program.
111 *
112 * If you are linking to SDL dynamically, then it is possible that the current
113 * version will be different than the version you compiled against. This
114 * function returns the current version, while SDL_VERSION() is a macro that
115 * tells you what version you compiled with.
116 *
117 * This function may be called safely at any time, even before SDL_Init().
118 *
119 * \param ver the SDL_version structure that contains the version information
120 *
121 * \since This function is available since SDL 2.0.0.
122 *
123 * \sa SDL_GetRevision
124 */
125extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver);
126
127/**
128 * Get the code revision of SDL that is linked against your program.
129 *
130 * This value is the revision of the code you are linked with and may be
131 * different from the code you are compiling with, which is found in the
132 * constant SDL_REVISION.
133 *
134 * The revision is arbitrary string (a hash value) uniquely identifying the
135 * exact revision of the SDL library in use, and is only useful in comparing
136 * against other revisions. It is NOT an incrementing number.
137 *
138 * If SDL wasn't built from a git repository with the appropriate tools, this
139 * will return an empty string.
140 *
141 * Prior to SDL 2.0.16, before development moved to GitHub, this returned a
142 * hash for a Mercurial repository.
143 *
144 * You shouldn't use this function for anything but logging it for debugging
145 * purposes. The string is not intended to be reliable in any way.
146 *
147 * \returns an arbitrary string, uniquely identifying the exact revision of
148 * the SDL library in use.
149 *
150 * \since This function is available since SDL 2.0.0.
151 *
152 * \sa SDL_GetVersion
153 */
154extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
155
156/**
157 * Obsolete function, do not use.
158 *
159 * When SDL was hosted in a Mercurial repository, and was built carefully,
160 * this would return the revision number that the build was created from. This
161 * number was not reliable for several reasons, but more importantly, SDL is
162 * now hosted in a git repository, which does not offer numbers at all, only
163 * hashes. This function only ever returns zero now. Don't use it.
164 *
165 * Before SDL 2.0.16, this might have returned an unreliable, but non-zero
166 * number.
167 *
168 * \deprecated Use SDL_GetRevision() instead; if SDL was carefully built, it
169 * will return a git hash.
170 *
171 * \returns zero, always, in modern SDL releases.
172 *
173 * \since This function is available since SDL 2.0.0.
174 *
175 * \sa SDL_GetRevision
176 */
177extern SDL_DEPRECATED DECLSPEC int SDLCALL SDL_GetRevisionNumber(void);
178
179
180/* Ends C function definitions when using C++ */
181#ifdef __cplusplus
182}
183#endif
184#include "close_code.h"
185
186#endif /* SDL_version_h_ */
187
188/* vi: set ts=4 sw=4 expandtab: */
189