Library Versioning

Library Versioning#

ROCProfilerV1 API: Library Versioning
Library Versioning

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

Macros

#define ROCPROFILER_VERSION_MAJOR   9
 The major version of the interface as a macro so it can be used by the preprocessor. More...
 
#define ROCPROFILER_VERSION_MINOR   0
 The minor version of the interface as a macro so it can be used by the preprocessor. More...
 

Functions

ROCPROFILER_API uint32_t rocprofiler_version_major ()
 Query the major version of the installed library. More...
 
ROCPROFILER_API uint32_t rocprofiler_version_minor ()
 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

◆ ROCPROFILER_VERSION_MAJOR

#define ROCPROFILER_VERSION_MAJOR   9

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

◆ ROCPROFILER_VERSION_MINOR

#define ROCPROFILER_VERSION_MINOR   0

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

Function Documentation

◆ rocprofiler_version_major()

ROCPROFILER_API uint32_t rocprofiler_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.

◆ rocprofiler_version_minor()

ROCPROFILER_API uint32_t rocprofiler_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.