OpenVDB  7.2.0
version.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: MPL-2.0
3 
41 
42 #ifndef OPENVDB_VERSION_HAS_BEEN_INCLUDED
43 #define OPENVDB_VERSION_HAS_BEEN_INCLUDED
44 
45 #include "Platform.h"
46 #include <cstddef> // size_t
47 #include <cstdint> // uint32_t
48 
49 
50 // Library major, minor and patch version numbers
51 #define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER 7
52 #define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER 2
53 #define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER 0
54 
55 // If OPENVDB_ABI_VERSION_NUMBER is already defined (e.g., via -DOPENVDB_ABI_VERSION_NUMBER=N)
56 // use that ABI version. Otherwise, use this library version's default ABI.
57 #ifdef OPENVDB_ABI_VERSION_NUMBER
58  #if OPENVDB_ABI_VERSION_NUMBER > OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
59  #error expected OPENVDB_ABI_VERSION_NUMBER <= OPENVDB_LIBRARY_MAJOR VERSION_NUMBER
60  #endif
61 #else
62  #define OPENVDB_ABI_VERSION_NUMBER OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
63 #endif
64 
65 // If using an OPENVDB_ABI_VERSION_NUMBER that has been deprecated, issue a message
66 // directive. Note that an error is also set in openvdb.cc which enforces stricter
67 // behavior during compilation of the library. Both can be optionally suppressed
68 // by defining OPENVDB_USE_DEPRECATED_ABI_<VERSION>.
69 #ifndef OPENVDB_USE_DEPRECATED_ABI_5
70  #if OPENVDB_ABI_VERSION_NUMBER == 5
71  PRAGMA(message("NOTE: ABI = 5 is deprecated, CMake option OPENVDB_USE_DEPRECATED_ABI_5 "
72  "suppresses this message"))
73  #endif
74 #endif
75 
76 #if OPENVDB_ABI_VERSION_NUMBER == OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
77  #define OPENVDB_VERSION_NAME \
96  OPENVDB_PREPROC_CONCAT(v, \
97  OPENVDB_PREPROC_CONCAT(OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER, \
98  OPENVDB_PREPROC_CONCAT(_, OPENVDB_LIBRARY_MINOR_VERSION_NUMBER)))
99 #else
100  // This duplication of code is necessary to avoid issues with recursive macro expansion.
101  #define OPENVDB_VERSION_NAME \
102  OPENVDB_PREPROC_CONCAT(v, \
103  OPENVDB_PREPROC_CONCAT(OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER, \
104  OPENVDB_PREPROC_CONCAT(_, \
105  OPENVDB_PREPROC_CONCAT(OPENVDB_LIBRARY_MINOR_VERSION_NUMBER, \
106  OPENVDB_PREPROC_CONCAT(abi, OPENVDB_ABI_VERSION_NUMBER)))))
107 #endif
108 
114 #define OPENVDB_LIBRARY_VERSION_STRING \
115  OPENVDB_PREPROC_STRINGIFY(OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER) "." \
116  OPENVDB_PREPROC_STRINGIFY(OPENVDB_LIBRARY_MINOR_VERSION_NUMBER) "." \
117  OPENVDB_PREPROC_STRINGIFY(OPENVDB_LIBRARY_PATCH_VERSION_NUMBER)
118 
124 #define OPENVDB_LIBRARY_ABI_VERSION_STRING \
125  OPENVDB_LIBRARY_VERSION_STRING "abi" OPENVDB_PREPROC_STRINGIFY(OPENVDB_ABI_VERSION_NUMBER)
126 
128 #define OPENVDB_LIBRARY_VERSION_NUMBER \
129  ((OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER << 24) | \
130  ((OPENVDB_LIBRARY_MINOR_VERSION_NUMBER & 0xFF) << 16) | \
131  (OPENVDB_LIBRARY_PATCH_VERSION_NUMBER & 0xFFFF))
132 
133 
142 #ifdef OPENVDB_REQUIRE_VERSION_NAME
143 #define OPENVDB_USE_VERSION_NAMESPACE
144 #else
145 // The empty namespace clause below ensures that OPENVDB_VERSION_NAME
146 // is recognized as a namespace name.
147 #define OPENVDB_USE_VERSION_NAMESPACE \
148  namespace OPENVDB_VERSION_NAME {} \
149  using namespace OPENVDB_VERSION_NAME;
150 #endif
151 
152 
153 namespace openvdb {
155 namespace OPENVDB_VERSION_NAME {
156 
159 const int32_t OPENVDB_MAGIC = 0x56444220;
160 
161 // Library major, minor and patch version numbers
162 const uint32_t
168 // ABI version number
169 const uint32_t OPENVDB_ABI_VERSION = OPENVDB_ABI_VERSION_NUMBER;
170 
174 const uint32_t OPENVDB_FILE_VERSION = 224;
175 
177 enum {
192 };
193 
194 
196 inline constexpr const char* getLibraryVersionString() { return OPENVDB_LIBRARY_VERSION_STRING; }
198 inline constexpr const char* getLibraryAbiVersionString() {
200 }
201 
202 
203 struct VersionId {
204  uint32_t first, second;
205  VersionId(): first(0), second(0) {}
206  VersionId(uint32_t major, uint32_t minor): first(major), second(minor) {}
207 };
208 
209 } // namespace OPENVDB_VERSION_NAME
210 } // namespace openvdb
211 
212 #endif // OPENVDB_VERSION_HAS_BEEN_INCLUDED
openvdb::v7_2::OPENVDB_FILE_VERSION_SELECTIVE_COMPRESSION
@ OPENVDB_FILE_VERSION_SELECTIVE_COMPRESSION
Definition: version.h:186
openvdb::v7_2::OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION
@ OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION
Definition: version.h:188
PRAGMA
#define PRAGMA(x)
Definition: Platform.h:11
OPENVDB_LIBRARY_VERSION_STRING
#define OPENVDB_LIBRARY_VERSION_STRING
Library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:114
OPENVDB_LIBRARY_PATCH_VERSION_NUMBER
#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER
Definition: version.h:53
openvdb::v7_2::OPENVDB_FILE_VERSION_BOOL_LEAF_OPTIMIZATION
@ OPENVDB_FILE_VERSION_BOOL_LEAF_OPTIMIZATION
Definition: version.h:182
openvdb::v7_2::OPENVDB_FILE_VERSION_POINT_INDEX_GRID
@ OPENVDB_FILE_VERSION_POINT_INDEX_GRID
Definition: version.h:190
openvdb::v7_2::OPENVDB_FILE_VERSION_NO_GRIDMAP
@ OPENVDB_FILE_VERSION_NO_GRIDMAP
Definition: version.h:184
openvdb::v7_2::OPENVDB_FILE_VERSION_GRID_INSTANCING
@ OPENVDB_FILE_VERSION_GRID_INSTANCING
Definition: version.h:181
OPENVDB_LIBRARY_ABI_VERSION_STRING
#define OPENVDB_LIBRARY_ABI_VERSION_STRING
Library version number string of the form "<major>.<minor>.<patch>abi<abi>".
Definition: version.h:124
openvdb::v7_2::getLibraryAbiVersionString
constexpr const char * getLibraryAbiVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
Definition: version.h:198
Platform.h
openvdb::v7_2::VersionId::second
uint32_t second
Definition: version.h:204
OPENVDB_LIBRARY_VERSION_NUMBER
#define OPENVDB_LIBRARY_VERSION_NUMBER
Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
Definition: version.h:128
openvdb::v7_2::getLibraryVersionString
constexpr const char * getLibraryVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:196
openvdb::v7_2::OPENVDB_FILE_VERSION_NEW_TRANSFORM
@ OPENVDB_FILE_VERSION_NEW_TRANSFORM
Definition: version.h:185
openvdb::v7_2::VersionId::VersionId
VersionId(uint32_t major, uint32_t minor)
Definition: version.h:206
openvdb::v7_2::OPENVDB_LIBRARY_PATCH_VERSION
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION
Definition: version.h:165
openvdb::v7_2::OPENVDB_FILE_VERSION_BLOSC_COMPRESSION
@ OPENVDB_FILE_VERSION_BLOSC_COMPRESSION
Definition: version.h:189
openvdb::v7_2::VersionId
Definition: version.h:203
openvdb::v7_2::OPENVDB_FILE_VERSION_INTERNALNODE_COMPRESSION
@ OPENVDB_FILE_VERSION_INTERNALNODE_COMPRESSION
Definition: version.h:179
OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
Definition: version.h:51
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:147
openvdb::v7_2::VersionId::VersionId
VersionId()
Definition: version.h:205
openvdb::v7_2::OPENVDB_MAGIC
const int32_t OPENVDB_MAGIC
The magic number is stored in the first four bytes of every VDB file.
Definition: version.h:159
openvdb::v7_2::OPENVDB_FILE_VERSION_MULTIPASS_IO
@ OPENVDB_FILE_VERSION_MULTIPASS_IO
Definition: version.h:191
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:95
OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
Definition: version.h:52
openvdb::v7_2::OPENVDB_FILE_VERSION_ROOTNODE_MAP
@ OPENVDB_FILE_VERSION_ROOTNODE_MAP
Definition: version.h:178
openvdb::v7_2::OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX
@ OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX
Definition: version.h:187
openvdb::v7_2::OPENVDB_ABI_VERSION
const uint32_t OPENVDB_ABI_VERSION
Definition: version.h:169
openvdb::v7_2::OPENVDB_LIBRARY_VERSION
const uint32_t OPENVDB_LIBRARY_VERSION
Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
Definition: version.h:167
openvdb::v7_2::OPENVDB_LIBRARY_MINOR_VERSION
const uint32_t OPENVDB_LIBRARY_MINOR_VERSION
Definition: version.h:164
openvdb::v7_2::OPENVDB_FILE_VERSION_SIMPLIFIED_GRID_TYPENAME
@ OPENVDB_FILE_VERSION_SIMPLIFIED_GRID_TYPENAME
Definition: version.h:180
openvdb::v7_2::OPENVDB_FILE_VERSION_BOOST_UUID
@ OPENVDB_FILE_VERSION_BOOST_UUID
Definition: version.h:183
openvdb
Definition: openvdb/Exceptions.h:13
openvdb::v7_2::OPENVDB_LIBRARY_MAJOR_VERSION
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION
Definition: version.h:163
openvdb::v7_2::OPENVDB_FILE_VERSION
const uint32_t OPENVDB_FILE_VERSION
The current version number of the VDB file format.
Definition: version.h:174