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.
Public Member Functions | Public Attributes | List of all members
Compression::CompressionResultData Struct Reference

Public Member Functions

constexpr operator bool () const
 Returns a boolean true if compression has completed. More...
 
AZ::u64 GetCompressedByteCount () const
 Retrieves the compressed byte size. More...
 
AZStd::byte * GetCompressedByteData () const
 Retrieves the memory address of the compressed data.
 

Public Attributes

AZStd::span< AZStd::byte > m_compressedBuffer
 
CompressionResult m_result { CompressionResult::PendingStart }
 Stores result code of whether the operation succeeded.
 

Member Function Documentation

AZ::u64 Compression::CompressionResultData::GetCompressedByteCount ( ) const
inline

Retrieves the compressed byte size.

Retrieves the compressed data size.

constexpr Compression::CompressionResultData::operator bool ( ) const
inlineexplicit

Returns a boolean true if compression has completed.

Returns a boolean true if decompression has completed.

Member Data Documentation

AZStd::span<AZStd::byte> Compression::CompressionResultData::m_compressedBuffer

Will be set to the memory address of the compressed buffer supplied to the compression interface CompressBlock command The size of the span will be set to actual uncompressed size

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