Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-06 15:59:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

added some comments to VoxelPacket

Browse source
This commit is contained in:
ZappoMan 2013-11-23 14:02:46 -08:00
parent 4c0569fc60
commit ae5d5324c1
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
libraries/voxels/src/VoxelPacket.h
View file

@ -8,8 +8,9 @@
// //
// * add stats tracking for number of bytes of octal code, bitmasks, and colors in a packet. // * add stats tracking for number of bytes of octal code, bitmasks, and colors in a packet.
// * add compression // * add compression
// * improve semantics for "reshuffle" - current approach will work for now, but wouldn't work // * improve semantics for "reshuffle" - current approach will work for now and with compression
// with RLE because the colors in the levels would get reordered // but wouldn't work with RLE because the colors in the levels would get reordered and RLE would need
// to be recalculated
// //
#ifndef __hifi__VoxelPacket__ #ifndef __hifi__VoxelPacket__
@ -24,9 +25,17 @@ public:
VoxelPacket(); VoxelPacket();
~VoxelPacket(); ~VoxelPacket();
/// reset completely, all data is discarded
void reset(); void reset();
/// call to begin encoding a subtree starting at this point, this will append the octcode to the uncompressed stream
/// at this point. May fail if new datastream is too long. In failure case the stream remains in it's previous state.
bool startSubTree(const unsigned char* octcode = NULL); bool startSubTree(const unsigned char* octcode = NULL);
// call to indicate that the current subtree is complete and changes should be committed.
void endSubTree(); void endSubTree();
// call rollback the current subtree and restore the stream to the state prior to starting the subtree encoding
void discardSubTree(); void discardSubTree();
/// starts a level marker. returns an opaque key which can be used to discard the level /// starts a level marker. returns an opaque key which can be used to discard the level