GetCompressedDataInfo

From Solid Graphics Wiki

Jump to: navigation, search
GetCompressedDataInfo
Namespace: SKL
Member of: (this function is not member of any class)
Include: SklCompress.h
Lib (Release): SKL.lib
Lib (Debug): SKL_D.lib

The GetCompressedDataInfo function returns information about data previously compressed by the CompressData function.

bool GetCompressedDataInfo
         (
         const void* compressedData,
         unsigned int* compressedDataSize,
         unsigned int* decompressedDataSize
         );


Parameters

compressedData Pointer to data previously compressed by the CompressData function.
compressedDataSize After the function returns the variable pointed by compressedDataSize will contain information about number of bytes in the compressedData buffer. This is the same number as the srcBufferSize value passed to the CompressData function when the data were compressed.
decompressedDataSize After the function returns the variable pointed by decompressedDataSize will contain number of bytes the compressedData will occupy after uncompressing them by the DecompressData. This is the minimal value for the size of dstBuffer to be used in the DecompressData function do uncompress the data.

Return Value

The function returns true in case of success, in case of error it returns false and the content of variables pointed by compressedDataSize and decompressedDataSize is undefined.

See Also


   


SolidKit Library Documentation

Personal tools