plResource Class Reference

The base class for all resources. More...

#include <Resource.h>

Inheritance diagram for plResource:

Classes
struct	MemoryUsage

Public Member Functions
PL_ALWAYS_INLINE const plString &	GetResourceID () const
	Returns the unique ID that identifies this resource. On a file resource this might be a path. Can also be a GUID or any other scheme that uniquely identifies the resource.
PL_ALWAYS_INLINE plUInt64	GetResourceIDHash () const
	Returns the hash of the unique ID.
void	SetResourceDescription (plStringView sDescription)
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
const plString &	GetResourceDescription () const
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
const plString &	GetResourceIdOrDescription () const
	The returns the resource description, if available, otherwise the resource ID.
PL_ALWAYS_INLINE plResourceState	GetLoadingState () const
	Returns the current state in which this resource is in.
PL_ALWAYS_INLINE plUInt8	GetNumQualityLevelsDiscardable () const
	Returns the current maximum quality level that the resource could have.
PL_ALWAYS_INLINE plUInt8	GetNumQualityLevelsLoadable () const
	Returns how many quality levels the resource may additionally load.
float	GetLoadingPriority (plTime now) const
	Returns the priority that is used by the resource manager to determine which resource to load next.
plResourcePriority	GetPriority () const
	Returns the current resource priority.
void	SetPriority (plResourcePriority priority)
	Changes the current resource priority.
PL_ALWAYS_INLINE const plBitflags< plResourceFlags > &	GetBaseResourceFlags () const
	Returns the basic flags for the resource type. Mostly used the resource manager.
PL_ALWAYS_INLINE const MemoryUsage &	GetMemoryUsage () const
	Returns the information about the current memory usage of the resource.
PL_ALWAYS_INLINE plTime	GetLastAcquireTime () const
	Returns the time at which the resource was (tried to be) acquired last. If a resource is acquired using plResourceAcquireMode::PointerOnly, this does not update the last acquired time, since the resource is not acquired for full use.
PL_ALWAYS_INLINE plInt32	GetReferenceCount () const
	Returns the reference count of this resource.
PL_ALWAYS_INLINE const plTimestamp &	GetLoadedFileModificationTime () const
	Returns the modification date of the file from which this resource was loaded.
PL_ALWAYS_INLINE plUInt32	GetCurrentResourceChangeCounter () const
	Returns the current value of the resource change counter. Can be used to detect whether the resource has changed since using it last time.
PL_ALWAYS_INLINE void	IncResourceChangeCounter ()
	Allows to manually increase the resource change counter to signal that dependent code might need to update.
virtual void	ResetResource ()
	If the resource has modifications from the original state, it should reset itself to that state now (or force a reload on itself).
void	PrintHandleStackTraces ()
	Prints the stack-traces for all handles that currently reference this resource.
Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
PL_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Public Attributes
plEvent< const plResourceEvent &, plMutex >	m_ResourceEvents

Protected Types
enum class	DoUpdate { OnMainThread , OnAnyThread }
enum class	Unload { AllQualityLevels , OneQualityLevel }

Protected Member Functions
	plResource (DoUpdate ResourceUpdateThread, plUInt8 uiQualityLevelsLoadable)
	Default constructor.
virtual	~plResource ()
	virtual destructor.
MemoryUsage &	ModifyMemoryUsage ()
	Non-const version for resources that want to write this variable directly.
void	SetIsReloadable (bool bIsReloadable)
	Call this to specify whether a resource is reloadable.
void	SetHasLoadingFallback (bool bHasLoadingFallback)
	Used internally by the code injection macros.

Private Member Functions
virtual plResourceLoadDesc	UnloadData (Unload WhatToUnload)=0
	Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.
virtual plResourceLoadDesc	UpdateContent (plStreamReader *pStream)=0
	Called whenever more data for the resource is available. The resource must read the stream to update it's data.
virtual plResourceTypeLoader *	GetDefaultResourceTypeLoader () const
	Returns the resource type loader that should be used for this type of resource, unless it has been overridden on the plResourceManager.
virtual void	UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage)=0
	This function must be overridden by all resource types.

Friends
class	plResourceManager
class	plResourceManagerWorkerDataLoad
class	plResourceManagerWorkerUpdateContent
template<typename ResourceType >
class	plTypedResourceHandle
PL_CORE_DLL_FRIEND void	IncreaseResourceRefCount (plResource *pResource, const void *pOwner)
PL_CORE_DLL_FRIEND void	DecreaseResourceRefCount (plResource *pResource, const void *pOwner)

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Detailed Description

The base class for all resources.

Member Function Documentation

GetCurrentResourceChangeCounter()

PL_ALWAYS_INLINE plUInt32 plResource::GetCurrentResourceChangeCounter ( ) const

inline

Returns the current value of the resource change counter. Can be used to detect whether the resource has changed since using it last time.

The resource change counter is increased by calling IncResourceChangeCounter() or whenever the resource content is updated.

GetDefaultResourceTypeLoader()

plResourceTypeLoader * plResource::GetDefaultResourceTypeLoader ( ) const

privatevirtual

Returns the resource type loader that should be used for this type of resource, unless it has been overridden on the plResourceManager.

By default, this redirects to plResourceManager::GetDefaultResourceLoader. So there is one global default loader, that can be set on the resource manager. Overriding this function will then allow to use a different resource loader on a specific type. Additionally, one can override the resource loader from the outside, by setting it via plResourceManager::SetResourceTypeLoader. That last method always takes precedence and allows to modify the behavior without modifying the code for the resource. But in the default case, the resource defines which loader is used.

Reimplemented in plShaderPermutationResource.

GetLoadedFileModificationTime()

PL_ALWAYS_INLINE const plTimestamp & plResource::GetLoadedFileModificationTime ( ) const

inline

Returns the modification date of the file from which this resource was loaded.

The date may be invalid, if it cannot be retrieved or the resource was created and not loaded.

GetNumQualityLevelsDiscardable()

PL_ALWAYS_INLINE plUInt8 plResource::GetNumQualityLevelsDiscardable ( ) const

inline

Returns the current maximum quality level that the resource could have.

This is used to scale the amount data used. Once a resource is in the 'Loaded' state, it can still have different quality levels. E.g. a texture can be fully used with n mipmap levels, but there might be more that could be loaded. On the other hand a resource could have a higher 'loaded quality level' then the 'max quality level', if the user just changed settings and reduced the maximum quality level that should be used. In this case the resource manager will instruct the resource to unload some of its data soon.

The quality level is a purely logical concept that can be handled very different by different resource types. E.g. a texture resource could theoretically use one quality level per available mipmap level. However, since the resource should generally be able to load and unload each quality level separately, it might make more sense for a texture resource, to use one quality level for everything up to 64*64, and then one quality level for each mipmap above that, which would result in 5 quality levels for a 1024*1024 texture.

Most resource will have zero or one quality levels (which is the same) as they are either loaded or not.

GetResourceIdOrDescription()

const plString & plResource::GetResourceIdOrDescription ( ) const

inline

The returns the resource description, if available, otherwise the resource ID.

This is mainly for logging, where you want the more user friendly description, but the ID, if no description is available.

PrintHandleStackTraces()

void plResource::PrintHandleStackTraces

(

)

Prints the stack-traces for all handles that currently reference this resource.

Only implemented if PL_RESOURCEHANDLE_STACK_TRACES is PL_ON. Otherwise the function does nothing.

ResetResource()

virtual void plResource::ResetResource ( )

inlinevirtual

If the resource has modifications from the original state, it should reset itself to that state now (or force a reload on itself).

Reimplemented in plMaterialResource.

SetIsReloadable()

void plResource::SetIsReloadable ( bool bIsReloadable )

inlineprotected

Call this to specify whether a resource is reloadable.

By default all created resources are flagged as not reloadable. All resources loaded from file are automatically flagged as reloadable.

UnloadData()

virtual plResourceLoadDesc plResource::UnloadData ( Unload WhatToUnload )

privatepure virtual

Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.

Implemented in plAmplitudeAudioControlCollectionResource, plAnimationClipResource, plAnimGraphResource, plBlackboardTemplateResource, plCollectionResource, plColorGradientResource, plConfigFileResource, plCpuMeshResource, plCurve1DResource, plCustomDataResource< T >, plCustomDataResourceBase, plDecalAtlasResource, plDecalResource, plDynamicMeshBufferResource, plFmodSoundBankResource, plFmodSoundEventResource, plImageDataResource, plJoltMeshResource, plKrautGeneratorResource, plKrautTreeResource, plMaterialResource, plMeshBufferResource, plMeshResource, plParticleEffectResource, plPrefabResource, plProbeTreeSectorResource, plProcGenGraphResource, plPropertyAnimResource, plRecastNavMeshResource, plRenderPipelineResource, plRenderToTexture2DResource, plRmlUiResource, plScriptCompendiumResource, plShaderPermutationResource, plShaderResource, plSkeletonResource, plStateMachineResource, plSurfaceResource, plTexture2DResource, plTexture3DResource, plTextureCubeResource, plTypeScriptClassResource, and plVisualScriptClassResource.

UpdateContent()

virtual plResourceLoadDesc plResource::UpdateContent ( plStreamReader * pStream )

privatepure virtual

Called whenever more data for the resource is available. The resource must read the stream to update it's data.

pStream may be nullptr in case the resource data could not be found.

Implemented in plAmplitudeAudioControlCollectionResource, plAnimationClipResource, plAnimGraphResource, plBlackboardTemplateResource, plCollectionResource, plColorGradientResource, plConfigFileResource, plCpuMeshResource, plCurve1DResource, plCustomDataResource< T >, plDecalAtlasResource, plDecalResource, plDynamicMeshBufferResource, plFmodSoundBankResource, plFmodSoundEventResource, plImageDataResource, plJoltMeshResource, plKrautGeneratorResource, plKrautTreeResource, plMaterialResource, plMeshBufferResource, plMeshResource, plParticleEffectResource, plPrefabResource, plProbeTreeSectorResource, plProcGenGraphResource, plPropertyAnimResource, plRecastNavMeshResource, plRenderPipelineResource, plRenderToTexture2DResource, plRmlUiResource, plScriptCompendiumResource, plShaderPermutationResource, plShaderResource, plSkeletonResource, plStateMachineResource, plSurfaceResource, plTexture2DResource, plTexture3DResource, plTextureCubeResource, plTypeScriptClassResource, and plVisualScriptClassResource.

UpdateMemoryUsage()

virtual void plResource::UpdateMemoryUsage ( MemoryUsage & out_NewMemoryUsage )

privatepure virtual

This function must be overridden by all resource types.

It has to compute the memory used by this resource. It is called by the resource manager whenever the resource's data has been loaded or unloaded.

Implemented in plAmplitudeAudioControlCollectionResource, plAnimationClipResource, plAnimGraphResource, plBlackboardTemplateResource, plCollectionResource, plColorGradientResource, plConfigFileResource, plCpuMeshResource, plCurve1DResource, plCustomDataResource< T >, plDecalAtlasResource, plDecalResource, plDynamicMeshBufferResource, plFmodSoundBankResource, plFmodSoundEventResource, plImageDataResource, plJoltMeshResource, plKrautGeneratorResource, plKrautTreeResource, plMaterialResource, plMeshBufferResource, plMeshResource, plParticleEffectResource, plPrefabResource, plProbeTreeSectorResource, plProcGenGraphResource, plPropertyAnimResource, plRecastNavMeshResource, plRenderPipelineResource, plRenderToTexture2DResource, plRmlUiResource, plScriptCompendiumResource, plShaderPermutationResource, plShaderResource, plSkeletonResource, plStateMachineResource, plSurfaceResource, plTexture2DResource, plTexture3DResource, plTextureCubeResource, plTypeScriptClassResource, and plVisualScriptClassResource.

---

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

• Code/Engine/Core/ResourceManager/Resource.h
• Code/Engine/Core/ResourceManager/Implementation/Resource.cpp