OpenVDB  2.3.0
Classes | Namespaces | Macros | Enumerations | Functions | Variables
version.h File Reference
#include "Platform.h"
#include <iosfwd>
#include <string>

Go to the source code of this file.

Classes

struct  VersionId
 

Namespaces

 openvdb
 
 openvdb::v2_3_0
 
 openvdb::v2_3_0::io
 

Macros

#define OPENVDB_VERSION_NAME   v2_3
 
#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER   2
 
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER   3
 
#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER   0
 
#define OPENVDB_LIBRARY_VERSION_NUMBER
 Library version number as a packed integer ("%02x%02x%04x", major, minor, patch) More...
 
#define OPENVDB_USE_VERSION_NAMESPACE
 

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
}
 Notable file format version numbers. More...
 

Functions

OPENVDB_IMPORT uint32_t getFormatVersion (std::istream &)
 Return the file format version number associated with the given input stream. More...
 
OPENVDB_IMPORT VersionId getLibraryVersion (std::istream &)
 Return the (major, minor) library version number associated with the given input stream. More...
 
OPENVDB_IMPORT std::string getVersion (std::istream &)
 Return a string of the form "<major>.<minor>/<format>", giving the library and file format version numbers associated with the given input stream. More...
 
OPENVDB_IMPORT void setCurrentVersion (std::istream &)
 Associate the current file format and library version numbers with the given input stream. More...
 
OPENVDB_IMPORT void setVersion (std::ios_base &, const VersionId &libraryVersion, uint32_t fileVersion)
 Associate specific file format and library version numbers with the given stream. More...
 
OPENVDB_IMPORT uint32_t getDataCompression (std::ios_base &)
 Return a bitwise OR of compression option flags (COMPRESS_ZIP, COMPRESS_ACTIVE_MASK, etc.) specifying whether and how input data is compressed or output data should be compressed. More...
 
OPENVDB_IMPORT void setDataCompression (std::ios_base &, uint32_t compressionFlags)
 Associate with the given stream a bitwise OR of compression option flags (COMPRESS_ZIP, COMPRESS_ACTIVE_MASK, etc.) specifying whether and how input data is compressed or output data should be compressed. More...
 
OPENVDB_IMPORT uint32_t getGridClass (std::ios_base &)
 Return the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently being read from or written to the given stream. More...
 
OPENVDB_IMPORT void setGridClass (std::ios_base &, uint32_t)
 Associate with the given stream the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently being read or written. More...
 
OPENVDB_IMPORT const void * getGridBackgroundValuePtr (std::ios_base &)
 Return a pointer to the background value of the grid currently being read from or written to the given stream. More...
 
OPENVDB_IMPORT void setGridBackgroundValuePtr (std::ios_base &, const void *background)
 Specify (a pointer to) the background value of the grid currently being read from or written to the given stream. More...
 

Variables

const int32_t OPENVDB_MAGIC = 0x56444220
 The magic number is stored in the first four bytes of every VDB file. More...
 
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION = 2
 
const uint32_t OPENVDB_LIBRARY_MINOR_VERSION = 3
 
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION = 0
 
const uint32_t OPENVDB_LIBRARY_VERSION = (( 2 << 24) | (( 3 & 0xFF) << 16) | ( 0 & 0xFFFF))
 Library version number as a packed integer ("%02x%02x%04x", major, minor, patch) More...
 
const uint32_t OPENVDB_FILE_VERSION = 222
 The current version number of the VDB file format. More...
 

Macro Definition Documentation

#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER   2
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER   3
#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER   0
#define OPENVDB_LIBRARY_VERSION_NUMBER
Value:
#define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER
Definition: version.h:48
#define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER
Definition: version.h:49
#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER
Definition: version.h:50

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

#define OPENVDB_USE_VERSION_NAMESPACE
Value:
namespace OPENVDB_VERSION_NAME {} \
using namespace OPENVDB_VERSION_NAME;
#define OPENVDB_VERSION_NAME
Definition: version.h:45

If OPENVDB_REQUIRE_VERSION_NAME is undefined, symbols from the version namespace are promoted to the top-level namespace (e.g., vdb::v1_0_0::io::File can be referred to simply as vdb::io::File). Otherwise, symbols must be fully namespace-qualified.

Note
The empty namespace clause below ensures that OPENVDB_VERSION_NAME is recognized as a namespace name.
#define OPENVDB_VERSION_NAME   v2_3

The version namespace name for this library version

Fully-namespace-qualified symbols are named as follows: vdb::vX_Y_Z::Vec3i, vdb::vX_Y_Z::io::File, vdb::vX_Y_Z::tree::Tree, etc., where X, Y and Z are OPENVDB_LIBRARY_MAJOR_VERSION, OPENVDB_LIBRARY_MINOR_VERSION and OPENVDB_LIBRARY_PATCH_VERSION, respectively (defined below).