carb::assets

Namespace for carb.assets.plugin and related utilities.

Classes

• carb::assets::AssetTypeParams: Parameters that describe an asset type’s characteristics.

• carb::assets::IAssets: Defines an interface for managing assets that are loaded asynchronously.

• carb::assets::IAssetsBlob: Defines an interface for managing assets that are loaded asynchronously.

• carb::assets::LoadContext: A load context that exists for the duration of the load phase. A loader may create a subclass of this to maintain context data about a type.

• carb::assets::LoaderDesc: Defines the loader functions for an asset type.

• carb::assets::LoadParameters: Parameters that can be passed into IAssets::loadAsset(). Asset types can create a subclass of this to pass asset-type-specific load parameters through the asset system.

• carb::assets::Type: Wrapper for an asset type that can be passed to various functions, identifies the asset as a hashed string plus the version number, which can impact the carb::assets::LoadParameters structure.

• carb::assets::ScopedSnapshot: A scoped snapshot, this automatically releases the snapshot when it goes out of scope.

Enums

• carb::assets::Reason: The reason a Snapshot was taken or not.

Functions

• carb::assets::getAssetType: Defines a template for users to specialize their asset type as unique identifiers.

• carb::assets::operator!=: ScopedSnapshot inequality operator

• carb::assets::operator==: ScopedSnapshot equality operator

Typedefs

• carb::assets::AssetHash: The hash must be a strong (not necessarily cryptographically secure) 128-bit hash.

• carb::assets::CreateContextFn: Loader function (member of carb::assets::LoaderDesc) that informs the asset type that loading a file has started and creates any load-specific context data necessary.

• carb::assets::CreateDependenciesFn: Loader function (member of carb::assets::LoaderDesc) that returns a string of the asset dependencies, that is, other files to watch for changes.

• carb::assets::CreateLoadParametersFn: Loader function (member of carb::assets::LoaderDesc) that copies a carb::assets::LoadParameters structure.

• carb::assets::DestroyContextFn: Loader function (member of carb::assets::LoaderDesc) that destroys the data created by carb::assets::CreateContextFn.

• carb::assets::DestroyDependenciesFn: Loader function (member of carb::assets::LoaderDesc) that cleans up the previously returned value from carb::assets::CreateDependenciesFn.

• carb::assets::DestroyLoadParametersFn: Loader function (member of carb::assets::LoaderDesc) that destroys a copied carb::assets::LoadParameters structure.

• carb::assets::HashAssetFn: Loader function (member of carb::assets::LoaderDesc) that hashes an asset’s data, this is used to combine collisions in the asset system.

• carb::assets::HashedType: C++ carb::assets::Type hash used to identify a C++ type. Typically a hash of a type name string.

• carb::assets::HashLoadParametersFn: Loader function (member of carb::assets::LoaderDesc) that hashes a carb::assets::LoadParameters structure.

• carb::assets::Id: An Asset ID, used to identify a particular asset.

• carb::assets::IsLoadCanceledFn: Determines if a currently processed load has been canceled.

• carb::assets::LoadAssetFn: Loader function (member of carb::assets::LoaderDesc) used to construct an asset from raw data.

• carb::assets::LoadParametersEqualsFn: Loader function (member of carb::assets::LoaderDesc) that determines if two carb::assets::LoadParameters derivatives are equal.

• carb::assets::OnChangeEventFn: Function to provide as a callback on asset changes.

• carb::assets::OnDependencyChangedFn: Loader function (member of carb::assets::LoaderDesc) that is called when a dependency changes.

• carb::assets::Pool: An Asset Pool, used to group assets together.

• carb::assets::Snapshot: A snapshot, representing asset data at a given point in time.

• carb::assets::UnloadAssetFn: Loader function (member of carb::assets::LoaderDesc) used to unload an asset.

Variables

• carb::assets::kInvalidAssetId: Used to identify an invalid asset id.

• carb::assets::kInvalidPool: Used to identify an invalid pool.

• carb::assets::kInvalidSnapshot: Used to identify an invalid snapshot.