HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
version.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: Apache-2.0
3 
4 /// @file openvdb/version.h
5 /// @brief Library and file format version numbers
6 ///
7 /// @details
8 /// When the library is built with the latest ABI, its namespace has the form
9 /// <B>openvdb::vX_Y</B>, where @e X and @e Y are the major and minor version
10 /// numbers.
11 ///
12 /// The library can be built using an older ABI by changing the value of the
13 /// @b OPENVDB_ABI_VERSION_NUMBER. (e.g., via <TT>-DOPENVDB_ABI_VERSION_NUMBER=<I>N</I></TT>).
14 /// In that case, the namespace has the form <B>openvdb::vX_YabiN</B>,
15 /// where N is the ABI version number.
16 ///
17 /// The ABI version must be set consistently when building code that depends on
18 /// OpenVDB.
19 ///
20 /// The ABI version number defaults to the library major version number, which
21 /// gets incremented whenever changes are made to the ABI of the Grid class or
22 /// related classes (Tree, Transform, Metadata, etc.). Setting the ABI version
23 /// number to an earlier library version number disables grid ABI changes made
24 /// since that library version.
25 ///
26 /// The library minor version number gets incremented whenever a change is made
27 /// to any aspect of the public API (not just the grid API) that necessitates
28 /// changes to client code. Changes to APIs in private or internal namespaces
29 /// do not trigger a minor version number increment; such APIs should not be
30 /// used in client code.
31 ///
32 /// A patch version number increment indicates a change&mdash;usually a new
33 /// feature or a bug fix&mdash;that does not necessitate changes to client code
34 /// but rather only recompilation of that code (because the library namespace
35 /// incorporates the version number).
36 ///
37 /// The file format version number gets incremented when it becomes possible to
38 /// write files that cannot safely be read with older versions of the library.
39 /// Not all files written in a newer format are incompatible with older
40 /// libraries, however. And in general, files containing grids of unknown type
41 /// can be read safely, although the unknown grids will not be accessible.
42 
43 #ifndef OPENVDB_VERSION_HAS_BEEN_INCLUDED
44 #define OPENVDB_VERSION_HAS_BEEN_INCLUDED
45 
46 #include "openvdb/Platform.h"
47 
48 #include <cstddef> // size_t
49 #include <cstdint> // uint32_t
50 
51 ///////////////////////////////////////////////////////////////////////////////
52 ///////////////////////////////////////////////////////////////////////////////
53 
54 // Auto generated build configurations from CMake
55 
56 ///@{
57 /// @brief Library major, minor and patch version numbers
58 /// @hideinitializer
59 #define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER 12
60 /// @hideinitializer
61 #define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER 0
62 /// @hideinitializer
63 #define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER 1
64 ///@}
65 
66 /// @note This ifndef exists for compatibility with older versions of OpenVDB.
67 /// This value should never be different from the value configured when
68 /// OpenVDB was built, but this previously needed to be defined by downstream
69 /// software. Redefining it here would cause build failures, so this allows
70 /// users to transition and remove the define in their build systems.
71 #ifndef OPENVDB_ABI_VERSION_NUMBER
72 /// @brief The ABI version that OpenVDB was built with
73 /// @hideinitializer
74 #define OPENVDB_ABI_VERSION_NUMBER 12
75 #endif
76 
77 /// @brief Library version number string of the form "<major>.<minor>.<patch>"
78 /// @details This is a macro rather than a static constant because we typically
79 /// want the compile-time version number, not the runtime version number
80 /// (although the two are usually the same).
81 /// @hideinitializer
82 #define OPENVDB_LIBRARY_VERSION_STRING "12.0.1"
83 
84 /// @brief Library version number string of the form "<major>.<minor>.<patch>abi<abi>"
85 /// @details This is a macro rather than a static constant because we typically
86 /// want the compile-time version number, not the runtime version number
87 /// (although the two are usually the same).
88 /// @hideinitializer
89 #define OPENVDB_LIBRARY_ABI_VERSION_STRING "12.0.1abi12"
90 
91 /// @brief Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
92 /// @hideinitializer
93 #define OPENVDB_LIBRARY_VERSION_NUMBER 201326593
94 
95 /// @brief Where this version was compiled from if it comes from a
96 /// git repo.
97 #define OPENVDB_PACKAGE_URL "https://github.com/sideeffects/openvdb_dev.git"
98 #define OPENVDB_PACKAGE_REVISION "bade7829a098a3e4066740cfc49588ad7cf668c7"
99 
100 /// @brief The version namespace name for this library version
101 /// @hideinitializer
102 ///
103 /// When the ABI version number matches the library major version number,
104 /// symbols are named as in the following examples:
105 /// - @b openvdb::vX_Y::Vec3i
106 /// - @b openvdb::vX_Y::io::File
107 /// - @b openvdb::vX_Y::tree::Tree
108 ///
109 /// where X and Y are the major and minor version numbers.
110 ///
111 /// When the ABI version number does not match the library major version number,
112 /// symbol names include the ABI version:
113 /// - @b openvdb::vX_YabiN::Vec3i
114 /// - @b openvdb::vX_YabiN::io::File
115 /// - @b openvdb::vX_YabiN::tree::Tree
116 ///
117 /// where X, Y and N are the major, minor and ABI version numbers, respectively.
118 #if OPENVDB_ABI_VERSION_NUMBER == OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
119  #define OPENVDB_VERSION_NAME v12_0_sesi
120 #else
121  #define OPENVDB_VERSION_NAME v12_0_sesi_abi12
122 #endif
123 
124 /* Denotes whether VDB was built with IMath Half support */
125 #ifndef OPENVDB_USE_IMATH_HALF
126 /* #undef OPENVDB_USE_IMATH_HALF */
127 /* Denotes whether VDB was built against Imath 3+ */
128 /* #undef OPENVDB_IMATH_VERSION */
129 #endif
130 
131 /* Denotes whether VDB was built with Blosc support */
132 #ifndef OPENVDB_USE_BLOSC
133 #define OPENVDB_USE_BLOSC
134 #endif
135 
136 /* Denotes whether VDB was built with ZLIB support */
137 #ifndef OPENVDB_USE_ZLIB
138 #define OPENVDB_USE_ZLIB
139 #endif
140 
141 /* Denotes whether VDB was built with Delayed Loading support */
142 #ifndef OPENVDB_USE_DELAYED_LOADING
143 #define OPENVDB_USE_DELAYED_LOADING
144 #endif
145 
146 /* Denotes whether VDB was built asserts enabled in VDB code */
147 #ifndef OPENVDB_ENABLE_ASSERTS
148 /* #undef OPENVDB_ENABLE_ASSERTS */
149 #endif
150 
151 /* Denotes whether VDB was built with explicit template instantiation */
152 #ifndef OPENVDB_USE_EXPLICIT_INSTANTIATION
153 #define OPENVDB_USE_EXPLICIT_INSTANTIATION
154 #endif
155 
156 /* Defines the macros for explicit template declarations. */
157 #define OPENVDB_INSTANTIATE extern template OPENVDB_TEMPLATE_IMPORT
158 #define OPENVDB_INSTANTIATE_CLASS extern template class OPENVDB_TEMPLATE_IMPORT
159 #define OPENVDB_INSTANTIATE_STRUCT extern template struct OPENVDB_TEMPLATE_IMPORT
160 
161 /* Defines the macros for explicit template instantiations. */
162 #define OPENVDB_REAL_TREE_INSTANTIATE(Function) \
163  OPENVDB_INSTANTIATE Function(FloatTree); \
164  OPENVDB_INSTANTIATE Function(DoubleTree);
165 #define OPENVDB_NUMERIC_TREE_INSTANTIATE(Function) \
166  OPENVDB_INSTANTIATE Function(Int32Tree); \
167  OPENVDB_INSTANTIATE Function(Int64Tree); \
168  OPENVDB_INSTANTIATE Function(FloatTree); \
169  OPENVDB_INSTANTIATE Function(DoubleTree);
170 #define OPENVDB_VEC3_TREE_INSTANTIATE(Function) \
171  OPENVDB_INSTANTIATE Function(Vec3STree); \
172  OPENVDB_INSTANTIATE Function(Vec3DTree); \
173  OPENVDB_INSTANTIATE Function(Vec3ITree);
174 #define OPENVDB_VOLUME_TREE_INSTANTIATE(Function) \
175  OPENVDB_INSTANTIATE Function(BoolTree); \
176  OPENVDB_INSTANTIATE Function(Int32Tree); \
177  OPENVDB_INSTANTIATE Function(Int64Tree); \
178  OPENVDB_INSTANTIATE Function(FloatTree); \
179  OPENVDB_INSTANTIATE Function(DoubleTree); \
180  OPENVDB_INSTANTIATE Function(Vec3STree); \
181  OPENVDB_INSTANTIATE Function(Vec3DTree); \
182  OPENVDB_INSTANTIATE Function(Vec3ITree);
183 #define OPENVDB_ALL_TREE_INSTANTIATE(Function) \
184  OPENVDB_INSTANTIATE Function(MaskTree); \
185  OPENVDB_INSTANTIATE Function(points::PointDataTree); \
186  OPENVDB_INSTANTIATE Function(BoolTree); \
187  OPENVDB_INSTANTIATE Function(Int32Tree); \
188  OPENVDB_INSTANTIATE Function(Int64Tree); \
189  OPENVDB_INSTANTIATE Function(FloatTree); \
190  OPENVDB_INSTANTIATE Function(DoubleTree); \
191  OPENVDB_INSTANTIATE Function(Vec3STree); \
192  OPENVDB_INSTANTIATE Function(Vec3DTree); \
193  OPENVDB_INSTANTIATE Function(Vec3ITree);
194 
195 
196 ///////////////////////////////////////////////////////////////////////////////
197 ///////////////////////////////////////////////////////////////////////////////
198 
199 
200 #if OPENVDB_ABI_VERSION_NUMBER > OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
201  // If using a future OPENVDB_ABI_VERSION_NUMBER, issue a message directive.
202  // This can be suppressed by defining OPENVDB_USE_FUTURE_ABI_<VERSION>=ON.
203  // Note that, whilst the VDB CMake does not allow this option to be hit,
204  // it exists to propagate this message to downstream targets
205  #if OPENVDB_ABI_VERSION_NUMBER == 13
206  #ifndef OPENVDB_USE_FUTURE_ABI_13
207  PRAGMA(message("NOTE: ABI = 13 is still in active development and has not been finalized, "
208  "define OPENVDB_USE_FUTURE_ABI_13 to suppress this message"))
209  #endif
210  #else
211  #error expected OPENVDB_ABI_VERSION_NUMBER <= OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
212  #endif
213 #endif
214 
215 // If using an OPENVDB_ABI_VERSION_NUMBER that has been deprecated, issue a message
216 // directive. This can be suppressed by defining OPENVDB_USE_DEPRECATED_ABI_<VERSION>.
217 // Note that, whilst the VDB CMake does not allow this option to be hit,
218 // it exists to propagate this message to downstream targets
219 #ifndef OPENVDB_USE_DEPRECATED_ABI_10
220  #if OPENVDB_ABI_VERSION_NUMBER == 10
221  PRAGMA(message("NOTE: ABI = 10 is deprecated, define OPENVDB_USE_DEPRECATED_ABI_10 "
222  "to suppress this message"))
223  #endif
224 #endif
225 #ifndef OPENVDB_USE_DEPRECATED_ABI_11
226  #if OPENVDB_ABI_VERSION_NUMBER == 11
227  PRAGMA(message("NOTE: ABI = 11 is deprecated, define OPENVDB_USE_DEPRECATED_ABI_11 "
228  "to suppress this message"))
229  #endif
230 #endif
231 
232 /// By default, the @b OPENVDB_REQUIRE_VERSION_NAME macro is undefined, and
233 /// symbols from the version namespace are promoted to the top-level namespace
234 /// so that, for example, @b openvdb::v5_0::io::File can be referred to
235 /// simply as @b openvdb::io::File.
236 ///
237 /// When @b OPENVDB_REQUIRE_VERSION_NAME is defined, symbols must be
238 /// fully namespace-qualified.
239 /// @hideinitializer
240 #ifdef OPENVDB_REQUIRE_VERSION_NAME
241 #define OPENVDB_USE_VERSION_NAMESPACE
242 #else
243 // The empty namespace clause below ensures that OPENVDB_VERSION_NAME
244 // is recognized as a namespace name.
245 #define OPENVDB_USE_VERSION_NAMESPACE \
246  namespace OPENVDB_VERSION_NAME {} \
247  using namespace OPENVDB_VERSION_NAME;
248 #endif
249 
250 
251 namespace openvdb {
253 namespace OPENVDB_VERSION_NAME {
254 
255 /// @brief The magic number is stored in the first four bytes of every VDB file.
256 /// @details This can be used to quickly test whether we have a valid file or not.
257 const int32_t OPENVDB_MAGIC = 0x56444220;
258 
259 /// Library major, minor and patch version numbers
260 /// @hideinitializer
261 const uint32_t
265 /// Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
266 /// @hideinitializer
268 /// ABI version number
269 /// @hideinitializer
271 
272 /// @brief The current version number of the VDB file format
273 /// @details This can be used to enable various backwards compatibility switches
274 /// or to reject files that cannot be read.
275 const uint32_t OPENVDB_FILE_VERSION = 224;
276 
277 /// Notable file format version numbers
278 enum {
293 };
294 
295 
296 /// Return a library version number string of the form "<major>.<minor>.<patch>".
297 inline constexpr const char* getLibraryVersionString() { return OPENVDB_LIBRARY_VERSION_STRING; }
298 /// Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
299 inline constexpr const char* getLibraryAbiVersionString() {
301 }
302 inline constexpr const char* getPackageUrl() { return OPENVDB_PACKAGE_URL; }
303 inline constexpr const char* getPackageRevision() { return OPENVDB_PACKAGE_REVISION; }
304 
305 
306 struct VersionId {
307  uint32_t first, second;
308  VersionId(): first(0), second(0) {}
309  VersionId(uint32_t major, uint32_t minor): first(major), second(minor) {}
310 };
311 
312 } // namespace OPENVDB_VERSION_NAME
313 } // namespace openvdb
314 
315 #endif // OPENVDB_VERSION_HAS_BEEN_INCLUDED
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
Library major, minor and patch version numbers.
Definition: version.h:61
GLint first
Definition: glcorearb.h:405
GLuint GLsizei const GLchar * message
Definition: glcorearb.h:2543
constexpr const char * getLibraryAbiVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
Definition: version.h:299
const int32_t OPENVDB_MAGIC
The magic number is stored in the first four bytes of every VDB file.
Definition: version.h:257
#define PRAGMA(x)
Definition: Platform.h:9
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION
Definition: version.h:264
#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER
Library major, minor and patch version numbers.
Definition: version.h:63
#define OPENVDB_LIBRARY_VERSION_STRING
Library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:82
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:245
constexpr const char * getPackageRevision()
Definition: version.h:303
#define OPENVDB_PACKAGE_URL
Where this version was compiled from if it comes from a git repo.
Definition: version.h:97
#define OPENVDB_ABI_VERSION_NUMBER
The ABI version that OpenVDB was built with.
Definition: version.h:74
#define OPENVDB_LIBRARY_VERSION_NUMBER
Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
Definition: version.h:93
const uint32_t OPENVDB_LIBRARY_VERSION
Definition: version.h:267
constexpr const char * getPackageUrl()
Definition: version.h:302
VersionId(uint32_t major, uint32_t minor)
Definition: version.h:309
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION
Definition: version.h:262
#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
Library major, minor and patch version numbers.
Definition: version.h:59
#define OPENVDB_PACKAGE_REVISION
Definition: version.h:98
#define OPENVDB_LIBRARY_ABI_VERSION_STRING
Library version number string of the form "<major>.<minor>.<patch>abi<abi>".
Definition: version.h:89
const uint32_t OPENVDB_LIBRARY_MINOR_VERSION
Definition: version.h:263
const uint32_t OPENVDB_ABI_VERSION
Definition: version.h:270
constexpr const char * getLibraryVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:297
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:119
const uint32_t OPENVDB_FILE_VERSION
The current version number of the VDB file format.
Definition: version.h:275