ezResourceTypeLoader Class Reference

Base class for all resource loaders. More...

#include <ResourceTypeLoader.h>

Inheritance diagram for ezResourceTypeLoader:

Public Member Functions
virtual ezResourceLoadData	OpenDataStream (const ezResource *pResource)=0
	Override this function to implement the resource loading. More...
virtual void	CloseDataStream (const ezResource *pResource, const ezResourceLoadData &loaderData)=0
	This function is called when the resource has been updated with the data from the resource loader and the loader can deallocate any temporary memory.
virtual bool	IsResourceOutdated (const ezResource *pResource) const
	If this function returns true, a resource is unloaded and loaded again to update its content. More...

Detailed Description

Base class for all resource loaders.

A resource loader handles preparing the data before the resource is updated with the data. Resource loaders are always executed on a separate thread.

Member Function Documentation

IsResourceOutdated()

virtual bool ezResourceTypeLoader::IsResourceOutdated ( const ezResource *  pResource ) const

inlinevirtual

If this function returns true, a resource is unloaded and loaded again to update its content.

Call ezResource::GetLoadedFileModificationTime() to query the file modification time that was returned through ezResourceLoadData::m_LoadedFileModificationDate.

Reimplemented in ezConfigFileResourceLoader, ezResourceLoaderFromMemory, ezResourceLoaderFromFile, ezShaderPermutationResourceLoader, ezFmodSoundEventResourceLoader, ezRmlUiResourceLoader, ezFmodSoundBankResourceLoader, ezDecalResourceLoader, and ezTextureResourceLoader.

OpenDataStream()

virtual ezResourceLoadData ezResourceTypeLoader::OpenDataStream ( const ezResource *  pResource )

pure virtual

Override this function to implement the resource loading.

This function should take the information from pResource, e.g. which file to load, and do the loading work. It should allocate temporary storage for the loaded data and encode it in a memory stream, such that the resource can read all necessary information from the stream.

See also

ezResourceLoadData

Implemented in ezConfigFileResourceLoader, ezResourceLoaderFromMemory, ezResourceLoaderFromFile, ezShaderPermutationResourceLoader, ezFmodSoundEventResourceLoader, ezFmodSoundBankResourceLoader, ezDecalResourceLoader, and ezTextureResourceLoader.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/ResourceManager/ResourceTypeLoader.h