version.h File Reference

Describe the materials API version. More...

#include <string>

Go to the source code of this file.

Classes
struct	materials::version
	Describe the materials API version and features. More...

Namespaces
	materials
	Top-level namespace of the Bayeux/materials module library.

Macros
#define	MATERIALS_VERSION_MAJOR   6
	Major version number of materials. More...
#define	MATERIALS_VERSION_MINOR   2
	Minor version number of materials. More...
#define	MATERIALS_VERSION_PATCH   0
	Patch version number of materials. More...
#define	MATERIALS_ENCODE_VERSION(major, minor, patch)
	Encode materials to ordered integer available at compile time. More...
#define	MATERIALS_VERSION
	Integer encoded materials version available at compile time. More...
#define	MATERIALS_LIB_VERSION   "6.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	MATERIALS_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the materials API version.

Querying the version of materials is needed at both compile and runtime by clients so that they may adjust their usage.

Macro Definition Documentation

MATERIALS_ENCODE_VERSION

#define MATERIALS_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

(     \
                   ((major) * 10000) \
                   + ((minor) *   100) \
                   + ((patch) *     1))

Encode materials to ordered integer available at compile time.

MATERIALS_IS_AT_LEAST

#define MATERIALS_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(     \
              MATERIALS_VERSION >=  \
              MATERIALS_ENCODE_VERSION(major,minor,patch))

Check current version >= (major, minor, patch) at compile time.

MATERIALS_LIB_VERSION

#define MATERIALS_LIB_VERSION   "6.2.0"

String encoded full version number, e.g. "1.2.3", available at compile time.

MATERIALS_VERSION

#define MATERIALS_VERSION

Value:

MATERIALS_ENCODE_VERSION(     \
               MATERIALS_VERSION_MAJOR, \
               MATERIALS_VERSION_MINOR, \
               MATERIALS_VERSION_PATCH)

Integer encoded materials version available at compile time.

MATERIALS_VERSION_MAJOR

#define MATERIALS_VERSION_MAJOR   6

Major version number of materials.

MATERIALS_VERSION_MINOR

#define MATERIALS_VERSION_MINOR   2

Minor version number of materials.

MATERIALS_VERSION_PATCH

#define MATERIALS_VERSION_PATCH   0

Patch version number of materials.