XII Release 0.1.0
Loading...
Searching...
No Matches
Classes | Public Types | List of all members
xiiResourceFlags Struct Reference

The flags of a xiiResource instance. More...

#include <Declarations.h>

Classes

struct  Bits
 

Public Types

enum  Enum : StorageType {
  UpdateOnMainThread = XII_BIT(0) , NoFileAccessRequired = XII_BIT(1) , ResourceHasFallback = XII_BIT(2) , ResourceHasTypeFallback = XII_BIT(3) ,
  IsReloadable = XII_BIT(4) , IsQueuedForLoading = XII_BIT(5) , HasCustomDataLoader = XII_BIT(6) , PreventFileReload = XII_BIT(7) ,
  HasLowResData = XII_BIT(8) , IsCreatedResource = XII_BIT(9) , Default = 0U
}
 The flags of a xiiResource instance. More...
 
using StorageType = xiiUInt16
 

Detailed Description

The flags of a xiiResource instance.

Member Enumeration Documentation

◆ Enum

enum xiiResourceFlags::Enum : StorageType

The flags of a xiiResource instance.

Enumerator
UpdateOnMainThread 

After loading the resource data on a thread, it must be uploaded on the main thread. Use this for resources which require a context that is only available on the main thread.

NoFileAccessRequired 

The resource 'loading' does not require file accesses and can therefore be done on one or several non-file-loading threads. Use this for procedurally generated data.

ResourceHasFallback 

Specifies whether this resource has a valid fallback resource that could be used. Automatically updated in xiiResource::SetFallbackResource.

Todo
Implement NoFileAccessRequired.
ResourceHasTypeFallback 

Specifies whether this resource has a valid type fallback that could be used.

IsReloadable 

The resource was created, not loaded from file.

HasCustomDataLoader 

True if someone wants to update a resource with custom data and has created a resource loader to update this specific resource.

PreventFileReload 

Once this flag is set, no reloading from file is done, until the flag is manually removed. Automatically set when a custom loader is used. To restore a file to the disk state, this flag must be removed and then the resource can be reloaded.

HasLowResData 

Whether low resolution data was set on a resource once before.

IsCreatedResource 

When this is set, the resource was created and not loaded from file.

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