version.h.in File Reference

Library and file format version numbers. More...

#include "openvdb/Platform.h"
#include <cstddef>
#include <cstdint>

Classes
struct	VersionId

Namespaces
namespace	openvdb
namespace	openvdb::v13_0

Macros
#define	OPENVDB_VERSION_HAS_BEEN_INCLUDED
#define	OPENVDB_LIBRARY_VERSION_STRING
	Library version number string of the form "<major>.<minor>.<patch>".
#define	OPENVDB_LIBRARY_ABI_VERSION_STRING
	Library version number string of the form "<major>.<minor>.<patch>abi<abi>".
#define	OPENVDB_LIBRARY_VERSION_NUMBER
	Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
#define	OPENVDB_PACKAGE_URL   "@OPENVDB_PACKAGE_URL@"
	Where this version was compiled from if it comes from a git repo.
#define	OPENVDB_PACKAGE_REVISION   "@OPENVDB_PACKAGE_REVISION@"
#define	OPENVDB_VERSION_NAME
	The version namespace name for this library version.
#define	OPENVDB_USE_IMATH_HALF
#define	OPENVDB_IMATH_VERSION
#define	OPENVDB_USE_BLOSC
#define	OPENVDB_USE_ZLIB
#define	OPENVDB_USE_DELAYED_LOADING
#define	OPENVDB_ENABLE_ASSERTS
#define	OPENVDB_ENABLE_VEC_RELATIONAL_OPERATIONS
#define	OPENVDB_USE_VCL
#define	OPENVDB_VCL_NAMESPACE   openvdb_ext_vcl
#define	OPENVDB_X86_INSTRSET   ${OPENVDB_X86_INSTRSET}
#define	OPENVDB_USE_AVX
#define	OPENVDB_USE_SSE42
#define	OPENVDB_USE_EXPLICIT_INSTANTIATION
#define	OPENVDB_INSTANTIATE   extern template OPENVDB_TEMPLATE_IMPORT
#define	OPENVDB_INSTANTIATE_CLASS   extern template class OPENVDB_TEMPLATE_IMPORT
#define	OPENVDB_INSTANTIATE_STRUCT   extern template struct OPENVDB_TEMPLATE_IMPORT
#define	OPENVDB_REAL_TREE_INSTANTIATE(Function)
#define	OPENVDB_NUMERIC_TREE_INSTANTIATE(Function)
#define	OPENVDB_VEC3_TREE_INSTANTIATE(Function)
#define	OPENVDB_VOLUME_TREE_INSTANTIATE(Function)
#define	OPENVDB_ALL_TREE_INSTANTIATE(Function)
#define	OPENVDB_USE_VERSION_NAMESPACE
#define	OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
	Library major, minor and patch version numbers.
#define	OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
	Library major, minor and patch version numbers.
#define	OPENVDB_LIBRARY_PATCH_VERSION_NUMBER
	Library major, minor and patch version numbers.

Enumerations
enum	{   OPENVDB_FILE_VERSION_ROOTNODE_MAP = 213 , OPENVDB_FILE_VERSION_INTERNALNODE_COMPRESSION = 214 , OPENVDB_FILE_VERSION_SIMPLIFIED_GRID_TYPENAME = 215 , OPENVDB_FILE_VERSION_GRID_INSTANCING = 216 ,   OPENVDB_FILE_VERSION_BOOL_LEAF_OPTIMIZATION = 217 , OPENVDB_FILE_VERSION_BOOST_UUID = 218 , OPENVDB_FILE_VERSION_NO_GRIDMAP = 219 , OPENVDB_FILE_VERSION_NEW_TRANSFORM = 219 ,   OPENVDB_FILE_VERSION_SELECTIVE_COMPRESSION = 220 , OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX = 221 , OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION = 222 , OPENVDB_FILE_VERSION_BLOSC_COMPRESSION = 223 ,   OPENVDB_FILE_VERSION_POINT_INDEX_GRID = 223 , OPENVDB_FILE_VERSION_MULTIPASS_IO = 224 , OPENVDB_FILE_VERSION_HALF_GRID = 225 }
	Notable file format version numbers. More...

Functions
constexpr const char *	getLibraryVersionString ()
	Return a library version number string of the form "<major>.<minor>.<patch>".
constexpr const char *	getLibraryAbiVersionString ()
	Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
constexpr const char *	getPackageUrl ()
constexpr const char *	getPackageRevision ()

Variables
const int32_t	OPENVDB_MAGIC = 0x56444220
	The magic number is stored in the first four bytes of every VDB file.
const uint32_t	OPENVDB_LIBRARY_MAJOR_VERSION
const uint32_t	OPENVDB_LIBRARY_MINOR_VERSION = ${OpenVDB_MINOR_VERSION}
const uint32_t	OPENVDB_LIBRARY_PATCH_VERSION = ${OpenVDB_PATCH_VERSION}
const uint32_t	OPENVDB_LIBRARY_VERSION
const uint32_t	OPENVDB_ABI_VERSION
const uint32_t	OPENVDB_FILE_VERSION = 225
	The current version number of the VDB file format.

Detailed Description

Library and file format version numbers.

When the library is built with the latest ABI, its namespace has the form openvdb::vX_Y, where X and Y are the major and minor version numbers.

The library can be built using an older ABI by changing the value of the OPENVDB_ABI_VERSION_NUMBER. (e.g., via -DOPENVDB_ABI_VERSION_NUMBER=N). In that case, the namespace has the form openvdb::vX_YabiN, where N is the ABI version number.

The ABI version must be set consistently when building code that depends on OpenVDB.

The ABI version number defaults to the library major version number, which gets incremented whenever changes are made to the ABI of the Grid class or related classes (Tree, Transform, Metadata, etc.). Setting the ABI version number to an earlier library version number disables grid ABI changes made since that library version.

The library minor version number gets incremented whenever a change is made to any aspect of the public API (not just the grid API) that necessitates changes to client code. Changes to APIs in private or internal namespaces do not trigger a minor version number increment; such APIs should not be used in client code.

A patch version number increment indicates a change—usually a new feature or a bug fix—that does not necessitate changes to client code but rather only recompilation of that code (because the library namespace incorporates the version number).

The file format version number gets incremented when it becomes possible to write files that cannot safely be read with older versions of the library. Not all files written in a newer format are incompatible with older libraries, however. And in general, files containing grids of unknown type can be read safely, although the unknown grids will not be accessible.

Macro Definition Documentation

OPENVDB_ALL_TREE_INSTANTIATE

#define OPENVDB_ALL_TREE_INSTANTIATE

(

Function

)

Value:

@OPENVDB_ALL_TREE_INSTANTIATIONS@

OPENVDB_ENABLE_ASSERTS

#define OPENVDB_ENABLE_ASSERTS

OPENVDB_ENABLE_VEC_RELATIONAL_OPERATIONS

#define OPENVDB_ENABLE_VEC_RELATIONAL_OPERATIONS

OPENVDB_IMATH_VERSION

#define OPENVDB_IMATH_VERSION

OPENVDB_INSTANTIATE

#define OPENVDB_INSTANTIATE   extern template OPENVDB_TEMPLATE_IMPORT

OPENVDB_INSTANTIATE_CLASS

#define OPENVDB_INSTANTIATE_CLASS   extern template class OPENVDB_TEMPLATE_IMPORT

OPENVDB_INSTANTIATE_STRUCT

#define OPENVDB_INSTANTIATE_STRUCT   extern template struct OPENVDB_TEMPLATE_IMPORT

OPENVDB_LIBRARY_ABI_VERSION_STRING

#define OPENVDB_LIBRARY_ABI_VERSION_STRING

Library version number string of the form "<major>.<minor>.<patch>abi<abi>".

This is a macro rather than a static constant because we typically want the compile-time version number, not the runtime version number (although the two are usually the same).

OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER

#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER

Library major, minor and patch version numbers.

OPENVDB_LIBRARY_MINOR_VERSION_NUMBER

#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER

Library major, minor and patch version numbers.

OPENVDB_LIBRARY_PATCH_VERSION_NUMBER

#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER

Library major, minor and patch version numbers.

OPENVDB_LIBRARY_VERSION_NUMBER

#define OPENVDB_LIBRARY_VERSION_NUMBER

Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)

OPENVDB_LIBRARY_VERSION_STRING

#define OPENVDB_LIBRARY_VERSION_STRING

Library version number string of the form "<major>.<minor>.<patch>".

Note

This ifndef exists for compatibility with older versions of OpenVDB. This value should never be different from the value configured when OpenVDB was built, but this previously needed to be defined by downstream software. Redefining it here would cause build failures, so this allows users to transition and remove the define in their build systems.

This is a macro rather than a static constant because we typically want the compile-time version number, not the runtime version number (although the two are usually the same).

OPENVDB_NUMERIC_TREE_INSTANTIATE

#define OPENVDB_NUMERIC_TREE_INSTANTIATE

(

Function

)

Value:

@OPENVDB_NUMERIC_TREE_INSTANTIATIONS@

OPENVDB_PACKAGE_REVISION

#define OPENVDB_PACKAGE_REVISION   "@OPENVDB_PACKAGE_REVISION@"

OPENVDB_PACKAGE_URL

#define OPENVDB_PACKAGE_URL   "@OPENVDB_PACKAGE_URL@"

Where this version was compiled from if it comes from a git repo.

OPENVDB_REAL_TREE_INSTANTIATE

#define OPENVDB_REAL_TREE_INSTANTIATE

(

Function

)

Value:

@OPENVDB_REAL_TREE_INSTANTIATIONS@

OPENVDB_USE_AVX

#define OPENVDB_USE_AVX

Denotes if OpenVDB was configured with -D OPENVDB_SIMD=AVX. Note that absence of this define does not indicate that no AVX instructions were used (i.e. -mavx could have been manually provided, or manual instruction rolling could be present). This flag primarily indicates the desired ISA.

OPENVDB_USE_BLOSC

#define OPENVDB_USE_BLOSC

OPENVDB_USE_DELAYED_LOADING

#define OPENVDB_USE_DELAYED_LOADING

OPENVDB_USE_EXPLICIT_INSTANTIATION

#define OPENVDB_USE_EXPLICIT_INSTANTIATION

OPENVDB_USE_IMATH_HALF

#define OPENVDB_USE_IMATH_HALF

OPENVDB_USE_SSE42

#define OPENVDB_USE_SSE42

Denotes if OpenVDB was configured with -D OPENVDB_SIMD=AVX|SSE42. Note that absence of this define does not indicate that no SSE42 instructions were used (i.e. -msse4.2 could have been manually provided, or manual instruction rolling could be present). This flag primarily indicates the desired ISA.

OPENVDB_USE_VCL

#define OPENVDB_USE_VCL

OPENVDB_USE_VERSION_NAMESPACE

#define OPENVDB_USE_VERSION_NAMESPACE

By default, the OPENVDB_REQUIRE_VERSION_NAME macro is undefined, and symbols from the version namespace are promoted to the top-level namespace so that, for example, openvdb::v5_0::io::File can be referred to simply as openvdb::io::File.

When OPENVDB_REQUIRE_VERSION_NAME is defined, symbols must be fully namespace-qualified.

OPENVDB_USE_ZLIB

#define OPENVDB_USE_ZLIB

OPENVDB_VCL_NAMESPACE

#define OPENVDB_VCL_NAMESPACE   openvdb_ext_vcl

OPENVDB_VEC3_TREE_INSTANTIATE

#define OPENVDB_VEC3_TREE_INSTANTIATE

(

Function

)

Value:

@OPENVDB_VEC3_TREE_INSTANTIATIONS@

OPENVDB_VERSION_HAS_BEEN_INCLUDED

#define OPENVDB_VERSION_HAS_BEEN_INCLUDED

OPENVDB_VERSION_NAME

#define OPENVDB_VERSION_NAME

The version namespace name for this library version.

When the ABI version number matches the library major version number, symbols are named as in the following examples:

• openvdb::vX_Y::Vec3i
• openvdb::vX_Y::io::File
• openvdb::vX_Y::tree::Tree

where X and Y are the major and minor version numbers.

When the ABI version number does not match the library major version number, symbol names include the ABI version:

• openvdb::vX_YabiN::Vec3i
• openvdb::vX_YabiN::io::File
• openvdb::vX_YabiN::tree::Tree

where X, Y and N are the major, minor and ABI version numbers, respectively.

OPENVDB_VOLUME_TREE_INSTANTIATE

#define OPENVDB_VOLUME_TREE_INSTANTIATE

(

Function

)

Value:

@OPENVDB_VOLUME_TREE_INSTANTIATIONS@

OPENVDB_X86_INSTRSET

#define OPENVDB_X86_INSTRSET   ${OPENVDB_X86_INSTRSET}