Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FArchive
Description
Serializes and compresses/ uncompresses data. This is a shared helper function for compression support.
Do not use SerializeCompressed in new code, prefer SerializeCompressedNew instead. SerializeCompressedNew can be dropped in to any existing use of SerializeCompressed.
| Name | SerializeCompressed |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Serialization/Archive.h |
| Include Path | #include "Serialization/Archive.h" |
| Source | /Engine/Source/Runtime/Core/Private/Serialization/Archive.cpp |
void SerializeCompressed
(
void * V,
int64 Length,
FName CompressionFormatCannotChange,
ECompressionFlags Flags,
bool bTreatBufferAsFileReader
)
Parameters
| Name | Remarks |
|---|---|
| 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 |