FCompression::CompressMemoryBound

Thread-safe abstract compression routine to query memory requirements for a compression operation.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Misc/Compression.h"

Source

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

Syntax

static int32 CompressMemoryBound
(
    FName FormatName,
    int32 UncompressedSize,
    ECompressionFlags Flags,
    int32 CompressionData
)

Remarks

Thread-safe abstract compression routine to query memory requirements for a compression operation.

Returns

The maximum possible bytes needed for compression of data buffer of size UncompressedSize

Parameters

Parameter

Description

Flags

Flags to control what method to use and optionally control memory vs speed

UncompressedSize

Size of uncompressed data in bytes

BitWindow

Bit window to use in compression

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