Open 3D Engine AzCore API Reference 23.10.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 | List of all members
AZ::Data::AssetCatalog Class Referenceabstract

#include <AssetManager.h>

Public Member Functions

virtual AssetStreamInfo GetStreamInfoForLoad (const AssetId &assetId, const AssetType &assetType)=0
 
virtual AssetStreamInfo GetStreamInfoForSave (const AssetId &assetId, const AssetType &assetType)
 

Detailed Description

Base interface to find an asset in a catalog. By design this is not performance critical code (as we use it on load only), but it is important to make sure this catalog operates in a reasonably fast way. Cache the information (if needed) about assets location (if we will do often load/unload)

Asset catalogs functions may be called from multiple threads, so make sure your code is thread safe.

Member Function Documentation

◆ GetStreamInfoForLoad()

virtual AssetStreamInfo AZ::Data::AssetCatalog::GetStreamInfoForLoad ( const AssetId &  assetId,
const AssetType &  assetType 
)
pure virtual

Find the stream the asset can be loaded from. Empty string if asset can't be found.

Parameters
id- asset id

◆ GetStreamInfoForSave()

virtual AssetStreamInfo AZ::Data::AssetCatalog::GetStreamInfoForSave ( const AssetId &  assetId,
const AssetType &  assetType 
)
inlinevirtual

Same as GetStreamInfoForLoad but for saving. It's not typical that assets will have 'save' support, as they are generated from external tools, etc. But when needed, the framework provides an interface.

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