AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Just remembered that we settled on a different formatting for the API docs so that it gets highlighted better in KDE.

Browse Source
This commit is contained in:
Daviw Williams 2013-03-04 15:36:11 +01:00
parent b4fcb3daf8
commit df5c339f64
2 changed files with 46 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
library/PolyVoxCore/include/PolyVoxCore/Compressor.h
View File

@ -48,48 +48,51 @@ namespace PolyVox
/// Destructor
virtual ~Compressor() {};
/// Computes a worst-case scenario for how big the output can be for a given input size.
///
/// If necessary you can use this as a destination buffer size, though it may be somewhat
/// wasteful. It is not guarenteed that compression actually shrinks the data, so the
/// worst-case value returned by this function may be bigger than the input size.
///
/// \param uUncompressedInputSize The size of the uncompressed input data
/// \return The largest possible size of the compressed output data.
///
/**
* Computes a worst-case scenario for how big the output can be for a given input size.
*
* If necessary you can use this as a destination buffer size, though it may be somewhat
* wasteful. It is not guarenteed that compression actually shrinks the data, so the
* worst-case value returned by this function may be bigger than the input size.
*
* \param uUncompressedInputSize The size of the uncompressed input data
* \return The largest possible size of the compressed output data.
*/
virtual uint32_t getMaxCompressedSize(uint32_t uUncompressedInputSize) = 0;
/// Compresses the data.
///
/// Performs compression of the data pointed to by pSrcData and stores the result in pDstData.
/// The user is responsible for allocating both buffers and for making sure that the destination
/// buffer is large enough to hold the result. If you don't know how big the compressed data
/// will be (and you probably won't know this) then you can call getMaxCompressedSize() to get
/// an upper bound. The *actual* compressed size is then returned by this function and you can
/// use this to copy your compressed data to a more suitably size buffer.
///
/// \param pSrcData A pointer to the data to be compressed.
/// \param uSrcLength The length of the data to be compressed.
/// \param pDstData A pointer to the memory where the result should be stored.
/// \param uDstLength The length of the destination buffer (compression will fail if this isn't big enough).
/// \return The size of the resulting compressed data.
///
/**
* Compresses the data.
*
* Performs compression of the data pointed to by pSrcData and stores the result in pDstData.
* The user is responsible for allocating both buffers and for making sure that the destination
* buffer is large enough to hold the result. If you don't know how big the compressed data
* will be (and you probably won't know this) then you can call getMaxCompressedSize() to get
* an upper bound. The *actual* compressed size is then returned by this function and you can
* use this to copy your compressed data to a more suitably size buffer.
*
* \param pSrcData A pointer to the data to be compressed.
* \param uSrcLength The length of the data to be compressed.
* \param pDstData A pointer to the memory where the result should be stored.
* \param uDstLength The length of the destination buffer (compression will fail if this isn't big enough).
* \return The size of the resulting compressed data.
*/
virtual uint32_t compress(void* pSrcData, uint32_t uSrcLength, void* pDstData, uint32_t uDstLength) = 0;
/// Decompresses the data.
///
/// Performs decompression of the data pointed to by pSrcData and stores the result in pDstData.
/// The user is responsible for allocating both buffers and for making sure that the destination
/// buffer is large enough to hold the result. This means you need to know how large the resulting
/// data might be, so before you compress the data it may be worth storing this information somewhere.
/// The *actual* decompressed size is then returned by this function
///
/// \param pSrcData A pointer to the data to be decompressed.
/// \param uSrcLength The length of the data to be decompressed.
/// \param pDstData A pointer to the memory where the result should be stored.
/// \param uDstLength The length of the destination buffer (decompression will fail if this isn't big enough).
/// \return The size of the resulting uncompressed data.
///
/**
* Decompresses the data.
*
* Performs decompression of the data pointed to by pSrcData and stores the result in pDstData.
* The user is responsible for allocating both buffers and for making sure that the destination
* buffer is large enough to hold the result. This means you need to know how large the resulting
* data might be, so before you compress the data it may be worth storing this information somewhere.
* The *actual* decompressed size is then returned by this function
*
* \param pSrcData A pointer to the data to be decompressed.
* \param uSrcLength The length of the data to be decompressed.
* \param pDstData A pointer to the memory where the result should be stored.
* \param uDstLength The length of the destination buffer (decompression will fail if this isn't big enough).
* \return The size of the resulting uncompressed data.
*/
virtual uint32_t decompress(void* pSrcData, uint32_t uSrcLength, void* pDstData, uint32_t uDstLength) = 0;
};
}

8
library/PolyVoxCore/source/MinizCompressor.cpp
View File

@ -29,9 +29,11 @@ using namespace std;
namespace PolyVox
{
/// 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.
/**
* 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)
{