Mercurial > sdl-ios-xcode

comparison include/SDL_version.h @ 4627:3b5f4b3a69e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation updates
author Sam Lantinga <slouken@libsdl.org>
date Thu, 29 Jul 2010 20:24:05 -0700
parents 5e7e1f1a4056
children b530ef003506
comparison
equal deleted inserted replaced
4626:2cfd55c58cd9 4627:3b5f4b3a69e1
110 #define SDL_VERSION_ATLEAST(X, Y, Z) \ 110 #define SDL_VERSION_ATLEAST(X, Y, Z) \
111 (SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z)) 111 (SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
112 112
113 /** 113 /**
114 * \brief Get the version of SDL that is linked against your program. 114 * \brief Get the version of SDL that is linked against your program.
115 *
116 * If you are using a shared library (DLL) version of SDL, then it is
117 * possible that it will be different than the version you compiled against.
118 * 115 *
119 * This is a real function; the macro SDL_VERSION() tells you what version 116 * If you are linking to SDL dynamically, then it is possible that the
120 * of SDL you compiled against: 117 * current version will be different than the version you compiled against.
118 * This function returns the current version, while SDL_VERSION() is a
119 * macro that tells you what version you compiled with.
121 * 120 *
122 * \code 121 * \code
123 * SDL_version compiled; 122 * SDL_version compiled;
124 * SDL_version linked; 123 * SDL_version linked;
125 * 124 *
138 extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver); 137 extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver);
139 138
140 /** 139 /**
141 * \brief Get the code revision of SDL that is linked against your program. 140 * \brief Get the code revision of SDL that is linked against your program.
142 * 141 *
143 * This is an arbitrary string (a hash value, actually), and is only useful 142 * Returns an arbitrary string (a hash value) uniquely identifying the
144 * in comparing against other revisions. It is NOT an incrementing number. 143 * exact revision of the SDL library in use, and is only useful in comparing
144 * against other revisions. It is NOT an incrementing number.
145 */ 145 */
146 extern DECLSPEC const char *SDLCALL SDL_GetRevision(void); 146 extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
147 147
148 /* Ends C function definitions when using C++ */ 148 /* Ends C function definitions when using C++ */
149 #ifdef __cplusplus 149 #ifdef __cplusplus