Versioning

Versioning#

ROCTracer: Versioning
Versioning

Version information about the interface and the associated installed library. More...

Macros

#define ROCTRACER_VERSION_MAJOR   4
 The major version of the interface as a macro so it can be used by the preprocessor. More...
 
#define ROCTRACER_VERSION_MINOR   1
 The minor version of the interface as a macro so it can be used by the preprocessor. More...
 

Functions

ROCTRACER_API uint32_t roctracer_version_major () ROCTRACER_VERSION_4_1
 Query the major version of the installed library. More...
 
ROCTRACER_API uint32_t roctracer_version_minor () ROCTRACER_VERSION_4_1
 Query the minor version of the installed library. More...
 

Detailed Description

Version information about the interface and the associated installed library.

The semantic version of the interface following semver.org rules. A client that uses this interface is only compatible with the installed library if the major version numbers match and the interface minor version number is less than or equal to the installed library minor version number.

Macro Definition Documentation

◆ ROCTRACER_VERSION_MAJOR

#define ROCTRACER_VERSION_MAJOR   4

The major version of the interface as a macro so it can be used by the preprocessor.

◆ ROCTRACER_VERSION_MINOR

#define ROCTRACER_VERSION_MINOR   1

The minor version of the interface as a macro so it can be used by the preprocessor.

Function Documentation

◆ roctracer_version_major()

ROCTRACER_API uint32_t roctracer_version_major ( )

Query the major version of the installed library.

Return the major version of the installed library. This can be used to check if it is compatible with this interface version. This function can be used even when the library is not initialized.

◆ roctracer_version_minor()

ROCTRACER_API uint32_t roctracer_version_minor ( )

Query the minor version of the installed library.

Return the minor version of the installed library. This can be used to check if it is compatible with this interface version. This function can be used even when the library is not initialized.