Load information for Effect resources. More...
#include <EffectManager.h>
Public Attributes | |
| EffectDefinition | definition |
| Definition of the effect and its dependencies. | |
| std::vector< std::string > | dependencies |
| Paths to all dependencies that need to be resident before activating the effect. | |
| bool | preloading = false |
| If the effect is currently in the preloading phase, still resolving dependencies. | |
 Public Attributes inherited from Cogs::Core::ResourceLoadInfoBase | |
| 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 |
Additional Inherited Members | |
| Public Member Functions inherited from Cogs::Core::ResourceLoadInfoBase | |
| bool | loadSync () const |
| bool | isReload () const |
| bool | shouldAutoReload () const |
| bool | noDefaultName () const |
Detailed Description
Load information for Effect resources.
Definition at line 19 of file EffectManager.h.
Member Data Documentation
◆ definition
| EffectDefinition Cogs::Core::EffectLoadInfo::definition |
Definition of the effect and its dependencies.
Definition at line 22 of file EffectManager.h.
Referenced by Cogs::Core::EffectManager::handleLoad(), and Cogs::Core::EffectManager::loadEffect().
◆ dependencies
| std::vector<std::string> Cogs::Core::EffectLoadInfo::dependencies |
Paths to all dependencies that need to be resident before activating the effect.
Definition at line 25 of file EffectManager.h.
Referenced by Cogs::Core::EffectManager::handleLoad(), and Cogs::Core::EffectManager::loadEffect().
◆ preloading
| bool Cogs::Core::EffectLoadInfo::preloading = false |
If the effect is currently in the preloading phase, still resolving dependencies.
Definition at line 28 of file EffectManager.h.
Referenced by Cogs::Core::EffectManager::handleLoad().
The documentation for this struct was generated from the following file:
- Source/Resources/EffectManager.h
