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 <openvdb/points/StreamCompression.h>

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

Public Member Functions
	Page ()=default
void	load () const
long	uncompressedBytes () const
	Uncompressed bytes of the Paged data, available when the header has been read.
const char *	buffer (const int index) const
	Retrieves a data pointer at the specific.
void	readHeader (std::istream &)
	Read the Page header.
void	readBuffers (std::istream &, bool delayed)
	Read the Page buffers. If delayed is true, stream pointers will be stored to load the data lazily.
void	skipBuffers (std::istream &)
	Skip the Page buffers by seeking past the compressed data without reading or decompressing it.
bool	isOutOfCore () const

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.

Member Typedef Documentation

◆ Ptr

using Ptr = std::shared_ptr<Page>

Constructor & Destructor Documentation

◆ Page()

Page ( )

default

Member Function Documentation

◆ buffer()

const char * buffer ( const int index ) const

Retrieves a data pointer at the specific.

Parameters

index

Note: Will force a Page load when called.

◆ isOutOfCore()

bool isOutOfCore ( ) const

inline

Deprecated: "Always returns false. This method is deprecated and will be removed. Delayed loading is no longer supported."

◆ load()

void load ( ) const

inline

Deprecated: "Always returns false. This method is deprecated and will be removed. Delayed loading is no longer supported."

◆ readBuffers()

void readBuffers	(	std::istream &	,
		bool	delayed )

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

◆ readHeader()

void readHeader ( std::istream & )

Read the Page header.

◆ skipBuffers()

void skipBuffers ( std::istream & )

Skip the Page buffers by seeking past the compressed data without reading or decompressing it.

◆ uncompressedBytes()

long uncompressedBytes ( ) const

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

Public Types

Public Member Functions