d7/d83/_compression_8h_source.htm

#pragma once


#include <Foundation/Basics.h>

#include <Foundation/Containers/DynamicArray.h>


enum class plCompressionMethod : plUInt16

{

  ZStd = 0

};


namespace plCompressionUtils

{

  PL_FOUNDATION_DLL plResult Compress(plArrayPtr<const plUInt8> uncompressedData, plCompressionMethod method, plDynamicArray<plUInt8>& out_data);


  PL_FOUNDATION_DLL plResult Decompress(plArrayPtr<const plUInt8> compressedData, plCompressionMethod method, plDynamicArray<plUInt8>& out_data);

} // namespace plCompressionUtils


plArrayPtr
This class encapsulates an array and it's size. It is recommended to use this class instead of plain ...
Definition ArrayPtr.h:37

plDynamicArray
Definition DynamicArray.h:81

plCompressionUtils
This namespace contains utilities which can be used to compress and decompress data.
Definition Compression.h:14

plCompressionUtils::Compress
PL_FOUNDATION_DLL plResult Compress(plArrayPtr< const plUInt8 > uncompressedData, plCompressionMethod method, plDynamicArray< plUInt8 > &out_data)
Compresses the given data using the compression method eMethod into the dynamic array given in out_Da...
Definition Compression.cpp:72

plCompressionUtils::Decompress
PL_FOUNDATION_DLL plResult Decompress(plArrayPtr< const plUInt8 > compressedData, plCompressionMethod method, plDynamicArray< plUInt8 > &out_data)
Decompresses the given data using the compression method eMethod into the dynamic array given in out_...
Definition Compression.cpp:96

plResult
Default enum for returning failure or success, instead of using a bool.
Definition Types.h:54