OpenVDB: StreamMetadata Class Reference

OpenVDB 13.0.0

Loading...
Searching...
No Matches
StreamMetadata Class Reference

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...

`#include <openvdb/io/io.h>`

## Public Types
using | Ptr = SharedPtr<StreamMetadata>
using | ConstPtr = SharedPtr<const StreamMetadata>
using | AuxDataMap = std::map<std::string, std::any>

## Public Member Functions
| StreamMetadata ()
| StreamMetadata (const StreamMetadata &)
| StreamMetadata (std::ios_base &)
| ~StreamMetadata ()
StreamMetadata & | operator= (const StreamMetadata &)
void | transferTo (std::ios_base &) const
| Transfer metadata items directly to the given stream.
uint32_t | fileVersion () const
void | setFileVersion (uint32_t)
VersionId | libraryVersion () const
void | setLibraryVersion (VersionId)
uint32_t | compression () const
void | setCompression (uint32_t)
uint32_t | gridClass () const
void | setGridClass (uint32_t)
const void * | backgroundPtr () const
void | setBackgroundPtr (const void *)
bool | halfFloat () const
void | setHalfFloat (bool)
bool | writeGridStats () const
void | setWriteGridStats (bool)
bool | seekable () const
void | setSeekable (bool)
bool | delayedLoadMeta () const
bool | countingPasses () const
void | setCountingPasses (bool)
uint32_t | pass () const
void | setPass (uint32_t)
uint64_t | leaf () const
void | setLeaf (uint64_t)
MetaMap & | gridMetadata ()
| Return a (reference to a) copy of the metadata of the grid currently being read or written.
const MetaMap & | gridMetadata () const
AuxDataMap & | auxData ()
| Return a map that can be populated with arbitrary user data.
const AuxDataMap & | auxData () const
std::string | str () const
| Return a string describing this stream metadata.

## Detailed Description

Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use).

This class is mainly for internal use.

## Member Typedef Documentation

## ◆ AuxDataMap

using AuxDataMap = std::map<std::string, std::any>

## ◆ ConstPtr

using ConstPtr = SharedPtr<const StreamMetadata>

## ◆ Ptr

using Ptr = SharedPtr<StreamMetadata>

## Constructor & Destructor Documentation

## ◆ StreamMetadata() [1/3]

StreamMetadata | ( |  | ) |

## ◆ StreamMetadata() [2/3]

StreamMetadata | ( | const StreamMetadata & |  | ) |

## ◆ StreamMetadata() [3/3]

StreamMetadata | ( | std::ios_base & |  | ) |
| explicit

## ◆ ~StreamMetadata()

~StreamMetadata | ( |  | ) |

## Member Function Documentation

## ◆ auxData() [1/2]

AuxDataMap & auxData | ( |  | ) |

Return a map that can be populated with arbitrary user data.

## ◆ auxData() [2/2]

const AuxDataMap & auxData | ( |  | ) | const

## ◆ backgroundPtr()

const void * backgroundPtr | ( |  | ) | const

## ◆ compression()

uint32_t compression | ( |  | ) | const

## ◆ countingPasses()

bool countingPasses | ( |  | ) | const

## ◆ delayedLoadMeta()

bool delayedLoadMeta | ( |  | ) | const

## ◆ fileVersion()

uint32_t fileVersion | ( |  | ) | const

## ◆ gridClass()

uint32_t gridClass | ( |  | ) | const

## ◆ gridMetadata() [1/2]

MetaMap & gridMetadata | ( |  | ) |

Return a (reference to a) copy of the metadata of the grid currently being read or written.

Some grid metadata might duplicate information returned by gridClass(), backgroundPtr() and other accessors, but those values are not guaranteed to be kept in sync.

## ◆ gridMetadata() [2/2]

const MetaMap & gridMetadata | ( |  | ) | const

## ◆ halfFloat()

bool halfFloat | ( |  | ) | const

## ◆ leaf()

uint64_t leaf | ( |  | ) | const

## ◆ libraryVersion()

VersionId libraryVersion | ( |  | ) | const

## ◆ operator=()

StreamMetadata & operator= | ( | const StreamMetadata & |  | ) |

## ◆ pass()

uint32_t pass | ( |  | ) | const

## ◆ seekable()

bool seekable | ( |  | ) | const

## ◆ setBackgroundPtr()

void setBackgroundPtr | ( | const void * |  | ) |

## ◆ setCompression()

void setCompression | ( | uint32_t |  | ) |

## ◆ setCountingPasses()

void setCountingPasses | ( | bool |  | ) |

## ◆ setFileVersion()

void setFileVersion | ( | uint32_t |  | ) |

## ◆ setGridClass()

void setGridClass | ( | uint32_t |  | ) |

## ◆ setHalfFloat()

void setHalfFloat | ( | bool |  | ) |

## ◆ setLeaf()

void setLeaf | ( | uint64_t |  | ) |

## ◆ setLibraryVersion()

void setLibraryVersion | ( | VersionId |  | ) |

## ◆ setPass()

void setPass | ( | uint32_t |  | ) |

## ◆ setSeekable()

void setSeekable | ( | bool |  | ) |

## ◆ setWriteGridStats()

void setWriteGridStats | ( | bool |  | ) |

## ◆ str()

std::string str | ( |  | ) | const

Return a string describing this stream metadata.

## ◆ transferTo()

void transferTo | ( | std::ios_base & |  | ) | const

Transfer metadata items directly to the given stream.

## ◆ writeGridStats()

bool writeGridStats | ( |  | ) | const