Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FCompression
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CompressMemoryBound
(
FName InFormatName, |
Thread-safe abstract compression routine to query buffer requirements for a compression operation. | Misc/Compression.h | |
static int32 CompressMemoryBound
(
FName FormatName, |
Thunks to the 64 bit, prefer that as this can only Fatal on error! | Misc/Compression.h |
CompressMemoryBound(FName, int64 &, int64, uintptr_t)
Description
Thread-safe abstract compression routine to query buffer requirements for a compression operation. This is the minimize size to allocate the buffer for CompressMemory (encoding). Use GetMaximumCompressedSize at decode to know how large a compressed buffer may be.
Despite the name, this has nothing to do with how much memory will be allocated during compression.
| Name | CompressMemoryBound |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/Compression.h |
| Include Path | #include "Misc/Compression.h" |
| Source | /Engine/Source/Runtime/Core/Private/Misc/Compression.cpp |
static bool CompressMemoryBound
(
FName InFormatName,
int64 & OutBufferSizeRequired,
int64 InUncompressedSizeBytes,
uintptr_t InCompressionData
)
false if the bounds couldn't be determined - e.g. the format is unknown or the size isn't supported by the format.
Parameters
| Name | Remarks |
|---|---|
| FormatName | Name of the compression format |
| UncompressedSize | Size of uncompressed data in bytes |
| CompressionData | Additional compression parameter - see comments a top of FCompression struct. |
| OutBufferSizeRequired | The maximum possible bytes needed for compression of a data buffer of the given size. |
CompressMemoryBound(FName, int32, ECompressionFlags, int32)
Description
Thunks to the 64 bit, prefer that as this can only Fatal on error!
| Name | CompressMemoryBound |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/Compression.h |
| Include Path | #include "Misc/Compression.h" |
| Source | /Engine/Source/Runtime/Core/Private/Misc/Compression.cpp |
static int32 CompressMemoryBound
(
FName FormatName,
int32 UncompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)