1. Epic GamesDeveloper
  3. FCompressedBuffer

FCompressedBuffer

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

Unreal Engine C++ API Reference > 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
Public function Static FCompressedBuffer

Compress ( const FCompositeBuffer& RawData,
ECompressedBufferCompressor Compressor,
ECompressedBufferCompressionLevel CompressionLevel,
uint64 BlockSize
)

 Compress the buffer using the specified compressor and compression level.
Public function Static FCompressedBuffer

Compress ( const FSharedBuffer& RawData
)

  
Public function Static FCompressedBuffer

Compress ( const FCompositeBuffer& RawData
)

 Compress the buffer using a balanced level of compression.
Public function Static FCompressedBuffer

Compress ( const FSharedBuffer& RawData,
ECompressedBufferCompressor Compressor,
ECompressedBufferCompressionLevel CompressionLevel,
uint64 BlockSize
)

  
Public function Const FSharedBuffer Decompress into an owned buffer.
Public function Const FCompositeBuffer  
Public function Static FCompressedBuffer

FromCompressed ( FCompositeBuffer&& CompressedData
)

  
Public function Static FCompressedBuffer

FromCompressed ( const FSharedBuffer& CompressedData
)

  
Public function Static FCompressedBuffer

FromCompressed ( FSharedBuffer&& CompressedData
)

  
Public function Static FCompressedBuffer

FromCompressed ( const FCompositeBuffer& CompressedData
)

 Construct from a compressed buffer previously created by Compress().
Public function Const const FCompositeBuffer & Returns a composite buffer containing the compressed data. May be null. May not be owned.
Public function FCompositeBuffer  
Public function Const uint64 Returns the size of the compressed data. Zero on error or if this is null.
Public function Const FIoHash Returns the hash of the raw data. Zero on error or if this is null.
Public function Const uint64 Returns the size of the raw data. Zero on error or if this is empty or null.
Public function Const bool

IsNull ()

 Returns true if the compressed buffer is null.
Public function Const bool

IsOwned ()

 Returns true if the composite buffer is owned.
Public function Static FCompressedBuffer

Load ( FArchive& Ar
)

 Load a compressed buffer from an archive, as saved by Save().
Public function FCompressedBuffer  
Public function Const FCompressedBuffer Returns a copy of the compressed buffer that owns its underlying memory.
Public function void

Reset ()

 Reset this to null.
Public function Const void

Save ( FArchive& Ar
)

 Save the compressed buffer to an archive.
Public function Const bool Decompress into a memory view that is exactly equal to the raw size.
Public function Const bool

TryGetCompressParameters ( ECompressedBufferCompressor& OutCompressor,
ECompressedBufferCompressionLevel& OutCompressionLevel,
uint64& OutBlockSize
)

 Returns the compressor and compression level used by this buffer.

Operators

  Type Name Description
Public function Const   Returns true if the compressed buffer is not null.

Constants

Name Description
Null A null compressed buffer.

See Also

FCompressedBufferReader

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page