castor::ResourceCacheT< Image, String, ImageCacheTraits > Class Reference

#include <ImageCache.hpp>

Inheritance diagram for castor::ResourceCacheT< Image, String, ImageCacheTraits >:

Collaboration diagram for castor::ResourceCacheT< Image, String, ImageCacheTraits >:

Public Types
using	ElementT = Image
using	ElementKeyT = String
using	ElementCacheTraitsT = ImageCacheTraits
using	ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
using	ElementPtrT = typename ElementCacheT::ElementPtrT
using	ElementObsT = typename ElementCacheT::ElementObsT
using	ElementContT = typename ElementCacheT::ElementContT
using	ElementInitialiserT = typename ElementCacheT::ElementInitialiserT
using	ElementCleanerT = typename ElementCacheT::ElementCleanerT
using	ElementMergerT = typename ElementCacheT::ElementMergerT
Public Types inherited from castor::ResourceCacheBaseT< Image, String, ImageCacheTraits >
using	ElementT
using	ElementKeyT
using	ElementCacheTraitsT
using	ElementCacheBaseT
using	ElementCacheT
using	ElementPtrT
using	ElementObsT
using	ElementContT
using	ElementInitialiserT
using	ElementCleanerT
using	ElementMergerT

Public Member Functions
CU_API	ResourceCacheT (LoggerInstance &logger, ImageLoader const &loader)
CU_API	~ResourceCacheT () noexcept override=default
ImageLoader const &	getLoader () const noexcept
CU_API PixelFormat	getImageFormat (String const &name) const
Public Member Functions inherited from castor::ResourceCacheBaseT< Image, String, ImageCacheTraits >
	ResourceCacheBaseT (ResourceCacheBaseT const &)=delete
	ResourceCacheBaseT (ResourceCacheBaseT &&) noexcept=delete
ResourceCacheBaseT &	operator= (ResourceCacheBaseT const &)=delete
ResourceCacheBaseT &	operator= (ResourceCacheBaseT &&) noexcept=delete
void	cleanup () noexcept
	Sets all the elements to be cleaned up.
void	clear () noexcept
	Flushes the collection.
ElementPtrT	create (ElementKeyT const &name, ParametersT &&... parameters) const
	Creates an element.
ElementObsT	tryAdd (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.
ElementObsT	tryAdd (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.
ElementObsT	tryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.
ElementObsT	tryAddNoLock (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.
ElementObsT	add (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.
ElementObsT	add (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.
ElementObsT	addNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.
ElementObsT	addNoLock (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.
ElementPtrT	tryRemove (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.
ElementPtrT	tryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.
ElementPtrT	remove (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.
ElementPtrT	removeNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.
void	rename (ElementKeyT const &oldName, ElementKeyT const &newName)
	Renames a resource.
ElementObsT	tryFind (ElementKeyT const &name) const noexcept
	Looks for an element with given name.
ElementObsT	tryFindNoLock (ElementKeyT const &name) const noexcept
	Looks for an element with given name.
ElementObsT	find (ElementKeyT const &name) const
	Logging version of tryRemove.
ElementObsT	findNoLock (ElementKeyT const &name) const
	Logging version of tryRemove.
void	mergeInto (ElementCacheBaseT &destination)
	Merges this cache's elements to the one given.
void	forEach (FuncType func) const
void	forEach (FuncType func)
uint32_t	getObjectCount () const noexcept
uint32_t	getObjectCountNoLock () const noexcept
String const &	getObjectTypeName () const noexcept
bool	has (ElementKeyT const &name) const noexcept
bool	hasNoLock (ElementKeyT const &name) const noexcept
bool	isEmpty () const noexcept
bool	isEmptyNoLock () const noexcept
void	lock () const
void	unlock () const noexcept
auto	begin () noexcept
auto	begin () const noexcept
auto	end () noexcept
auto	end () const noexcept
void	reportCreation (String const &name) const
void	reportAdded (String const &name) const
void	reportDuplicate (String const &name) const
void	reportNull () const
void	reportUnknown (String const &name) const

Additional Inherited Members
Protected Types inherited from castor::ResourceCacheBaseT< Image, String, ImageCacheTraits >
using	MutexT
Protected Member Functions inherited from castor::ResourceCacheBaseT< Image, String, ImageCacheTraits >
void	doCleanupNoLock () const noexcept
void	doClearNoLock () noexcept
ElementPtrT	doCreateT (ElementKeyT const &name, ParametersT &&... parameters) const
ElementObsT	doTryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
ElementObsT	doAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
ElementObsT	doTryAddNoLockT (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
ElementObsT	doAddNoLockT (ElementKeyT const &name, ParametersT &&... parameters)
ElementPtrT	doTryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
ElementObsT	doTryFindNoLock (ElementKeyT const &name) const noexcept
	ResourceCacheBaseT (LoggerInstance &logger, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{})
virtual	~ResourceCacheBaseT () noexcept=default
Protected Attributes inherited from castor::ResourceCacheBaseT< Image, String, ImageCacheTraits >
LoggerInstance &	m_logger
CheckedMutexT< MutexT >	m_mutex
ElementContT	m_resources
ElementInitialiserT	m_initialise
ElementCleanerT	m_clean
ElementMergerT	m_merge

Detailed Description

Base class for an element cache.

Remarks

Specialisation for castor::Image.

Member Typedef Documentation

ElementCacheT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

ElementCacheTraitsT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementCacheTraitsT = ImageCacheTraits

ElementCleanerT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

ElementContT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementContT = typename ElementCacheT::ElementContT

ElementInitialiserT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

ElementKeyT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementKeyT = String

ElementMergerT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementMergerT = typename ElementCacheT::ElementMergerT

ElementObsT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementObsT = typename ElementCacheT::ElementObsT

ElementPtrT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementPtrT = typename ElementCacheT::ElementPtrT

ElementT

using castor::ResourceCacheT< Image, String, ImageCacheTraits >::ElementT = Image

Constructor & Destructor Documentation

ResourceCacheT()

CU_API castor::ResourceCacheT< Image, String, ImageCacheTraits >::ResourceCacheT ( LoggerInstance & logger, ImageLoader const & loader )

explicit

~ResourceCacheT()

CU_API castor::ResourceCacheT< Image, String, ImageCacheTraits >::~ResourceCacheT ( )

overridedefaultnoexcept

Member Function Documentation

getImageFormat()

CU_API PixelFormat castor::ResourceCacheT< Image, String, ImageCacheTraits >::getImageFormat

(

String const &

name

)

const

getLoader()

ImageLoader const & castor::ResourceCacheT< Image, String, ImageCacheTraits >::getLoader ( ) const

inlinenoexcept

---

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

• CastorUtils/Graphics/ImageCache.hpp