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.
Classes | Public Member Functions | List of all members
Compression::DecompressionRegistrarImpl Class Referencefinal

Inherits Compression::DecompressionRegistrarInterface.

Classes

struct  DecompressionInterfaceDeleter
 

Public Member Functions

 AZ_RTTI (DecompressionRegistrarImpl,"{2353362A-A059-4681-ADF0-5ABE41E85A6B}", DecompressionRegistrarInterface)
 
 AZ_CLASS_ALLOCATOR (DecompressionRegistrarImpl, AZ::SystemAllocator)
 
void VisitDecompressionInterfaces (const VisitDecompressionInterfaceCallback &) const override
 Invokes the supplied visitor for each register decompression interface that is non-nullptr.
 
AZ::Outcome< void,
AZStd::unique_ptr
< IDecompressionInterface > > 		RegisterDecompressionInterface (CompressionAlgorithmId algorithmId, AZStd::unique_ptr< IDecompressionInterface > decompressionInterface) override
 Registers a decompression interface with a standard deleter.
 
bool RegisterDecompressionInterface (CompressionAlgorithmId algorithmId, IDecompressionInterface &decompressionInterface) override
 Registers a decompression interface with a null deleter.
 
bool UnregisterDecompressionInterface (CompressionAlgorithmId algorithmId) override
 
IDecompressionInterface * FindDecompressionInterface (CompressionAlgorithmId algorithmId) const override
 
bool IsRegistered (CompressionAlgorithmId algorithmId) const override
 
- Public Member Functions inherited from Compression::DecompressionRegistrarInterface
 AZ_RTTI (DecompressionRegistrarInterface,"{DB1ACA55-B36F-469B-9704-EC486D9FC810}")
 

Additional Inherited Members

- Public Types inherited from Compression::DecompressionRegistrarInterface
using VisitDecompressionInterfaceCallback = AZStd::function< bool(IDecompressionInterface &)>
 

Member Function Documentation

IDecompressionInterface* Compression::DecompressionRegistrarImpl::FindDecompressionInterface ( CompressionAlgorithmId  compressionAlgorithmId) const
overridevirtual

Queries the decompression interface with the decompression algorithmd Id

Parameters
compressionAlgorithmIdunique Id of decompression interface to query
Returns
pointer to the decompression tnterface or nullptr if not found

Implements Compression::DecompressionRegistrarInterface.

bool Compression::DecompressionRegistrarImpl::IsRegistered ( CompressionAlgorithmId  compressionAlgorithmId) const
overridevirtual

Return true if there is an decompression interface registered with the specified id

Parameters
compressionAlgorithmIdCompressionAlgorithmId to determine if an decompression interface is registered
Returns
bool indicating if there is an decompression interface with the id registered

Implements Compression::DecompressionRegistrarInterface.

bool Compression::DecompressionRegistrarImpl::UnregisterDecompressionInterface ( CompressionAlgorithmId  compressionAlgorithmId)
overridevirtual

Unregisters the decompression interface with the specified id

Parameters
decompressionAlgorithmIdunique Id that identifies the decompression interface
Returns
true if the unregistration is successful

Implements Compression::DecompressionRegistrarInterface.

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