Bläddra i källkod

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.
Eddy Jansson 1 vecka sedan
förälder
incheckning
37715c4029
2 ändrade filer med 4 tillägg och 1 borttagningar
  1. 3 0
      include/SDL3/SDL_revision.h
  2. 1 1
      include/SDL3/SDL_version.h

+ 3 - 0
include/SDL3/SDL_revision.h

@@ -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"

+ 1 - 1
include/SDL3/SDL_version.h

@@ -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