OpenVDB 14.0.0
Loading...
Searching...
No Matches
io.h File Reference
#include <openvdb/Platform.h>
#include <openvdb/Types.h>
#include <openvdb/version.h>
#include <any>
#include <functional>
#include <iosfwd>
#include <map>
#include <memory>
#include <string>

Go to the source code of this file.

Classes

 Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use) More...
struct  PointDataGridMultiPass
 Tag for multi-pass I/O. Only points::PointDataLeafNode may inherit from this. More...
class  StreamMetadataScope
 Replaces any StreamMetadata shared pointer associated with the stream with the given one for the lifetime of this object. When the destructor of this object is called, the StreamMetadata shared pointer is replaced with the prior one again. More...

Namespaces

namespace  openvdb
namespace  openvdb::v14_0
namespace  openvdb::v14_0::io

Functions

std::ostream & operator<< (std::ostream &, const StreamMetadata &)
 Write a description of the given metadata to an output stream.
std::ostream & operator<< (std::ostream &, const StreamMetadata::AuxDataMap &)
std::string getErrorString (int errorNum)
 Return a string (possibly empty) describing the given system error code.
std::string getErrorString ()
 Return a string (possibly empty) describing the most recent system error.
uint32_t getFormatVersion (std::ios_base &)
 Return the file format version number associated with the given input stream.
void checkFormatVersion (std::ios_base &)
 Throws an IoError if the file format version number is not supported.
VersionId getLibraryVersion (std::ios_base &)
 Return the (major, minor) library version number associated with the given input stream.
std::string getVersion (std::ios_base &)
 Return a string of the form "<major>.<minor>/<format>", giving the library and file format version numbers associated with the given input stream.
void setCurrentVersion (std::istream &)
 Associate the current file format and library version numbers with the given input stream.
void setVersion (std::ios_base &, const VersionId &libraryVersion, uint32_t fileVersion)
 Associate specific file format and library version numbers with the given stream.
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.
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.
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.
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.
bool getHalfFloat (std::ios_base &)
 Return true if floating-point values should be quantized to 16 bits when writing to the given stream or promoted back from 16-bit to full precision when reading from it.
void setHalfFloat (std::ios_base &, bool)
 Specify whether floating-point values should be quantized to 16 bits when writing to the given stream or promoted back from 16-bit to full precision when reading from it.
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.
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.
bool getWriteGridStatsMetadata (std::ios_base &)
 Return true if grid statistics (active voxel count and bounding box, etc.) should be computed and stored as grid metadata when writing to the given stream.
void setWriteGridStatsMetadata (std::ios_base &, bool writeGridStats)
 Specify whether to compute grid statistics (active voxel count and bounding box, etc.) and store them as grid metadata when writing to the given stream.
SharedPtr< StreamMetadata > getStreamMetadataPtr (std::ios_base &)
 Return a shared pointer to an object that stores metadata (file format, compression scheme, etc.) for use when reading from or writing to the given stream.
void setStreamMetadataPtr (std::ios_base &, SharedPtr< StreamMetadata > &, bool transfer=true)
 Associate the given stream with (a shared pointer to) an object that stores metadata (file format, compression scheme, etc.) for use when reading from or writing to the stream.
SharedPtr< StreamMetadata > clearStreamMetadataPtr (std::ios_base &)
 Dissociate the given stream from its metadata object (if it has one) and return a shared pointer to the object.