Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FCompression > FCompression::UncompressMemory

Light Theme

Dark Theme

FCompression::UncompressMemory

Thread-safe abstract decompression routine.

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 bool UncompressMemory
(
    FName FormatName,
    void * UncompressedBuffer,
    int32 UncompressedSize,
    const void * CompressedBuffer,
    int32 CompressedSize,
    ECompressionFlags Flags,
    int32 CompressionData
)

Remarks

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.

Returns

true if compression succeeds, false if it fails because CompressedBuffer was too small or other reasons

Parameters

Parameter	Description
Flags	Flags to control what method to use to decompress
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
bIsSourcePadded	Whether the source memory is padded with a full cache line at the end

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

Take our survey

Dismiss