Document need to include SDL_revision.h

If you want access to the SDL_REVISION define,
you must explicitly include this header.

Language like this was present in the SDL2 version,
but disappeared in SDL3, even though it's still true.
This commit is contained in:
Eddy Jansson
2025-12-05 09:02:43 +01:00
committed by Sam Lantinga
parent 82593fd6c1
commit 37715c4029
2 changed files with 4 additions and 1 deletions

View File

@@ -44,6 +44,9 @@
* clue in debugging forensics and not something the app will parse in any
* way.
*
* SDL_revision.h must be included in your program explicitly if you want access
* to the SDL_REVISION constant.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_REVISION "Some arbitrary string decided at SDL build time"

View File

@@ -153,7 +153,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetVersion(void);
*
* This value is the revision of the code you are linking against and may be
* different from the code you are compiling with, which is found in the
* constant SDL_REVISION.
* constant SDL_REVISION if you explicitly include SDL_revision.h
*
* The revision is an arbitrary string (a hash value) uniquely identifying the
* exact revision of the SDL library in use, and is only useful in comparing