Cogs.Core
Public Member Functions | List of all members
Cogs::Core::BufferManager Class Reference
Inheritance diagram for Cogs::Core::BufferManager:
Cogs::Core::ResourceManager< BufferResource, BufferLoadInfo > Cogs::Core::ResourceManagerBase Cogs::Core::IResourceManager

Public Member Functions

 BufferManager (Context *context)
 Constructs a MaterialManager in the given context.
 
ResourceBufferHandle loadBuffer (int size, const uint8_t *data, ResourceId id, ResourceLoadFlags flags)
 
void resourceChanged (ResourceBase *r) override
 
void resourceDeleted (ResourceBase *r) override
 
- Public Member Functions inherited from Cogs::Core::ResourceManager< BufferResource, BufferLoadInfo >
 ResourceManager (Context *context, Collections::ElementOffset capacity=1024)
 Constructs a resource manager with the given context.
 
 ~ResourceManager () override
 Destructs a resource manager, provided for destruction via base pointer.
 
void clear () override
 Clear the resource manager, cleaning up resources held by member handles.
 
void clearSwapping () override
 Clear the swap queue, ensuring indirect resource references are released.
 
ResourceHandle create ()
 Create a new resource.
 
ResourceHandle release (ResourceId resourceId)
 
ResourceHandle loadResource (BufferLoadInfo *loadInfo)
 
ResourceProxy createLocked ()
 Creates a new resource, but returns a ResourceProxy for thread safe editing instead of a handle to the actual resource.
 
ResourceProxy lock (const ResourceHandle &handle)
 Takes the handle given and returns a resource proxy to edit the contents of the held resource safely on other threads than the main thread.
 
void unlockProxy (const ResourceHandle &handle, const ResourceHandle &proxy)
 Unlock the given resource proxy.
 
ResourceHandle generateHandle (ResourceBase *resource)
 Generate a handle to the given resource.
 
virtual void handleLoad (BufferLoadInfo *)
 Handler for resource loading.
 
virtual void handleFailedLoad (const BufferLoadInfo *)
 Handler for failed resource loads using the given loadInfo.
 
virtual ActivationResult handleActivation (ResourceHandle, BufferResource *)
 Handler for activation of resources.
 
virtual void handleDeletion (BufferResource *)
 Handler for deletion of resources.
 
BufferResourceget (const ResourceHandleBase &handle)
 Resolve the given handle to a resource.
 
void processSwapping () override
 Process queued swap operations, exchanging resource contents of the destination resources by those indicated in the operation data.
 
ResourceHandle getHandle (const ResourceId id) const
 Get a resource handle to the resource with the given id.
 
void registerLoader (IResourceLoader< BufferResource, BufferLoadInfo > *loader)
 Register a resource loader capable of handling resources of the template type.
 
void destroyLoadInfoInternal (ResourceLoadInfoBase *loadInfo) override
 
BufferLoadInfocreateLoadInfo ()
 
- Public Member Functions inherited from Cogs::Core::ResourceManagerBase
 ResourceManagerBase (Context *context)
 
void initialize () override
 
void clear () override
 
void reportLeaks (std::string_view typeName)
 
std::string getReport ()
 Return a string with current resource usage.
 
bool checkPreloaded (ResourceLoadInfoBase *loadInfo)
 
ResourceHandleBase releaseInternal (ResourceId resourceId)
 Releases a resourceId -> ResourceHandle mapping.
 
ResourceHandleBase loadResourceInternal (ResourceLoadInfoBase *loadInfo)
 Load a resource using the given loadInfo.
 
void processLoading () final
 Process loading resources.
 
void setProcessed (ResourceLoadInfoBase *loadInfo, bool swapping=false)
 Signal the resource being loaded as done loading and ready for activation etc.
 
void activateResources () final
 
virtual void processDeletion () override
 Process resources pending deallocation.
 
void fillDeletionQueue (std::vector< ResourceBase * > &deletion)
 
void destroyLocked (ResourceBase *resource)
 
void safeDestroy (ResourceBase *resource)
 
ResourceId getNextResourceId () override
 Get the next unique resource id.
 
void resourceChanged (ResourceBase *resource) override
 
void resourceDeleted (ResourceBase *resource) override
 
void setResourceId (ResourceBase *resource, ResourceId id) override
 Assign the given id to a previously created resource.
 
void queueResource (ResourceLoadInfoBase *loadInfo)
 Re-queue the given loadInfo to defer loading to the next time the processLoading() phase is performed.
 
virtual void handleLoadInternal (ResourceLoadInfoBase *loadInfo)=0
 
virtual ActivationResult handleActivationInternal (ResourceHandleBase r, ResourceBase *resource)=0
 
virtual void handleDeletionInternal (ResourceBase *resource)=0
 
virtual void handleFailedLoadInternal (ResourceLoadInfoBase *loadInfo)=0
 
virtual void destroyLoadInfoInternal (ResourceLoadInfoBase *loadInfo)=0
 
virtual bool shouldAutoReload () const
 
virtual bool shouldMergeBySource () const
 
virtual void handleReload (ResourceHandleBase)
 
std::vector< ResourceBase * > getAllocatedResources () const
 
ResourceHandleBase getOrCreate (ResourceId id)
 
ResourceHandleBase getByName (std::string_view name) const
 
ResourceHandleBase getBySource (std::string_view source) const
 
ResourceHandleBase createResource ()
 
virtual ResourceBasecreateInternal ()=0
 
virtual void destroyInternal (ResourceBase *resource)=0
 
virtual void destroyInternalLocked (ResourceBase *resource)=0
 
ResourceHandleBase generateHandle (ResourceBase *resource)
 
void clearUpdated ()
 
virtual int getUpdateQuota () const
 
size_t updatedResourceCount ()
 
size_t orphanedResourceCount ()
 
size_t allocatedResourceCount ()
 
virtual void initialize ()=0
 
virtual void clear ()=0
 
virtual void clearSwapping ()=0
 
virtual void processLoading ()=0
 
virtual void processSwapping ()=0
 
virtual void activateResources ()=0
 
virtual void processDeletion ()=0
 
virtual void resourceChanged (ResourceBase *resource)=0
 
virtual void resourceDeleted (ResourceBase *resource)=0
 
virtual ResourceId getNextResourceId ()=0
 
virtual void setResourceId (ResourceBase *resource, ResourceId id)=0
 

Additional Inherited Members

- Public Types inherited from Cogs::Core::ResourceManager< BufferResource, BufferLoadInfo >
using ResourceHandle = ResourceHandle_t< BufferResource >
 Type of handle used to hold resources.
 
using ResourceProxy = ResourceProxy< BufferResource, ResourceManager >
 Type of resource proxy objects, specialized on the type of resource.
 
- Protected Member Functions inherited from Cogs::Core::ResourceManager< BufferResource, BufferLoadInfo >
BufferResourcecreateInternal () override
 
void destroyInternal (ResourceBase *resource) override
 
void handleLoadInternal (ResourceLoadInfoBase *loadInfo) override
 
ActivationResult handleActivationInternal (ResourceHandleBase r, ResourceBase *resource) override
 
void handleDeletionInternal (ResourceBase *resource) override
 
void handleFailedLoadInternal (ResourceLoadInfoBase *loadInfo) override
 
IResourceLoader< BufferResource, BufferLoadInfo > * findLoader (const BufferLoadInfo *loadInfo)
 Find a loader capable of loading the resource given by loadInfo.
 
- Protected Member Functions inherited from Cogs::Core::ResourceManagerBase
ResourceHandleBase getResourceHandle (ResourceId id) const
 Get existing resource handle.
 
bool isValidResource (ResourceId id) const
 Check if resource handle points to.
 
virtual void postProcessLoading ()
 Hook for resource managers to run code at the tail of processLoading.
 
- Protected Attributes inherited from Cogs::Core::ResourceManager< BufferResource, BufferLoadInfo >
Mutex swapMutex
 
Collections::Pool< BufferResourceresources
 
std::vector< IResourceLoader< BufferResource, BufferLoadInfo > * > loaders
 
std::deque< SwapOperation > swapQueue
 
ResourceHandle defaultResource
 
- Protected Attributes inherited from Cogs::Core::ResourceManagerBase
std::unique_ptr< ResourceManagerBaseStoragestorage
 
Contextcontext = nullptr
 
ResourceTypes resourceType = ResourceTypes::Unknown
 

Detailed Description

Definition at line 15 of file BufferManager.h.

Constructor & Destructor Documentation

◆ BufferManager()

Cogs::Core::BufferManager::BufferManager ( Context context)
inline

Constructs a MaterialManager in the given context.

Definition at line 19 of file BufferManager.h.

Member Function Documentation

◆ loadBuffer()

Cogs::Core::ResourceBufferHandle Cogs::Core::BufferManager::loadBuffer ( int  size,
const uint8_t *  data,
ResourceId  id,
ResourceLoadFlags  flags 
)

Definition at line 7 of file BufferManager.cpp.

◆ resourceChanged()

void Cogs::Core::BufferManager::resourceChanged ( ResourceBase r)
overridevirtual

Implements Cogs::Core::IResourceManager.

Definition at line 25 of file BufferManager.cpp.

◆ resourceDeleted()

void Cogs::Core::BufferManager::resourceDeleted ( ResourceBase r)
overridevirtual

Implements Cogs::Core::IResourceManager.

Definition at line 30 of file BufferManager.cpp.


The documentation for this class was generated from the following files: