76 Resources::ResourceId
CreateResource(
const Resources::ResourceName& res,
const void* loadInfo,
SizeT loadInfoSize,
const Util::StringAtom& tag, std::function<
void(
const Resources::ResourceId)> success, std::function<
void(
const Resources::ResourceId)> failed,
bool immediate,
bool stream);
82 void CreateListener(
const Resources::ResourceId res, std::function<
void(
const Resources::ResourceId)> success, std::function<
void(
const Resources::ResourceId)> failed);
87 const uint32_t
GetUsage(
const Resources::ResourceId
id)
const;
97 const bool HasResource(
const Resources::ResourceId
id)
const;
105 void ReloadResource(
const Resources::ResourceId&
id, std::function<
void(
const Resources::ResourceId)> success, std::function<
void(
const Resources::ResourceId)> failed);
108 void SetMinLod(
const Resources::ResourceId&
id,
const float lod,
bool immediate);
138 Resources::ResourceId
id;
153 Resources::ResourceId
id;
154 std::function<void(
const Resources::ResourceId)>
success;
155 std::function<void(
const Resources::ResourceId)>
failed;
188 virtual void Unload(
const Resources::ResourceId
id) = 0;
267 return this->
names[
id.loaderInstanceId];
276 return this->
usage[
id.loaderInstanceId];
285 return this->
tags[
id.loaderInstanceId];
294 return this->
states[
id.loaderInstanceId];
300inline const Resources::ResourceId
304 if (i ==
InvalidIndex)
return Resources::ResourceId::Invalid();
The common base class of Nebula.
Definition refcounted.h:38
Nebula's smart pointer class which manages the life time of RefCounted objects.
Definition ptr.h:38
State
Definition resource.h:26
Definition resourceloader.h:58
Ptr< ResourceLoaderThread > streamerThread
Definition resourceloader.h:229
Util::FixedArray< ResourceId > resources
Definition resourceloader.h:246
SubresourceLoadStatus
Definition resourceloader.h:165
@ Full
Definition resourceloader.h:166
@ Rejected
Definition resourceloader.h:168
@ Partial
Definition resourceloader.h:167
Util::FixedArray< Resources::ResourceName > names
Definition resourceloader.h:240
Util::Array< _PendingResourceUnload > pendingUnloads
Definition resourceloader.h:233
Resource::State LoadImmediate(_PendingResourceLoad &res)
Load immediately.
Definition resourceloader.cc:375
Util::Dictionary< Resources::ResourceName, uint32_t > ids
Definition resourceloader.h:237
__DeclareAbstractClass(ResourceLoader)
Util::FixedArray< Util::StringAtom > tags
Definition resourceloader.h:242
virtual void Update(IndexT frameIndex)
update the resource loader, this is done every frame
Definition resourceloader.cc:145
virtual void Setup()
setup resource loader, initiates the placeholder and error resources if valid, so don't forget to run...
Definition resourceloader.cc:42
Resources::ResourceId placeholderResourceId
Definition resourceloader.h:218
Util::StringAtom placeholderResourceName
these types need to be properly initiated in a subclass Setup function
Definition resourceloader.h:215
virtual Resource::State ReloadFromStream(const Resources::ResourceId id, const Ptr< IO::Stream > &stream)
perform a reload
Definition resourceloader.cc:108
Util::StringAtom streamerThreadName
Definition resourceloader.h:230
void DiscardByTag(const Util::StringAtom &tag)
discard all resources associated with a tag
Definition resourceloader.cc:634
void DiscardResource(const Resources::ResourceId id)
discard container
Definition resourceloader.cc:600
void RunCallbacks(Resource::State status, const Resources::ResourceId id)
run callbacks
Definition resourceloader.cc:238
uint32_t uniqueResourceId
Definition resourceloader.h:251
Threading::SafeQueue< _PendingStreamLod > pendingStreamQueue
Definition resourceloader.h:235
const Util::StringAtom GetTag(const Resources::ResourceId id) const
get resource tag was first registered with
Definition resourceloader.h:283
bool async
Definition resourceloader.h:227
int32_t uniqueId
id in resource manager
Definition resourceloader.h:254
ResourceLoader()
constructor
Definition resourceloader.cc:19
Util::FixedArray< Resource::State > states
Definition resourceloader.h:243
static const uint32_t ResourceIndexGrow
Definition resourceloader.h:171
const Util::Dictionary< Resources::ResourceName, Ids::Id32 > & GetResources() const
get the dictionary of all resource-id pairs
Definition resourceloader.h:312
friend Resource::State _LoadInternal(ResourceLoader *loader, const _PendingResourceLoad res)
Definition resourceloader.cc:268
virtual void RequestLOD(const Ids::Id32 entry, float lod) const
Set lod factor for resource.
Definition resourceloader.cc:136
Resources::ResourceId GetPlaceholder(const Resources::ResourceName &name)
get placeholder based on resource name
Definition resourceloader.cc:258
void CreateListener(const Resources::ResourceId res, std::function< void(const Resources::ResourceId)> success, std::function< void(const Resources::ResourceId)> failed)
Create new listener on resource.
Definition resourceloader.cc:653
Util::FixedArray< uint > loadedBits
Definition resourceloader.h:245
virtual ResourceUnknownId InitializeResource(const Ids::Id32 entry, const Util::StringAtom &tag, const Ptr< IO::Stream > &stream, bool immediate=false)=0
Initialize and create the resource, optionally load if no subresource management is necessary.
Util::Array< IndexT > pendingLoads
Definition resourceloader.h:232
const int32_t & GetUniqueId() const
get the global identifier for this pool
Definition resourceloader.h:330
Util::FixedArray< StreamData > streams
Definition resourceloader.h:250
Threading::ThreadId creatorThread
Definition resourceloader.h:258
Resources::ResourceId failResourceId
Definition resourceloader.h:219
virtual uint StreamResource(const ResourceId entry, IndexT frameIndex, uint requestedBits)
Stream resource.
Definition resourceloader.cc:98
virtual void LoadFallbackResources()
load placeholder and error resources
Definition resourceloader.cc:70
Util::FixedArray< _PendingResourceLoad > loads
Definition resourceloader.h:248
void SetMinLod(const Resources::ResourceId &id, const float lod, bool immediate)
begin updating a resources lod
Definition resourceloader.cc:745
const Resources::ResourceId GetId(const Resources::ResourceName &name) const
get resource id by name, use with care
Definition resourceloader.h:301
Resources::ResourceId CreateResource(const Resources::ResourceName &res, const void *loadInfo, SizeT loadInfoSize, const Util::StringAtom &tag, std::function< void(const Resources::ResourceId)> success, std::function< void(const Resources::ResourceId)> failed, bool immediate, bool stream)
create a container with a tag associated with it, if no tag is provided, the resource will be untagge...
Definition resourceloader.cc:410
void SetupIdFromEntry(const Ids::Id32 entry, ResourceId &cacheEntry)
Construct resource ID based on loader entry.
Definition resourceloader.cc:212
Util::Array< _PendingStreamLod > pendingStreamLods
Definition resourceloader.h:234
const bool HasResource(const Resources::ResourceId id) const
returns true if pool has resource
Definition resourceloader.h:321
virtual void Discard()
discard resource loader
Definition resourceloader.cc:60
void LoadAsync(_PendingResourceLoad res)
Load async.
Definition resourceloader.cc:388
Util::FixedArray< _PlaceholderResource > placeholders
Definition resourceloader.h:209
virtual ~ResourceLoader()
destructor
Definition resourceloader.cc:32
const Resources::ResourceName & GetName(const Resources::ResourceId id) const
get resource name
Definition resourceloader.h:265
virtual uint LodMask(const Ids::Id32 entry, float lod, bool stream) const
Create load mask based on LOD.
Definition resourceloader.cc:127
Util::FixedArray< uint32_t > usage
Definition resourceloader.h:241
void ReloadResource(const Resources::ResourceName &res, std::function< void(const Resources::ResourceId)> success, std::function< void(const Resources::ResourceId)> failed)
reload resource using resource name
Definition resourceloader.cc:686
Ids::IdPool resourceInstanceIndexPool
Definition resourceloader.h:238
Util::FixedArray< Util::Array< _Callbacks > > callbacks
Definition resourceloader.h:247
Util::FixedArray< uint > requestedBits
Definition resourceloader.h:244
const Resource::State GetState(const Resources::ResourceId id) const
get resource state
Definition resourceloader.h:292
Util::FixedArray< _LoadMetaData > metaData
Definition resourceloader.h:249
virtual void Unload(const Resources::ResourceId id)=0
unload resource (overload to implement resource deallocation)
virtual SubresourceLoadStatus StreamMaxLOD(const Resources::ResourceId &id, const float lod, bool immediate)
perform a lod update
Definition resourceloader.cc:118
Threading::CriticalSection asyncSection
async section to sync callbacks and pending list with thread
Definition resourceloader.h:257
Util::StringAtom failResourceName
Definition resourceloader.h:216
const uint32_t GetUsage(const Resources::ResourceId id) const
get resource usage from resource id
Definition resourceloader.h:274
Definition resourceloaderthread.h:23
Definition resourceserver.h:22
Critical section objects are used to protect a portion of code from parallel execution.
Thread-safe version of Util::Queue.
Definition safequeue.h:27
Nebula's dynamic array class.
Definition array.h:60
A collection of key/value pairs with quick value retrieval by key at roughly O(log n).
Definition dictionary.h:34
SizeT Size() const
return number of key/value pairs in the dictionary
Definition dictionary.h:193
Implements a fixed size one-dimensional array.
Definition fixedarray.h:20
IndexT FindIndex(const TYPE &val) const
find index of identical element in unsorted array (slow)
Definition fixedarray.h:511
A StringAtom.
Definition stringatom.h:22
uint32_t Id32
Definition id.h:138
A resource is a container for some type of file which is loaded.
Definition resource.cc:9
pthread_t ThreadId
Definition linuxthreadid.h:15
Definition resourceloader.h:50
uint64 submissionId
Definition resourceloader.h:52
uint bits
Definition resourceloader.h:51
callback functions to run when an associated resource is loaded (can be stacked)
Definition resourceloader.h:152
Resources::ResourceId id
Definition resourceloader.h:153
std::function< void(const Resources::ResourceId)> success
Definition resourceloader.h:154
std::function< void(const Resources::ResourceId)> failed
Definition resourceloader.h:155
struct for pending resources which are about to be loaded
Definition resourceloader.h:115
Ids::Id32 entry
Definition resourceloader.h:116
bool inflight
Definition resourceloader.h:118
IndexT frame
Definition resourceloader.h:121
uint mode
Definition resourceloader.h:130
bool reload
Definition resourceloader.h:120
bool immediate
Definition resourceloader.h:119
float lod
Definition resourceloader.h:122
_PendingResourceLoad()
Definition resourceloader.h:132
Util::StringAtom tag
Definition resourceloader.h:117
Mode
Definition resourceloader.h:125
@ Create
Definition resourceloader.h:127
@ None
Definition resourceloader.h:126
@ Update
Definition resourceloader.h:128
Definition resourceloader.h:146
Resources::ResourceId resourceId
Definition resourceloader.h:147
struct for pending stream
Definition resourceloader.h:137
_PendingStreamLod()
Definition resourceloader.h:142
bool immediate
Definition resourceloader.h:140
Resources::ResourceId id
Definition resourceloader.h:138
float lod
Definition resourceloader.h:139
Definition resourceloader.h:205
Resources::ResourceName placeholderName
Definition resourceloader.h:206
Resources::ResourceId placeholderId
Definition resourceloader.h:207
Definition resourceloader.h:222
void * data
Definition resourceloader.h:223
Ptr< IO::Stream > stream
Definition resourceloader.h:224
Definition resourceid.h:37
static const int InvalidIndex
Definition types.h:54
int SizeT
Definition types.h:49
unsigned int uint
Definition types.h:31
uint64_t uint64
Definition types.h:36
int IndexT
Definition types.h:48