Vulkan Schnee 0.0.1
High-performance rendering engine
Loading...
Searching...
No Matches
Asset::AssetBase Class Reference

Base class for asset wrappers. The data is stored in the private member variable 'data' in form of entt components. More...

#include <Asset.h>

Inheritance diagram for Asset::AssetBase:

Public Member Functions

 AssetBase (bool initializeDefaultEntity=false)
virtual ~AssetBase ()
CpuLoadingState getLoadingState ()
 Gets the loading state of this asset.
void requestLoad ()
 If this asset is in the UNLOADED state it will get added to the assets to load.
virtual void unload ()
 Base function for unloading the ecs data.
entt::entity getEntity () const
 Getter for data.

Protected Member Functions

virtual void updateLoadingState ()

Protected Attributes

CpuLoadingState loadingState = UNLOADED
entt::registry & mainRegistry
entt::entity data

Detailed Description

Base class for asset wrappers. The data is stored in the private member variable 'data' in form of entt components.

Definition at line 281 of file Asset.h.

Constructor & Destructor Documentation

◆ AssetBase()

Asset::AssetBase::AssetBase ( bool initializeDefaultEntity = false)
inlineexplicit

Definition at line 284 of file Asset.h.

References data, Asset::LOADING, loadingState, mainRegistry, and Asset::UNLOADED.

◆ ~AssetBase()

virtual Asset::AssetBase::~AssetBase ( )
virtual

Member Function Documentation

◆ getEntity()

entt::entity Asset::AssetBase::getEntity ( ) const

Getter for data.

Returns
data

◆ getLoadingState()

CpuLoadingState Asset::AssetBase::getLoadingState ( )
nodiscard

Gets the loading state of this asset.

Returns
Returns the state of loading of this asset

◆ requestLoad()

void Asset::AssetBase::requestLoad ( )

If this asset is in the UNLOADED state it will get added to the assets to load.

◆ unload()

virtual void Asset::AssetBase::unload ( )
virtual

Base function for unloading the ecs data.

Reimplemented in Engine::Assets::Audio, Engine::Assets::Material, Engine::Assets::Mesh, and Engine::Assets::Texture.

◆ updateLoadingState()

virtual void Asset::AssetBase::updateLoadingState ( )
inlineprotectedvirtual

Member Data Documentation

◆ data

entt::entity Asset::AssetBase::data
protected

Definition at line 321 of file Asset.h.

Referenced by AssetBase(), and Engine::Assets::Material::getData().

◆ loadingState

CpuLoadingState Asset::AssetBase::loadingState = UNLOADED
protected

Definition at line 318 of file Asset.h.

Referenced by AssetBase().

◆ mainRegistry

entt::registry& Asset::AssetBase::mainRegistry
protected

Definition at line 320 of file Asset.h.

Referenced by AssetBase(), and Engine::Assets::Material::getData().


The documentation for this class was generated from the following file:
  • /home/magerbeton/Documents/gl3-vulkan/Engine/include/Engine/Core/Asset.h