Versioning of the Iray SDK API

The Iray SDK API has a major and minor version number and an optional qualifier. More...

Macros
#define	MI_NEURAYLIB_API_VERSION   55
	ABI version number. More...
#define	MI_NEURAYLIB_VERSION_MAJOR   4
	Iray SDK API major version number. More...
#define	MI_NEURAYLIB_VERSION_MINOR   1
	Iray SDK API minor version number. More...
#define	MI_NEURAYLIB_VERSION_QUALIFIER   ""
	Iray SDK API version qualifier. More...
#define	MI_NEURAYLIB_VERSION_STRING
	Iray SDK API major and minor version number without qualifier in a string representation, such as "2.0". More...
#define	MI_NEURAYLIB_VERSION_QUALIFIED_STRING   MI_NEURAYLIB_VERSION_STRING
	Iray SDK API major and minor version number and qualifier in a string representation, such as "2.0" or "2.0-beta2". More...
#define	MI_NEURAYLIB_PRODUCT_VERSION_STRING   "2024.0.2"
	The Iray SDK product version number in a string representation, such as "2.0". More...
#define	MI_NEURAYLIB_PLUGIN_TYPE   "neuray API v46"
	Type of plugins for the Iray SDK API. More...

Detailed Description

The Iray SDK API has a major and minor version number and an optional qualifier.

Version numbers and what they tell about compatibility across versions is explained in Base API Version Numbers and Compatibility.

Include File:

Macro Definition Documentation

MI_NEURAYLIB_API_VERSION

#define MI_NEURAYLIB_API_VERSION   55

ABI version number.

A change in this version number indicates that the binary compatibility of the interfaces offered through the shared library have changed.

Despite the name, this number tracks ABI changes, not API changes.

MI_NEURAYLIB_PLUGIN_TYPE

#define MI_NEURAYLIB_PLUGIN_TYPE   "neuray API v46"

Type of plugins for the Iray SDK API.

See also

mi::base::Plugin::get_type().

MI_NEURAYLIB_PRODUCT_VERSION_STRING

#define MI_NEURAYLIB_PRODUCT_VERSION_STRING   "2024.0.2"

The Iray SDK product version number in a string representation, such as "2.0".

MI_NEURAYLIB_VERSION_MAJOR

#define MI_NEURAYLIB_VERSION_MAJOR   4

Iray SDK API major version number.

See also

Base API Version Numbers and Compatibility

MI_NEURAYLIB_VERSION_MINOR

#define MI_NEURAYLIB_VERSION_MINOR   1

Iray SDK API minor version number.

See also

Base API Version Numbers and Compatibility

MI_NEURAYLIB_VERSION_QUALIFIED_STRING

#define MI_NEURAYLIB_VERSION_QUALIFIED_STRING   MI_NEURAYLIB_VERSION_STRING

Iray SDK API major and minor version number and qualifier in a string representation, such as "2.0" or "2.0-beta2".

MI_NEURAYLIB_VERSION_QUALIFIER

#define MI_NEURAYLIB_VERSION_QUALIFIER   ""

Iray SDK API version qualifier.

The version qualifier is a string such as "alpha", "beta", or "beta2", or the empty string "" if this is a final release, in which case the macro MI_NEURAYLIB_VERSION_QUALIFIER_EMPTY is defined as well.

See also

Base API Version Numbers and Compatibility

MI_NEURAYLIB_VERSION_STRING

#define MI_NEURAYLIB_VERSION_STRING

Value:

                                     MI_BASE_STRINGIZE(MI_NEURAYLIB_VERSION_MAJOR) "." \
                                     MI_BASE_STRINGIZE(MI_NEURAYLIB_VERSION_MINOR)

Iray SDK API major and minor version number without qualifier in a string representation, such as "2.0".