ezResource Class Reference

The base class for all resources. More...

#include <Resource.h>

Inheritance diagram for ezResource:

Classes
struct	MemoryUsage

Public Types
enum	DoUpdate { OnMainThread, OnAnyThread, DoUpdate::OnGraphicsResourceThreads }

Public Member Functions
EZ_ALWAYS_INLINE ezStringView	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.
EZ_ALWAYS_INLINE ezUInt64	GetResourceIDHash () const
	Returns the hash of the unique ID.
void	SetResourceDescription (ezStringView sDescription)
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
const ezString &	GetResourceDescription () const
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
const ezString &	GetResourceIdOrDescription () const
	The returns the resource description, if available, otherwise the resource ID. More...
EZ_ALWAYS_INLINE ezResourceState	GetLoadingState () const
	Returns the current state in which this resource is in.
EZ_ALWAYS_INLINE ezUInt8	GetNumQualityLevelsDiscardable () const
	Returns the current maximum quality level that the resource could have. More...
EZ_ALWAYS_INLINE ezUInt8	GetNumQualityLevelsLoadable () const
	Returns how many quality levels the resource may additionally load.
float	GetLoadingPriority (ezTime now) const
	Returns the priority that is used by the resource manager to determine which resource to load next.
ezResourcePriority	GetPriority () const
	Returns the current resource priority.
void	SetPriority (ezResourcePriority priority)
	Changes the current resource priority.
const EZ_ALWAYS_INLINE ezBitflags< ezResourceFlags > &	GetBaseResourceFlags () const
	Returns the basic flags for the resource type. Mostly used the resource manager.
const EZ_ALWAYS_INLINE MemoryUsage &	GetMemoryUsage () const
	Returns the information about the current memory usage of the resource.
EZ_ALWAYS_INLINE ezTime	GetLastAcquireTime () const
	Returns the time at which the resource was (tried to be) acquired last. If a resource is acquired using ezResourceAcquireMode::PointerOnly, this does not update the last acquired time, since the resource is not acquired for full use.
EZ_ALWAYS_INLINE ezInt32	GetReferenceCount () const
	Returns the reference count of this resource.
const EZ_ALWAYS_INLINE ezTimestamp &	GetLoadedFileModificationTime () const
	Returns the modification date of the file from which this resource was loaded. More...
EZ_ALWAYS_INLINE ezUInt32	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. More...
EZ_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. More...
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Public Attributes
ezEvent< const ezResourceEvent &, ezMutex >	m_ResourceEvents

Static Public Attributes
static DoUpdate	UpdateGraphicsResource = ezResource::DoUpdate::OnAnyThread

Protected Types
enum	Unload { AllQualityLevels, OneQualityLevel }

Protected Member Functions
	ezResource (DoUpdate ResourceUpdateThread, ezUInt8 uiQualityLevelsLoadable)
	Default constructor.
virtual	~ezResource ()
	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. More...
void	SetHasLoadingFallback (bool bHasLoadingFallback)
	Used internally by the code injection macros.

Private Member Functions
virtual ezResourceLoadDesc	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 ezResourceLoadDesc	UpdateContent (ezStreamReader *pStream)=0
	Called whenever more data for the resource is available. The resource must read the stream to update it's data. More...
virtual ezResourceTypeLoader *	GetDefaultResourceTypeLoader () const
	Returns the resource type loader that should be used for this type of resource, unless it has been overridden on the ezResourceManager. More...
virtual void	UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage)=0
	This function must be overridden by all resource types. More...

Friends
class	ezResourceManager
class	ezResourceManagerWorkerDataLoad
class	ezResourceManagerWorkerUpdateContent
template<typename ResourceType >
class	ezTypedResourceHandle
EZ_CORE_DLL_FRIEND void	IncreaseResourceRefCount (ezResource *pResource, const void *pOwner)
EZ_CORE_DLL_FRIEND void	DecreaseResourceRefCount (ezResource *pResource, const void *pOwner)

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Detailed Description

The base class for all resources.

Member Enumeration Documentation

DoUpdate

enum ezResource::DoUpdate

strong

Enumerator
OnGraphicsResourceThreads	If set, the setting from UpdateGraphicsResource is used. This must be configured by the active renderer.

Member Function Documentation

GetCurrentResourceChangeCounter()

EZ_ALWAYS_INLINE ezUInt32 ezResource::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()

ezResourceTypeLoader * ezResource::GetDefaultResourceTypeLoader ( ) const

privatevirtual

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

By default, this redirects to ezResourceManager::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 ezResourceManager::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 ezShaderPermutationResource.

GetLoadedFileModificationTime()

const EZ_ALWAYS_INLINE ezTimestamp& ezResource::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()

EZ_ALWAYS_INLINE ezUInt8 ezResource::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 ezString& ezResource::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 ezResource::PrintHandleStackTraces

(

)

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

Only implemented if EZ_RESOURCEHANDLE_STACK_TRACES is EZ_ON. Otherwise the function does nothing.

SetIsReloadable()

void ezResource::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.

UpdateContent()

virtual ezResourceLoadDesc ezResource::UpdateContent ( ezStreamReader *  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 ezMeshBufferResource, ezDynamicMeshBufferResource, ezMaterialResource, ezAnimationClipResource, ezPropertyAnimResource, ezKrautTreeResource, ezRenderToTexture2DResource, ezCollectionResource, ezCustomDataResource< T >, ezConfigFileResource, ezJoltMeshResource, ezKrautGeneratorResource, ezTexture3DResource, ezSkeletonResource, ezTexture2DResource, ezTextureCubeResource, ezSurfaceResource, ezPrefabResource, ezPxMeshResource, ezRmlUiResource, ezProbeTreeSectorResource, ezRecastNavMeshResource, ezAnimGraphResource, ezDecalAtlasResource, ezRenderPipelineResource, ezShaderPermutationResource, ezColorGradientResource, ezFmodSoundEventResource, ezMeshResource, ezBlackboardTemplateResource, ezCurve1DResource, ezImageDataResource, ezParticleEffectResource, ezShaderResource, ezProcGenGraphResource, ezFmodSoundBankResource, ezDecalResource, ezStateMachineResource, ezCpuMeshResource, ezScriptCompendiumResource, ezTypeScriptClassResource, ezAngelScriptResource, and ezVisualScriptClassResource.

UpdateMemoryUsage()

virtual void ezResource::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 ezMeshBufferResource, ezDynamicMeshBufferResource, ezMaterialResource, ezAnimationClipResource, ezPropertyAnimResource, ezKrautTreeResource, ezRenderToTexture2DResource, ezCollectionResource, ezCustomDataResource< T >, ezConfigFileResource, ezJoltMeshResource, ezKrautGeneratorResource, ezTexture3DResource, ezSkeletonResource, ezTexture2DResource, ezTextureCubeResource, ezSurfaceResource, ezPrefabResource, ezPxMeshResource, ezRmlUiResource, ezProbeTreeSectorResource, ezRecastNavMeshResource, ezAnimGraphResource, ezDecalAtlasResource, ezScriptCompendiumResource, ezRenderPipelineResource, ezShaderPermutationResource, ezColorGradientResource, ezFmodSoundEventResource, ezTypeScriptClassResource, ezMeshResource, ezBlackboardTemplateResource, ezCurve1DResource, ezImageDataResource, ezParticleEffectResource, ezShaderResource, ezProcGenGraphResource, ezAngelScriptResource, ezFmodSoundBankResource, ezDecalResource, ezStateMachineResource, ezCpuMeshResource, and ezVisualScriptClassResource.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/ResourceManager/Resource.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/ResourceManager/Implementation/Resource.cpp