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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback