Open 3D Engine Compression Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
CompressionLZ4::DecompressorLZ4 Class Reference

Inherits Compression::IDecompressionInterface.

Public Member Functions

Compression::CompressionAlgorithmId GetCompressionAlgorithmId () const override
 Retrieves the 32-bit compression algorithm ID associated with this interface.
 
AZStd::string_view GetCompressionAlgorithmName () const override
 Retrieves the human readable associated with the LZ4 compressor.
 
Compression::DecompressionResultData DecompressBlock (AZStd::span< AZStd::byte > decompressionBuffer, const AZStd::span< const AZStd::byte > &compressedData, const Compression::DecompressionOptions &decompressionOptions={}) const override
 
virtual CompressionAlgorithmId GetCompressionAlgorithmId () const =0
 Retrieves the 32-bit compression algorithm ID associated with this interface.
 
virtual AZStd::string_view GetCompressionAlgorithmName () const =0
 Human readable name associated with the compression algorithm.
 
virtual DecompressionResultData DecompressBlock (AZStd::span< AZStd::byte > decompressionBuffer, const AZStd::span< const AZStd::byte > &compressedData, const DecompressionOptions &decompressionOptions={}) const =0
 

Member Function Documentation

◆ DecompressBlock()

Compression::DecompressionResultData CompressionLZ4::DecompressorLZ4::DecompressBlock ( AZStd::span< AZStd::byte >  decompressionBuffer,
const AZStd::span< const AZStd::byte > &  compressedData,
const Compression::DecompressionOptions &  decompressionOptions = {} 
) const
overridevirtual

Compresses the uncompressed data into the compressed buffer

Returns
a CompressionResultData instance to indicate if compression operation has succeeded

Implements Compression::IDecompressionInterface.

◆ GetCompressionAlgorithmId()

Compression::CompressionAlgorithmId CompressionLZ4::DecompressorLZ4::GetCompressionAlgorithmId ( ) const
overridevirtual

Retrieves the 32-bit compression algorithm ID associated with this interface.

Implements Compression::IDecompressionInterface.

◆ GetCompressionAlgorithmName()

AZStd::string_view CompressionLZ4::DecompressorLZ4::GetCompressionAlgorithmName ( ) const
overridevirtual

Retrieves the human readable associated with the LZ4 compressor.

Implements Compression::IDecompressionInterface.

The documentation for this class was generated from the following file: