LZ4_decoderRingBufferSize

[LZ4_decoderRingBufferSize()](API\Runtime\Core\Compression\LZ4_decoderRingBufferSize) : v1.8.2+

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

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

Include

#include "Compression/lz4.h"

Syntax

LZ4int LZ4_decoderRingBufferSize
(
    int maxBlockSize
)

Remarks

LZ4_decoderRingBufferSize() : v1.8.2+

: in a ring buffer scenario (optional), blocks are presumed decompressed next to each other up to the moment there is not enough remaining space for next block (remainingSize < maxBlockSize), at which stage it resumes from beginning of ring buffer. When setting such a ring buffer for streaming decompression, provides the minimum size of this ring buffer to be compatible with any source respecting maxBlockSize condition.

Returns

: minimum ring buffer size, or 0 if there is an error (invalid maxBlockSize).