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
Public Member Functions inherited from Compression::IDecompressionInterface

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

nodiscardoverridevirtual

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:

• Gems/Compression/Code/Source/Clients/DecompressorLZ4Impl.h