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::CompressionRegistrarImpl Class Referencefinal

Inherits Compression::CompressionRegistrarInterface.

Classes

struct  CompressionInterfaceDeleter
 

Public Member Functions

 AZ_RTTI (CompressionRegistrarImpl,"{9F3B8418-4BEB-4249-BAAF-6653A8F511A3}", CompressionRegistrarInterface)
 
 AZ_CLASS_ALLOCATOR (CompressionRegistrarImpl, AZ::SystemAllocator)
 
void VisitCompressionInterfaces (const VisitCompressionInterfaceCallback &) const override
 Invokes the supplied visitor for each register compression interface that is non-nullptr.
 
AZ::Outcome< void,
AZStd::unique_ptr
< ICompressionInterface > > 		RegisterCompressionInterface (CompressionAlgorithmId algorithmId, AZStd::unique_ptr< ICompressionInterface > compressionInterface) override
 Registers a compression interface with a standard deleter.
 
bool RegisterCompressionInterface (CompressionAlgorithmId algorithmId, ICompressionInterface &compressionInterface) override
 Registers a compression interface with a null deleter.
 
bool UnregisterCompressionInterface (CompressionAlgorithmId algorithmId) override
 
ICompressionInterface * FindCompressionInterface (CompressionAlgorithmId algorithmId) const override
 
bool IsRegistered (CompressionAlgorithmId algorithmId) const override
 
- Public Member Functions inherited from Compression::CompressionRegistrarInterface
 AZ_RTTI (CompressionRegistrarInterface,"{92251FE8-9D19-4A23-9A2B-F91D99D9491B}")
 

Additional Inherited Members

- Public Types inherited from Compression::CompressionRegistrarInterface
using VisitCompressionInterfaceCallback = AZStd::function< bool(ICompressionInterface &)>
 

Member Function Documentation

ICompressionInterface* Compression::CompressionRegistrarImpl::FindCompressionInterface ( CompressionAlgorithmId  compressionAlgorithmId) const
overridevirtual

Queries the compression interface with the compression algorithmd Id

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

Implements Compression::CompressionRegistrarInterface.

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

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

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

Implements Compression::CompressionRegistrarInterface.

bool Compression::CompressionRegistrarImpl::UnregisterCompressionInterface ( CompressionAlgorithmId  compressionAlgorithmId)
overridevirtual

Unregisters the compression interface with the specified id

Parameters
compressionAlgorithmIdunique Id that identifies the compression interface
Returns
true if the unregistration is successful

Implements Compression::CompressionRegistrarInterface.

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