Ticket #36538: SDL_version.h

File SDL_version.h, 2.6 KB (added by mf2k (Frank Schima), 11 years ago)
Line 
1/*
2    SDL - Simple DirectMedia Layer
3    Copyright (C) 1997-2012 Sam Lantinga
4
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    This library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with this library; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
19    Sam Lantinga
20    slouken@libsdl.org
21*/
22
23/** @file SDL_version.h
24 *  This header defines the current SDL version
25 */
26
27#ifndef _SDL_version_h
28#define _SDL_version_h
29
30#include "SDL_stdinc.h"
31
32#include "begin_code.h"
33/* Set up for C function definitions, even when using C++ */
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/** @name Version Number
39 *  Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
40 */
41/*@{*/
42#define SDL_MAJOR_VERSION       1
43#define SDL_MINOR_VERSION       2
44#define SDL_PATCHLEVEL          15
45/*@}*/
46
47typedef struct SDL_version {
48        Uint8 major;
49        Uint8 minor;
50        Uint8 patch;
51} SDL_version;
52
53/**
54 * This macro can be used to fill a version structure with the compile-time
55 * version of the SDL library.
56 */
57#define SDL_VERSION(X)                                                  \
58{                                                                       \
59        (X)->major = SDL_MAJOR_VERSION;                                 \
60        (X)->minor = SDL_MINOR_VERSION;                                 \
61        (X)->patch = SDL_PATCHLEVEL;                                    \
62}
63
64/** This macro turns the version numbers into a numeric value:
65 *  (1,2,3) -> (1203)
66 *  This assumes that there will never be more than 100 patchlevels
67 */
68#define SDL_VERSIONNUM(X, Y, Z)                                         \
69        ((X)*1000 + (Y)*100 + (Z))
70
71/** This is the version number macro for the current SDL version */
72#define SDL_COMPILEDVERSION \
73        SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
74
75/** This macro will evaluate to true if compiled with SDL at least X.Y.Z */
76#define SDL_VERSION_ATLEAST(X, Y, Z) \
77        (SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
78
79/** This function gets the version of the dynamically linked SDL library.
80 *  it should NOT be used to fill a version structure, instead you should
81 *  use the SDL_Version() macro.
82 */
83extern DECLSPEC const SDL_version * SDLCALL SDL_Linked_Version(void);
84
85/* Ends C function definitions when using C++ */
86#ifdef __cplusplus
87}
88#endif
89#include "close_code.h"
90
91#endif /* _SDL_version_h */