LZ4_compress_HC

[LZ4_compress_HC()](API\Runtime\Core\Compression\LZ4_compress_HC) : Compress data from `src_ into `dst_, using the powerful but slower "HC" algorithm.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Compression/lz4hc.h

Include

#include "Compression/lz4hc.h"

Source

/Engine/Source/Runtime/Core/Private/Compression/lz4hc.cpp

Syntax

LZ4int LZ4_compress_HC
(
    const char * src,
    char * dst,
    int srcSize,
    int dstCapacity,
    int compressionLevel
)

Remarks

LZ4_compress_HC() : Compress data from src_ into dst, using the powerful but slower "HC" algorithm. `dst must be already allocated. Compression is guaranteed to succeed if dstCapacity >= LZ4_compressBound(srcSize)_ (see "lz4.h") Max supported srcSize value is LZ4_MAX_INPUT_SIZE (see "lz4.h") `compressionLevel : any value between 1 and LZ4HC_CLEVEL_MAX will work. Values > LZ4HC_CLEVEL_MAX behave the same as LZ4HC_CLEVEL_MAX.

Returns

: the number of bytes written into 'dst' or 0 if compression fails.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss