FCompressedBuffer

A compressed buffer stores compressed data in a self-contained format.

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Compression/CompressedBuffer.h
Include	#include "Compression/CompressedBuffer.h"

Syntax

class FCompressedBuffer

Remarks

A compressed buffer stores compressed data in a self-contained format.

A buffer is self-contained in the sense that it can be decompressed without external knowledge of the compression format or the size of the raw data.

The buffer may be partially decompressed using FCompressedBufferReader.

Functions

	Name	Description
FCompressedB...	Compress ( const FCompositeBuffer& RawData, ECompressedBufferCompressor Compres..., ECompressedBufferCompressionLevel C..., uint64 BlockSize )	Compress the buffer using the specified compressor and compression level.
FCompressedB...	Compress ( const FSharedBuffer& RawData )	Compress the buffer using a balanced level of compression.
FCompressedB...	Compress ( const FCompositeBuffer& RawData )	Compress the buffer using a balanced level of compression.
FCompressedB...	Compress ( const FSharedBuffer& RawData, ECompressedBufferCompressor Compres..., ECompressedBufferCompressionLevel C..., uint64 BlockSize )
FSharedBuffe...	Decompress()	Decompress into an owned buffer.
FCompositeBu...	DecompressToComposite()	Decompress into an owned buffer.
FCompressedB...	FromCompressed ( FCompositeBuffer&& CompressedData )	Construct from a compressed buffer previously created by Compress().
FCompressedB...	FromCompressed ( const FSharedBuffer& CompressedDat... )	Construct from a compressed buffer previously created by Compress().
FCompressedB...	FromCompressed ( FSharedBuffer&& CompressedData )	Construct from a compressed buffer previously created by Compress().
FCompressedB...	FromCompressed ( const FCompositeBuffer& Compressed... )	Construct from a compressed buffer previously created by Compress().
const FCompo...	GetCompressed()	Returns a composite buffer containing the compressed data. May be null. May not be owned.
FCompositeBu...	GetCompressed()
uint64	GetCompressedSize()	Returns the size of the compressed data. Zero on error or if this is null.
FBlake3Hash	GetRawHash()	Returns the hash of the raw data. Zero on error or if this is null.
uint64	GetRawSize()	Returns the size of the raw data. Zero on error or if this is empty or null.
bool	IsNull()	Returns true if the compressed buffer is null.
bool	IsOwned()	Returns true if the composite buffer is owned.
FCompressedB...	Load ( FArchive& Ar )	Load a compressed buffer from an archive, as saved by Save().
FCompressedB...	MakeOwned()
FCompressedB...	MakeOwned()	Returns a copy of the compressed buffer that owns its underlying memory.
void	Reset()	Reset this to null.
void	Save ( FArchive& Ar )	Save the compressed buffer to an archive.
bool	TryDecompressTo ( FMutableMemoryView RawView )	Decompress into a memory view that is exactly equal to the raw size.
bool	TryGetCompressParameters ( ECompressedBufferCompressor& OutCo..., ECompressedBufferCompressionLevel&..., uint64& OutBlockSize )	Returns the compressor and compression level used by this buffer.

Operators

		Name	Description
		operator bool()	Returns true if the compressed buffer is not null.

Constants

Name	Description
Null	A null compressed buffer.