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::DecompressionResultData Struct Reference

Public Member Functions

constexpr operator bool () const
 Returns a boolean true if decompression has succeeded.
 
AZ::u64 GetUncompressedByteCount () const
 Retrieves the uncompressed size of the decompressed data. More...
 
AZStd::byte * GetUncompressedByteData () const
 

Public Attributes

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

Member Function Documentation

AZ::u64 Compression::DecompressionResultData::GetUncompressedByteCount ( ) const
inline

Retrieves the uncompressed size of the decompressed data.

Retrieves the uncompressed size of the decompression data from the span

AZStd::byte * Compression::DecompressionResultData::GetUncompressedByteData ( ) const
inline

Retrieves the memory address where the uncompressed data is stored

Member Data Documentation

AZStd::span<AZStd::byte> Compression::DecompressionResultData::m_uncompressedBuffer

Will be set to the memory address of the uncompressed buffer The size of the span will be set to actual uncompressed size

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