Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FCompression
Description
Thread-safe abstract decompression routine. Uncompresses memory from compressed buffer and writes it to uncompressed buffer. UncompressedSize is expected to be the exact size of the data after decompression.
| Name | UncompressMemory |
| 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 UncompressMemory
(
FName FormatName,
void * UncompressedBuffer,
int64 UncompressedSize,
const void * CompressedBuffer,
int64 CompressedSize,
ECompressionFlags Flags,
uintptr_t CompressionData
)
true if compression succeeds, false if it fails because CompressedBuffer was too small or other reasons
Parameters
| Name | Remarks |
|---|---|
| FormatName | Name of the compression format |
| UncompressedBuffer | Buffer containing uncompressed data |
| UncompressedSize | Size of uncompressed data in bytes |
| CompressedBuffer | Buffer compressed data is going to be read from |
| CompressedSize | Size of CompressedBuffer data in bytes |
| Flags | Flags to control what method to use to decompress |
| CompressionData | Additional decompression parameter (specifies BitWindow value for ZLIB compression format) |