HDK
|
A PageHandle holds a unique ptr to a Page and a specific stream pointer to a point within the decompressed Page buffer. More...
#include <StreamCompression.h>
Public Types | |
using | Ptr = std::unique_ptr< PageHandle > |
Public Member Functions | |
PageHandle (const Page::Ptr &page, const int index, const int size) | |
Create the page handle. More... | |
Page & | page () |
Retrieve a reference to the stored page. More... | |
int | size () const |
Return the size of the buffer. More... | |
std::unique_ptr< char[]> | read () |
Read and return the buffer, loading and decompressing the Page if necessary. More... | |
Ptr | copy () |
Return a copy of this PageHandle. More... | |
Friends | |
class | ::TestStreamCompression |
A PageHandle holds a unique ptr to a Page and a specific stream pointer to a point within the decompressed Page buffer.
Definition at line 169 of file StreamCompression.h.
using openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::Ptr = std::unique_ptr<PageHandle> |
Definition at line 172 of file StreamCompression.h.
openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::PageHandle | ( | const Page::Ptr & | page, |
const int | index, | ||
const int | size | ||
) |
Create the page handle.
page | a shared ptr to the page that stores the buffer |
index | start position of the buffer to be read |
size | total size of the buffer to be read in bytes |
|
inline |
Return a copy of this PageHandle.
Definition at line 191 of file StreamCompression.h.
Page& openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::page | ( | ) |
Retrieve a reference to the stored page.
std::unique_ptr<char[]> openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::read | ( | ) |
Read and return the buffer, loading and decompressing the Page if necessary.
Return the size of the buffer.
Definition at line 184 of file StreamCompression.h.
|
friend |
Definition at line 194 of file StreamCompression.h.