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 8
60 /// @hideinitializer
61 #define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER 1
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 8
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 "8.1.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 "8.1.1abi8"
90 
91 /// @brief Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
92 /// @hideinitializer
93 #define OPENVDB_LIBRARY_VERSION_NUMBER 134283265
94 
95 /// @brief The version namespace name for this library version
96 /// @hideinitializer
97 ///
98 /// When the ABI version number matches the library major version number,
99 /// symbols are named as in the following examples:
100 /// - @b openvdb::vX_Y::Vec3i
101 /// - @b openvdb::vX_Y::io::File
102 /// - @b openvdb::vX_Y::tree::Tree
103 ///
104 /// where X and Y are the major and minor version numbers.
105 ///
106 /// When the ABI version number does not match the library major version number,
107 /// symbol names include the ABI version:
108 /// - @b openvdb::vX_YabiN::Vec3i
109 /// - @b openvdb::vX_YabiN::io::File
110 /// - @b openvdb::vX_YabiN::tree::Tree
111 ///
112 /// where X, Y and N are the major, minor and ABI version numbers, respectively.
113 #if OPENVDB_ABI_VERSION_NUMBER == OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
114  #define OPENVDB_VERSION_NAME v8_1_sesi
115 #else
116  #define OPENVDB_VERSION_NAME v8_1_sesi_abi8
117 #endif
118 
119 /* Denotes whether VDB was built with IMath Half support */
120 #ifndef OPENVDB_USE_IMATH_HALF
121 /* #undef OPENVDB_USE_IMATH_HALF */
122 #endif
123 
124 /* Denotes whether VDB was built with Blosc support */
125 #ifndef OPENVDB_USE_BLOSC
126 #define OPENVDB_USE_BLOSC
127 #endif
128 
129 /* Denotes whether VDB was built with ZLIB support */
130 #ifndef OPENVDB_USE_ZLIB
131 #define OPENVDB_USE_ZLIB
132 #endif
133 
134 
135 ///////////////////////////////////////////////////////////////////////////////
136 ///////////////////////////////////////////////////////////////////////////////
137 
138 
139 #if OPENVDB_ABI_VERSION_NUMBER > OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
140  // If using a future OPENVDB_ABI_VERSION_NUMBER, issue a message directive.
141  // This can be suppressed by defining OPENVDB_USE_FUTURE_ABI_<VERSION>=ON.
142  // Note that, whilst the VDB CMake does not allow this option to be hit,
143  // it exists to propagate this message to downstream targets
144  #if OPENVDB_ABI_VERSION_NUMBER == 9
145  #ifndef OPENVDB_USE_FUTURE_ABI_9
146  PRAGMA(message("NOTE: ABI = 9 is still in active development and has not been finalized, "
147  "define OPENVDB_USE_FUTURE_ABI_9 to suppress this message"))
148  #endif
149  #else
150  #error expected OPENVDB_ABI_VERSION_NUMBER <= OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
151  #endif
152 #endif
153 
154 // If using an OPENVDB_ABI_VERSION_NUMBER that has been deprecated, issue a message
155 // directive. This can be suppressed by defining OPENVDB_USE_DEPRECATED_ABI_<VERSION>.
156 // Note that, whilst the VDB CMake does not allow this option to be hit,
157 // it exists to propagate this message to downstream targets
158 #ifndef OPENVDB_USE_DEPRECATED_ABI_6
159  #if OPENVDB_ABI_VERSION_NUMBER == 6
160  PRAGMA(message("NOTE: ABI = 6 is deprecated, define OPENVDB_USE_DEPRECATED_ABI_6 "
161  "to suppress this message"))
162  #endif
163 #endif
164 
165 /// By default, the @b OPENVDB_REQUIRE_VERSION_NAME macro is undefined, and
166 /// symbols from the version namespace are promoted to the top-level namespace
167 /// so that, for example, @b openvdb::v5_0::io::File can be referred to
168 /// simply as @b openvdb::io::File.
169 ///
170 /// When @b OPENVDB_REQUIRE_VERSION_NAME is defined, symbols must be
171 /// fully namespace-qualified.
172 /// @hideinitializer
173 #ifdef OPENVDB_REQUIRE_VERSION_NAME
174 #define OPENVDB_USE_VERSION_NAMESPACE
175 #else
176 // The empty namespace clause below ensures that OPENVDB_VERSION_NAME
177 // is recognized as a namespace name.
178 #define OPENVDB_USE_VERSION_NAMESPACE \
179  namespace OPENVDB_VERSION_NAME {} \
180  using namespace OPENVDB_VERSION_NAME;
181 #endif
182 
183 
184 namespace openvdb {
186 namespace OPENVDB_VERSION_NAME {
187 
188 /// @brief The magic number is stored in the first four bytes of every VDB file.
189 /// @details This can be used to quickly test whether we have a valid file or not.
190 const int32_t OPENVDB_MAGIC = 0x56444220;
191 
192 /// Library major, minor and patch version numbers
193 /// @hideinitializer
194 const uint32_t
198 /// Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)
199 /// @hideinitializer
201 /// ABI version number
202 /// @hideinitializer
204 
205 /// @brief The current version number of the VDB file format
206 /// @details This can be used to enable various backwards compatibility switches
207 /// or to reject files that cannot be read.
208 const uint32_t OPENVDB_FILE_VERSION = 224;
209 
210 /// Notable file format version numbers
211 enum {
226 };
227 
228 
229 /// Return a library version number string of the form "<major>.<minor>.<patch>".
230 inline constexpr const char* getLibraryVersionString() { return OPENVDB_LIBRARY_VERSION_STRING; }
231 /// Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
232 inline constexpr const char* getLibraryAbiVersionString() {
234 }
235 
236 
237 struct VersionId {
238  uint32_t first, second;
239  VersionId(): first(0), second(0) {}
240  VersionId(uint32_t major, uint32_t minor): first(major), second(minor) {}
241 };
242 
243 } // namespace OPENVDB_VERSION_NAME
244 } // namespace openvdb
245 
246 #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:2542
constexpr const char * getLibraryAbiVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".
Definition: version.h:232
const int32_t OPENVDB_MAGIC
The magic number is stored in the first four bytes of every VDB file.
Definition: version.h:190
#define PRAGMA(x)
Definition: Platform.h:9
GLint first
Definition: glcorearb.h:404
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION
Definition: version.h:197
#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:178
#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:200
VersionId(uint32_t major, uint32_t minor)
Definition: version.h:240
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION
Definition: version.h:195
#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
Library major, minor and patch version numbers.
Definition: version.h:59
#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:196
const uint32_t OPENVDB_ABI_VERSION
Definition: version.h:203
constexpr const char * getLibraryVersionString()
Return a library version number string of the form "<major>.<minor>.<patch>".
Definition: version.h:230
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:114
const uint32_t OPENVDB_FILE_VERSION
The current version number of the VDB file format.
Definition: version.h:208