Querying SDL Version

Functionality to query the current SDL version, both as headers the app was compiled against, and a library the app is linked to. More...

Macros
#define	SDL_MAJOR_VERSION
	The current major version of SDL headers.
#define	SDL_MINOR_VERSION
	The current minor version of the SDL headers.
#define	SDL_MICRO_VERSION
	The current micro (or patchlevel) version of the SDL headers.
#define	SDL_VERSIONNUM(major, minor, patch)
	This macro turns the version numbers into a numeric value.
#define	SDL_VERSIONNUM_MAJOR(version)
	This macro extracts the major version from a version number.
#define	SDL_VERSIONNUM_MINOR(version)
	This macro extracts the minor version from a version number.
#define	SDL_VERSIONNUM_MICRO(version)
	This macro extracts the micro version from a version number.
#define	SDL_VERSION   SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_MICRO_VERSION)
	This is the version number macro for the current SDL version.
#define	SDL_VERSION_ATLEAST(X, Y, Z)
	This macro will evaluate to true if compiled with SDL at least X.Y.Z.
#define	SDL3PP_MAJOR_VERSION   0
	The current major version of SDL3pp wrapper.
#define	SDL3PP_MINOR_VERSION   10
	The current minor version of SDL3pp wrapper.
#define	SDL3PP_PATCH_VERSION   1
	The current patch version of SDL3pp wrapper.
#define	SDL3PP_VERSION
	This is the version number macro for the current SDL3pp wrapper version.

Functions
int	SDL::GetVersion ()
	Get the version of SDL that is linked against your program.
const char *	SDL::GetRevision ()
	Get the code revision of the SDL library that is linked against your program.

Detailed Description

Functionality to query the current SDL version, both as headers the app was compiled against, and a library the app is linked to.

Macro Definition Documentation

SDL3PP_VERSION

#define SDL3PP_VERSION

Value:

SDL_VERSIONNUM(                                                              \
  SDL3PP_MAJOR_VERSION, SDL3PP_MINOR_VERSION, SDL3PP_MICRO_VERSION)

This is the version number macro for the current SDL3pp wrapper version.

SDL_MAJOR_VERSION

#define SDL_MAJOR_VERSION

The current major version of SDL headers.

If this were SDL version 3.2.1, this value would be 3.

Since

This macro is available since SDL 3.2.0.

SDL_MICRO_VERSION

#define SDL_MICRO_VERSION

The current micro (or patchlevel) version of the SDL headers.

If this were SDL version 3.2.1, this value would be 1.

Since

This macro is available since SDL 3.2.0.

SDL_MINOR_VERSION

#define SDL_MINOR_VERSION

The current minor version of the SDL headers.

If this were SDL version 3.2.1, this value would be 2.

Since

This macro is available since SDL 3.2.0.

SDL_VERSION

#define SDL_VERSION   SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_MICRO_VERSION)

This is the version number macro for the current SDL version.

Thread safety:

It is safe to call this macro from any thread.

Since

This macro is available since SDL 3.2.0.

See also

GetVersion

SDL_VERSION_ATLEAST

#define SDL_VERSION_ATLEAST	(		X,
			Y,
			Z )

Value:

(SDL_VERSION >= SDL_VERSIONNUM(X, Y, Z))

This macro will evaluate to true if compiled with SDL at least X.Y.Z.

Thread safety:

It is safe to call this macro from any thread.

Since

This macro is available since SDL 3.2.0.

SDL_VERSIONNUM

#define SDL_VERSIONNUM	(		major,
			minor,
			patch )

Value:

((major) * 1000000 + (minor) * 1000 + (patch))

This macro turns the version numbers into a numeric value.

(1,2,3) becomes 1002003.

Parameters

major	the major version number.
minor	the minorversion number.
patch	the patch version number.

Since

This macro is available since SDL 3.2.0.

SDL_VERSIONNUM_MAJOR

#define SDL_VERSIONNUM_MAJOR

(

version

)

Value:

((version) / 1000000)

This macro extracts the major version from a version number.

1002003 becomes 1.

Parameters

version

the version number.

Thread safety:

It is safe to call this macro from any thread.

Since

This macro is available since SDL 3.2.0.

SDL_VERSIONNUM_MICRO

#define SDL_VERSIONNUM_MICRO

(

version

)

Value:

((version) % 1000)

This macro extracts the micro version from a version number.

1002003 becomes 3.

Parameters

version

the version number.

Thread safety:

It is safe to call this macro from any thread.

Since

This macro is available since SDL 3.2.0.

SDL_VERSIONNUM_MINOR

#define SDL_VERSIONNUM_MINOR

(

version

)

Value:

(((version) / 1000) % 1000)

This macro extracts the minor version from a version number.

1002003 becomes 2.

Parameters

version

the version number.

Thread safety:

It is safe to call this macro from any thread.

Since

This macro is available since SDL 3.2.0.

Function Documentation

GetRevision()

const char * SDL::GetRevision ( )

inline

Get the code revision of the SDL library that is linked against your program.

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 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 against other revisions. It is NOT an incrementing number.

If SDL wasn't built from a git repository with the appropriate tools, this will return an empty string.

You shouldn't use this function for anything but logging it for debugging purposes. The string is not intended to be reliable in any way.

Returns

an arbitrary string, uniquely identifying the exact revision of the SDL library in use.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

GetVersion

GetVersion()

int SDL::GetVersion ( )

inline

Get the version of SDL that is linked against your program.

If you are linking to SDL dynamically, then it is possible that the current version will be different than the version you compiled against. This function returns the current version, while SDL_VERSION is the version you compiled with.

This function may be called safely at any time, even before Init().

Returns

the version of the linked library.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

GetRevision