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: MPL-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 9
60 /// @hideinitializer
61 #define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER 1
62 /// @hideinitializer
63 #define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER 0
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 9
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 "9.1.0"
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 "9.1.0abi9"
90 
91 /// @brief Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
92 /// @hideinitializer
93 #define OPENVDB_LIBRARY_VERSION_NUMBER 151060480
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 "cd4bcb92c8302e7fcbd596b42b41674b274d3e2c"
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 v9_1_sesi
120 #else
121  #define OPENVDB_VERSION_NAME v9_1_sesi_abi9
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 explicit template instantiation */
142 #ifndef OPENVDB_USE_EXPLICIT_INSTANTIATION
143 /* #undef OPENVDB_USE_EXPLICIT_INSTANTIATION */
144 #endif
145 
146 /* Defines the macros for explicit template declarations. */
147 #define OPENVDB_INSTANTIATE extern template OPENVDB_TEMPLATE_IMPORT
148 #define OPENVDB_INSTANTIATE_CLASS extern template class OPENVDB_TEMPLATE_IMPORT
149 #define OPENVDB_INSTANTIATE_STRUCT extern template struct OPENVDB_TEMPLATE_IMPORT
150 
151 /* Defines the macros for explicit template instantiations. */
152 #define OPENVDB_REAL_TREE_INSTANTIATE(Function)
153 #define OPENVDB_NUMERIC_TREE_INSTANTIATE(Function)
154 #define OPENVDB_VEC3_TREE_INSTANTIATE(Function)
155 #define OPENVDB_VOLUME_TREE_INSTANTIATE(Function)
156 #define OPENVDB_ALL_TREE_INSTANTIATE(Function)
157 
158 ///////////////////////////////////////////////////////////////////////////////
159 ///////////////////////////////////////////////////////////////////////////////
160 
161 
162 #if OPENVDB_ABI_VERSION_NUMBER > OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
163  // If using a future OPENVDB_ABI_VERSION_NUMBER, issue a message directive.
164  // This can be suppressed by defining OPENVDB_USE_FUTURE_ABI_<VERSION>=ON.
165  // Note that, whilst the VDB CMake does not allow this option to be hit,
166  // it exists to propagate this message to downstream targets
167  #if OPENVDB_ABI_VERSION_NUMBER == 10
168  #ifndef OPENVDB_USE_FUTURE_ABI_10
169  PRAGMA(message("NOTE: ABI = 10 is still in active development and has not been finalized, "
170  "define OPENVDB_USE_FUTURE_ABI_10 to suppress this message"))
171  #endif
172  #else
173  #error expected OPENVDB_ABI_VERSION_NUMBER <= OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
174  #endif
175 #endif
176 
177 // If using an OPENVDB_ABI_VERSION_NUMBER that has been deprecated, issue a message
178 // directive. This can be suppressed by defining OPENVDB_USE_DEPRECATED_ABI_<VERSION>.
179 // Note that, whilst the VDB CMake does not allow this option to be hit,
180 // it exists to propagate this message to downstream targets
181 #ifndef OPENVDB_USE_DEPRECATED_ABI_7
182  #if OPENVDB_ABI_VERSION_NUMBER == 7
183  PRAGMA(message("NOTE: ABI = 7 is deprecated, define OPENVDB_USE_DEPRECATED_ABI_7 "
184  "to suppress this message"))
185  #endif
186 #endif
187 #ifndef OPENVDB_USE_DEPRECATED_ABI_8
188  #if OPENVDB_ABI_VERSION_NUMBER == 8
189  PRAGMA(message("NOTE: ABI = 8 is deprecated, define OPENVDB_USE_DEPRECATED_ABI_8 "
190  "to suppress this message"))
191  #endif
192 #endif
193 
194 /// By default, the @b OPENVDB_REQUIRE_VERSION_NAME macro is undefined, and
195 /// symbols from the version namespace are promoted to the top-level namespace
196 /// so that, for example, @b openvdb::v5_0::io::File can be referred to
197 /// simply as @b openvdb::io::File.
198 ///
199 /// When @b OPENVDB_REQUIRE_VERSION_NAME is defined, symbols must be
200 /// fully namespace-qualified.
201 /// @hideinitializer
202 #ifdef OPENVDB_REQUIRE_VERSION_NAME
203 #define OPENVDB_USE_VERSION_NAMESPACE
204 #else
205 // The empty namespace clause below ensures that OPENVDB_VERSION_NAME
206 // is recognized as a namespace name.
207 #define OPENVDB_USE_VERSION_NAMESPACE \
208  namespace OPENVDB_VERSION_NAME {} \
209  using namespace OPENVDB_VERSION_NAME;
210 #endif
211 
212 
213 namespace openvdb {
215 namespace OPENVDB_VERSION_NAME {
216 
217 /// @brief The magic number is stored in the first four bytes of every VDB file.
218 /// @details This can be used to quickly test whether we have a valid file or not.
219 const int32_t OPENVDB_MAGIC = 0x56444220;
220 
221 /// Library major, minor and patch version numbers
222 /// @hideinitializer
223 const uint32_t
227 /// Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
228 /// @hideinitializer
230 /// ABI version number
231 /// @hideinitializer
233 
234 /// @brief The current version number of the VDB file format
235 /// @details This can be used to enable various backwards compatibility switches
236 /// or to reject files that cannot be read.
237 const uint32_t OPENVDB_FILE_VERSION = 224;
238 
239 /// Notable file format version numbers
240 enum {
255 };
256 
257 
258 /// Return a library version number string of the form "<major>.<minor>.<patch>".
259 inline constexpr const char* getLibraryVersionString() { return OPENVDB_LIBRARY_VERSION_STRING; }
260 /// Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
261 inline constexpr const char* getLibraryAbiVersionString() {
263 }
264 inline constexpr const char* getPackageUrl() { return OPENVDB_PACKAGE_URL; }
265 inline constexpr const char* getPackageRevision() { return OPENVDB_PACKAGE_REVISION; }
266 
267 
268 struct VersionId {
269  uint32_t first, second;
270  VersionId(): first(0), second(0) {}
271  VersionId(uint32_t major, uint32_t minor): first(major), second(minor) {}
272 };
273 
274 } // namespace OPENVDB_VERSION_NAME
275 } // namespace openvdb
276 
277 #endif // OPENVDB_VERSION_HAS_BEEN_INCLUDED
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
Library major, minor and patch version numbers.
Definition: version.h:61
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:261
const int32_t OPENVDB_MAGIC
The magic number is stored in the first four bytes of every VDB file.
Definition: version.h:219
#define PRAGMA(x)
Definition: Platform.h:9
GLint first
Definition: glcorearb.h:405
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION
Definition: version.h:226
#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:207
constexpr const char * getPackageRevision()
Definition: version.h:265
#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:229
constexpr const char * getPackageUrl()
Definition: version.h:264
VersionId(uint32_t major, uint32_t minor)
Definition: version.h:271
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION
Definition: version.h:224
#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:225
const uint32_t OPENVDB_ABI_VERSION
Definition: version.h:232
constexpr const char * getLibraryVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:259
#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:237