openvdb::OPENVDB_VERSION_NAME::compression::Page Class Reference

Stores a variable-size, compressed, delayed-load Page of data that is loaded into memory when accessed. Access to the Page is thread-safe as loading and decompressing the data is protected by a mutex. More...

#include <StreamCompression.h>

Public Types
using	Ptr = std::shared_ptr< Page >

Public Member Functions
	Page ()=default
void	load () const
	load the Page into memory More...
long	uncompressedBytes () const
	Uncompressed bytes of the Paged data, available when the header has been read. More...
const char *	buffer (const int index) const
	Retrieves a data pointer at the specific. More...
void	readHeader (std::istream &)
	Read the Page header. More...
void	readBuffers (std::istream &, bool delayed)
	Read the Page buffers. If delayed is true, stream pointers will be stored to load the data lazily. More...
bool	isOutOfCore () const
	Test if the data is out-of-core. More...

Detailed Description

Stores a variable-size, compressed, delayed-load Page of data that is loaded into memory when accessed. Access to the Page is thread-safe as loading and decompressing the data is protected by a mutex.

Definition at line 111 of file StreamCompression.h.

Member Typedef Documentation

using openvdb::OPENVDB_VERSION_NAME::compression::Page::Ptr = std::shared_ptr<Page>

Definition at line 126 of file StreamCompression.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::compression::Page::Page ( )

default

Member Function Documentation

const char* openvdb::OPENVDB_VERSION_NAME::compression::Page::buffer

(

const int

index

)

const

Retrieves a data pointer at the specific.

Parameters

index

Note

Will force a Page load when called.

bool openvdb::OPENVDB_VERSION_NAME::compression::Page::isOutOfCore

(

)

const

Test if the data is out-of-core.

void openvdb::OPENVDB_VERSION_NAME::compression::Page::load

(

)

const

load the Page into memory

void openvdb::OPENVDB_VERSION_NAME::compression::Page::readBuffers	(	std::istream &	,
		bool	delayed
	)

Read the Page buffers. If delayed is true, stream pointers will be stored to load the data lazily.

void openvdb::OPENVDB_VERSION_NAME::compression::Page::readHeader

(

std::istream &

)

Read the Page header.

long openvdb::OPENVDB_VERSION_NAME::compression::Page::uncompressedBytes

(

)

const

Uncompressed bytes of the Paged data, available when the header has been read.

---

The documentation for this class was generated from the following file:

• openvdb/points/StreamCompression.h