FArchive::SerializeCompressed

Serializes and compresses/ uncompresses data.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/Archive.h

Include

#include "Serialization/Archive.h"

Source

/Engine/Source/Runtime/Core/Private/Serialization/Archive.cpp

Syntax

void SerializeCompressed
(
    void * V,
    int64 Length,
    FName CompressionFormatCannotChange,
    ECompressionFlags Flags,
    bool bTreatBufferAsFileReader
)

Remarks

Serializes and compresses/ uncompresses data. This is a shared helper function for compression support.

/ @ old comment ? remove me ? The data is saved in a way compatible with FIOSystem::LoadCompressedData.

prefer SerializeCompressedNew instead.

Parameters

Parameter

Description

V

Data pointer to serialize data from/ to

Length

Length of source data if we're saving, unused otherwise

CompressionFormatCannotChange

Compression Format to use for encoding & decoding - cannot be changed without breaking file compatibility

Flags

Flags to control what method to use for [de]compression and optionally control memory vs speed when compressing

bTreatBufferAsFileReader

true if V is actually an FArchive, which is used when saving to read data - helps to avoid single huge allocations of source data