Added API documentation regarding compression.

This commit is contained in:
Daviw Williams
2013-03-04 15:17:19 +01:00
parent 74b4caba6b
commit b4fcb3daf8
4 changed files with 63 additions and 3 deletions

View File

@ -29,7 +29,9 @@ using namespace std;
namespace PolyVox
{
// Compression levels: 0-9 are the standard zlib-style levels, 10 is best possible compression (not zlib compatible, and may be very slow)
/// You can specify a compression level when constructing this compressor. This controls the tradeoff between speed and compression
/// rate. Levels 0-9 are the standard zlib-style levels, 10 is best possible compression (not zlib compatible, and may be very slow).
/// \param iCompressionLevel The desired compression level.
MinizCompressor::MinizCompressor(int iCompressionLevel)
:m_pDeflator(0)
{