include/SDL_version.h
author Gabriel Jacobo <gabomdq@gmail.com>
Fri, 16 Nov 2012 09:23:18 -0300
changeset 6674 45a21e50ba5e
parent 6250 cce0ddcf6747
child 6885 700f1b25f77f
permissions -rw-r--r--
Adds CMake build system by Marcus Von Appen (bug #1597)
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 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 /* *INDENT-OFF* */
    37 extern "C" {
    38 /* *INDENT-ON* */
    39 #endif
    40 
    41 /**
    42  *  \brief Information the version of SDL in use.
    43  *  
    44  *  Represents the library's version as three levels: major revision
    45  *  (increments with massive changes, additions, and enhancements),
    46  *  minor revision (increments with backwards-compatible changes to the
    47  *  major revision), and patchlevel (increments with fixes to the minor
    48  *  revision).
    49  *  
    50  *  \sa SDL_VERSION
    51  *  \sa SDL_GetVersion
    52  */
    53 typedef struct SDL_version
    54 {
    55     Uint8 major;        /**< major version */
    56     Uint8 minor;        /**< minor version */
    57     Uint8 patch;        /**< update version */
    58 } SDL_version;
    59 
    60 /* Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
    61 */
    62 #define SDL_MAJOR_VERSION	2
    63 #define SDL_MINOR_VERSION	0
    64 #define SDL_PATCHLEVEL		0
    65 
    66 /**
    67  *  \brief Macro to determine SDL version program was compiled against.
    68  *  
    69  *  This macro fills in a SDL_version structure with the version of the
    70  *  library you compiled against. This is determined by what header the
    71  *  compiler uses. Note that if you dynamically linked the library, you might
    72  *  have a slightly newer or older version at runtime. That version can be
    73  *  determined with SDL_GetVersion(), which, unlike SDL_VERSION(),
    74  *  is not a macro.
    75  *  
    76  *  \param x A pointer to a SDL_version struct to initialize.
    77  *  
    78  *  \sa SDL_version
    79  *  \sa SDL_GetVersion
    80  */
    81 #define SDL_VERSION(x)							\
    82 {									\
    83 	(x)->major = SDL_MAJOR_VERSION;					\
    84 	(x)->minor = SDL_MINOR_VERSION;					\
    85 	(x)->patch = SDL_PATCHLEVEL;					\
    86 }
    87 
    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 #define SDL_VERSIONNUM(X, Y, Z)						\
    97 	((X)*1000 + (Y)*100 + (Z))
    98 
    99 /**
   100  *  This is the version number macro for the current SDL version.
   101  */
   102 #define SDL_COMPILEDVERSION \
   103 	SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
   104 
   105 /**
   106  *  This macro will evaluate to true if compiled with SDL at least X.Y.Z.
   107  */
   108 #define SDL_VERSION_ATLEAST(X, Y, Z) \
   109 	(SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
   110 
   111 /**
   112  *  \brief Get the version of SDL that is linked against your program.
   113  *
   114  *  If you are linking to SDL dynamically, then it is possible that the
   115  *  current version will be different than the version you compiled against.
   116  *  This function returns the current version, while SDL_VERSION() is a
   117  *  macro that tells you what version you compiled with.
   118  *  
   119  *  \code
   120  *  SDL_version compiled;
   121  *  SDL_version linked;
   122  *  
   123  *  SDL_VERSION(&compiled);
   124  *  SDL_GetVersion(&linked);
   125  *  printf("We compiled against SDL version %d.%d.%d ...\n",
   126  *         compiled.major, compiled.minor, compiled.patch);
   127  *  printf("But we linked against SDL version %d.%d.%d.\n",
   128  *         linked.major, linked.minor, linked.patch);
   129  *  \endcode
   130  *  
   131  *  This function may be called safely at any time, even before SDL_Init().
   132  *  
   133  *  \sa SDL_VERSION
   134  */
   135 extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver);
   136 
   137 /**
   138  *  \brief Get the code revision of SDL that is linked against your program.
   139  *
   140  *  Returns an arbitrary string (a hash value) uniquely identifying the
   141  *  exact revision of the SDL library in use, and is only useful in comparing
   142  *  against other revisions. It is NOT an incrementing number.
   143  */
   144 extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
   145 
   146 /**
   147  *  \brief Get the revision number of SDL that is linked against your program.
   148  *
   149  *  Returns a number uniquely identifying the exact revision of the SDL
   150  *  library in use. It is an incrementing number based on commits to
   151  *  hg.libsdl.org.
   152  */
   153 extern DECLSPEC int SDLCALL SDL_GetRevisionNumber(void);
   154 
   155 
   156 /* Ends C function definitions when using C++ */
   157 #ifdef __cplusplus
   158 /* *INDENT-OFF* */
   159 }
   160 /* *INDENT-ON* */
   161 #endif
   162 #include "close_code.h"
   163 
   164 #endif /* _SDL_version_h */
   165 
   166 /* vi: set ts=4 sw=4 expandtab: */