FCompressedBuffer

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Compression

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

Type	Name	Description
FCompressedBuffer	Compress ( const FCompositeBuffer& RawData, ECompressedBufferCompressor Compressor, ECompressedBufferCompressionLevel CompressionLevel, uint64 BlockSize )	Compress the buffer using the specified compressor and compression level.
FCompressedBuffer	Compress ( const FSharedBuffer& RawData )	Compress the buffer using a balanced level of compression.
FCompressedBuffer	Compress ( const FCompositeBuffer& RawData )	Compress the buffer using a balanced level of compression.
FCompressedBuffer	Compress ( const FSharedBuffer& RawData, ECompressedBufferCompressor Compressor, ECompressedBufferCompressionLevel CompressionLevel, uint64 BlockSize )
FSharedBuffer	Decompress ()	Decompress into an owned buffer.
FCompositeBuffer	DecompressToComposite ()	Decompress into an owned buffer.
FCompressedBuffer	FromCompressed ( FCompositeBuffer&& CompressedData )	Construct from a compressed buffer previously created by Compress().
FCompressedBuffer	FromCompressed ( const FSharedBuffer& CompressedData )	Construct from a compressed buffer previously created by Compress().
FCompressedBuffer	FromCompressed ( FSharedBuffer&& CompressedData )	Construct from a compressed buffer previously created by Compress().
FCompressedBuffer	FromCompressed ( const FCompositeBuffer& CompressedData )	Construct from a compressed buffer previously created by Compress().
const FCompositeBuffer &	GetCompressed ()	Returns a composite buffer containing the compressed data. May be null. May not be owned.
FCompositeBuffer	GetCompressed ()
uint64	GetCompressedSize ()	Returns the size of the compressed data. Zero on error or if this is null.
FIoHash	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.
FCompressedBuffer	Load ( FArchive& Ar )	Load a compressed buffer from an archive, as saved by Save().
FCompressedBuffer	MakeOwned ()
FCompressedBuffer	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& OutCompressor, ECompressedBufferCompressionLevel& OutCompressionLevel, uint64& OutBlockSize )	Returns the compressor and compression level used by this buffer.