HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
io.h File Reference
#include <openvdb/Platform.h>
#include <openvdb/Types.h>
#include <openvdb/version.h>
#include <hboost/any.hpp>
#include <functional>
#include <iosfwd>
#include <map>
#include <memory>
#include <string>
+ Include dependency graph for io.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata
 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  openvdb::OPENVDB_VERSION_NAME::io::MultiPass
 Leaf nodes that require multi-pass I/O must inherit from this struct. More...
 
class  openvdb::OPENVDB_VERSION_NAME::io::MappedFile
 Handle to control the lifetime of a memory-mapped .vdb file. More...
 

Namespaces

 openvdb
 
 openvdb::OPENVDB_VERSION_NAME
 
 openvdb::OPENVDB_VERSION_NAME::io
 

Functions

std::ostream & openvdb::OPENVDB_VERSION_NAME::io::operator<< (std::ostream &, const StreamMetadata &)
 Write a description of the given metadata to an output stream. More...
 
std::ostream & openvdb::OPENVDB_VERSION_NAME::io::operator<< (std::ostream &, const StreamMetadata::AuxDataMap &)
 
std::string openvdb::OPENVDB_VERSION_NAME::io::getErrorString (int errorNum)
 Return a string (possibly empty) describing the given system error code. More...
 
std::string openvdb::OPENVDB_VERSION_NAME::io::getErrorString ()
 Return a string (possibly empty) describing the most recent system error. More...
 
OPENVDB_API uint32_t openvdb::OPENVDB_VERSION_NAME::io::getFormatVersion (std::ios_base &)
 Return the file format version number associated with the given input stream. More...
 
OPENVDB_API VersionId openvdb::OPENVDB_VERSION_NAME::io::getLibraryVersion (std::ios_base &)
 Return the (major, minor) library version number associated with the given input stream. More...
 
OPENVDB_API std::string openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::setCurrentVersion (std::istream &)
 Associate the current file format and library version numbers with the given input stream. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::setVersion (std::ios_base &, const VersionId &libraryVersion, uint32_t fileVersion)
 Associate specific file format and library version numbers with the given stream. More...
 
OPENVDB_API uint32_t openvdb::OPENVDB_VERSION_NAME::io::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_API void openvdb::OPENVDB_VERSION_NAME::io::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_API uint32_t openvdb::OPENVDB_VERSION_NAME::io::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_API void openvdb::OPENVDB_VERSION_NAME::io::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_API bool openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API const voidopenvdb::OPENVDB_VERSION_NAME::io::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_API void openvdb::OPENVDB_VERSION_NAME::io::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...
 
OPENVDB_API bool openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API SharedPtr< MappedFile > openvdb::OPENVDB_VERSION_NAME::io::getMappedFilePtr (std::ios_base &)
 Return a shared pointer to the memory-mapped file with which the given stream is associated, or a null pointer if the stream is not associated with a memory-mapped file. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::setMappedFilePtr (std::ios_base &, SharedPtr< MappedFile > &)
 Associate the given stream with (a shared pointer to) a memory-mapped file. More...
 
OPENVDB_API SharedPtr
< StreamMetadata > 
openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::io::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. More...
 
OPENVDB_API SharedPtr
< StreamMetadata > 
openvdb::OPENVDB_VERSION_NAME::io::clearStreamMetadataPtr (std::ios_base &)
 Dissociate the given stream from its metadata object (if it has one) and return a shared pointer to the object. More...