Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Compression > API/Runtime/Core/Compression/FCompressedBuffer > API/Runtime/Core/Compression/FCompressedBuffer/Compress
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/Compression/CompressedBuffer.h |
| Include | #include "Compression/CompressedBuffer.h" |
| Source | /Engine/Source/Runtime/Core/Private/Compression/CompressedBuffer.cpp |
static FCompressedBuffer Compress
(
const FCompositeBuffer & RawData,
ECompressedBufferCompressor Compressor,
ECompressedBufferCompressionLevel CompressionLevel,
uint64 BlockSize
)
Remarks
Compress the buffer using the specified compressor and compression level.
Data that does not compress will be return uncompressed, as if with level None.
Using a level of None will return a buffer that references owned raw data. An owned compressed buffer, or null on error.
Parameters
| Name | Description |
|---|---|
| RawData | The raw data to be compressed. |
| Compressor | The compressor to encode with. May use NotSet if level is None. |
| CompressionLevel | The compression level to encode with. |
| BlockSize | The power-of-two block size to encode raw data in. 0 is default. |