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 > Serialization > FArchive > FArchive::SerializeCompressed

Light Theme

Dark Theme

FArchive::SerializeCompressed

Serializes and compresses/ uncompresses data.

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 CompressionFormat,
    ECompressionFlags Flags,
    bool bTreatBufferAsFileReader
)

Remarks

Serializes and compresses/ uncompresses data. This is a shared helper function for compression support. The data is saved in a way compatible with FIOSystem::LoadCompressedData.

Parameters

Parameter	Description
V	Data pointer to serialize data from/ to
Length	Length of source data if we're saving, unused otherwise
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
bUsePlatformBitWindow	use a platform specific bitwindow setting

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

Take our survey

Dismiss