Open 3D Engine Compression Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Compression::ICompressionInterface Struct Referenceabstract

Public Member Functions

virtual CompressionAlgorithmId GetCompressionAlgorithmId () const =0
 Retrieves the 32-bit compression algorithm ID associated with this interface.
 
virtual CompressionResultData CompressBlock (AZStd::span< AZStd::byte > compressedBuffer, const AZStd::span< const AZStd::byte > &uncompressedData)=0
 

Member Function Documentation

virtual CompressionResultData Compression::ICompressionInterface::CompressBlock ( AZStd::span< AZStd::byte >  compressedBuffer,
const AZStd::span< const AZStd::byte > &  uncompressedData 
)
pure virtual

Compresses the uncompressed data into the compressed buffer

Returns
a CompressionResultData instance to indicate if compression operation has succeeded

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