Compression::IDecompressionInterface Struct Reference

Inherited by CompressionLZ4::DecompressorLZ4.

Public Member Functions
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()

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

pure virtual

Decompresses the input compressed data into the uncompressed buffer Both parameters are specified as spans which encapsulates the contiguous buffer and it's size.

Parameters

uncompressedBuffer	destination buffer where uncompress output will be stored
compressedData	source buffer containing compressed data to decompress
decompressionOptions	that can be provided to the Compressor

Returns

a DecompressionResultData instance to indicate if compression operation has succeeded

Implemented in CompressionLZ4::DecompressorLZ4.

GetCompressionAlgorithmId()

virtual CompressionAlgorithmId Compression::IDecompressionInterface::GetCompressionAlgorithmId ( ) const

pure virtual

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

Implemented in CompressionLZ4::DecompressorLZ4.

GetCompressionAlgorithmName()

virtual AZStd::string_view Compression::IDecompressionInterface::GetCompressionAlgorithmName ( ) const

pure virtual

Human readable name associated with the compression algorithm.

Implemented in CompressionLZ4::DecompressorLZ4.

---

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

• Gems/Compression/Code/Include/Compression/DecompressionInterfaceAPI.h