Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FCompression
Description
Thread-safe abstract compression routine to query maximum compressed size that could be made. This is used for making buffers that could hold any compressed buffer that started uncompressed with the given size. It's distinct from the buffer needed to compress! If you are calling CompressMemory then you need to pass a buffer sized based on CompressMemoryBound!
CompressMemoryBound is strictly greater equal GetMaximumCompressedSize.
| Name | GetMaximumCompressedSize |
| 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 GetMaximumCompressedSize
(
FName InFormatName,
int64 & OutMaxCompressedSize,
int64 InUncompressedSizeBytes,
uintptr_t InCompressionData
)
success
Parameters
| Name | Remarks |
|---|---|
| FormatName | Name of the compression format |
| OutMaxCompressedSize | The maximum possible size of valid compressed data made by this format |
| InUncompressedSizeBytes | Size of uncompressed data in bytes |
| CompressionData | Additional compression parameter - see comments a top of FCompression struct. |