Cogs::Core::ResourceLoadInfoBase Struct Reference

Inheritance diagram for Cogs::Core::ResourceLoadInfoBase:

Public Member Functions
bool	loadSync () const
bool	isReload () const
bool	shouldAutoReload () const
bool	noDefaultName () const

Public Attributes
ResourceId	resourceId = NoResourceId
	Unique resource identifier. Must be unique among resources of the same kind.
std::string	resourcePath
	Resource path. Used to locate resource.
std::string	resourceName
	Desired resource name. If no name is given, a default name will be chosen.
std::vector< uint8_t >	resourceData
	Resource load data.
ResourceFlags	resourceFlags = ResourceFlags::None
	Desired resource flags. Flags will be validated and, if possible, applied to the loaded resource.
ResourceLoadFlags	loadFlags = ResourceLoadFlags::None
	Desired loading flags. Used to specify how the resource will be loaded.
ResourceHandleBase	handle = ResourceHandleBase::NoHandle
	Handle to resource structure for holding actual resource data.
bool	preloading = false
ResourceProtocol	protocol = ResourceProtocol::None

Detailed Description

Definition at line 16 of file ResourceLoadInfo.h.

Member Function Documentation

isReload()

bool Cogs::Core::ResourceLoadInfoBase::isReload ( ) const

inline

Definition at line 21 of file ResourceLoadInfo.h.

loadSync()

bool Cogs::Core::ResourceLoadInfoBase::loadSync ( ) const

inline

Definition at line 20 of file ResourceLoadInfo.h.

noDefaultName()

bool Cogs::Core::ResourceLoadInfoBase::noDefaultName ( ) const

inline

Definition at line 23 of file ResourceLoadInfo.h.

shouldAutoReload()

bool Cogs::Core::ResourceLoadInfoBase::shouldAutoReload ( ) const

inline

Definition at line 22 of file ResourceLoadInfo.h.

Member Data Documentation

handle

ResourceHandleBase Cogs::Core::ResourceLoadInfoBase::handle = ResourceHandleBase::NoHandle

Handle to resource structure for holding actual resource data.

Definition at line 44 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::CurtainView::CurtainViewSystem::createComponent(), Cogs::Core::AssetManager::handleLoad(), Cogs::Core::EffectManager::handleLoad(), Cogs::Core::FontManager::handleLoad(), Cogs::Core::GuiManager::handleLoad(), Cogs::Core::MaterialManager::handleLoad(), Cogs::Core::ModelManager::handleLoad(), Cogs::Core::MeshManager::handleLoad(), Cogs::Core::ResourceManagerBase::loadResourceInternal(), Cogs::Core::TextureManager::loadTexture(), Cogs::Core::ResourceManagerBase::processLoading(), Cogs::Core::ResourceManagerBase::queueResource(), and Cogs::Core::ResourceManagerBase::setProcessed().

loadFlags

ResourceLoadFlags Cogs::Core::ResourceLoadInfoBase::loadFlags = ResourceLoadFlags::None

Desired loading flags. Used to specify how the resource will be loaded.

Definition at line 41 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::CurtainView::CurtainViewSystem::createComponent(), Cogs::Core::FontManager::loadFont(), Cogs::Core::MaterialManager::loadMaterial(), Cogs::Core::ModelManager::loadModel(), Cogs::Core::ResourceManagerBase::loadResourceInternal(), Cogs::Core::TextureManager::loadTexture(), and Cogs::Core::TextureManager::loadTextureFromMemory().

preloading

bool Cogs::Core::ResourceLoadInfoBase::preloading = false

If the resource is preloading. TODO: Exchange for flag.

Definition at line 48 of file ResourceLoadInfo.h.

protocol

ResourceProtocol Cogs::Core::ResourceLoadInfoBase::protocol = ResourceProtocol::None

Definition at line 51 of file ResourceLoadInfo.h.

resourceData

std::vector<uint8_t> Cogs::Core::ResourceLoadInfoBase::resourceData

Resource load data.

Definition at line 35 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::CurtainView::CurtainViewSystem::createComponent(), Cogs::Core::TextureManager::loadTexture(), Cogs::Core::TextureManager::loadTextureFromMemory(), and Cogs::Core::TextureManager::postProcessLoading().

resourceFlags

ResourceFlags Cogs::Core::ResourceLoadInfoBase::resourceFlags = ResourceFlags::None

Desired resource flags. Flags will be validated and, if possible, applied to the loaded resource.

Definition at line 38 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::ResourceManagerBase::loadResourceInternal().

resourceId

ResourceId Cogs::Core::ResourceLoadInfoBase::resourceId = NoResourceId

Unique resource identifier. Must be unique among resources of the same kind.

Definition at line 26 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::CurtainView::CurtainViewSystem::createComponent(), Cogs::Core::FontManager::loadFont(), Cogs::Core::MaterialManager::loadMaterial(), Cogs::Core::ModelManager::loadModel(), Cogs::Core::ResourceManagerBase::loadResourceInternal(), Cogs::Core::TextureManager::loadTexture(), Cogs::Core::TextureManager::loadTextureFromMemory(), and Cogs::Core::ResourceManagerBase::setProcessed().

resourceName

std::string Cogs::Core::ResourceLoadInfoBase::resourceName

Desired resource name. If no name is given, a default name will be chosen.

Definition at line 32 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::FontManager::handleLoad(), Cogs::Core::ModelManager::handleLoad(), Cogs::Core::EffectManager::loadEffect(), Cogs::Core::FontManager::loadFont(), and Cogs::Core::ResourceManagerBase::loadResourceInternal().

resourcePath

std::string Cogs::Core::ResourceLoadInfoBase::resourcePath

Resource path. Used to locate resource.

Definition at line 29 of file ResourceLoadInfo.h.

Referenced by Cogs::Core::FontManager::handleFailedLoad(), Cogs::Core::AssetManager::handleLoad(), Cogs::Core::GuiManager::handleLoad(), Cogs::Core::MaterialManager::handleLoad(), Cogs::Core::ModelManager::handleLoad(), Cogs::Core::TextureManager::handleLoad(), Cogs::Core::FontManager::loadFont(), Cogs::Core::MaterialManager::loadMaterial(), Cogs::Core::ModelManager::loadModel(), Cogs::Core::ResourceManagerBase::loadResourceInternal(), Cogs::Core::TextureManager::loadTexture(), and Cogs::Core::TextureManager::loadTextureFromMemory().

---

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

• Source/Resources/ResourceLoadInfo.h