ezEngine  Release 25.03
ezResourceLoaderFromFile Class Reference

A default implementation of ezResourceTypeLoader for standard file loading. More...

#include <ResourceTypeLoader.h>

Inheritance diagram for ezResourceLoaderFromFile:

Public Member Functions

virtual ezResourceLoadData OpenDataStream (const ezResource *pResource) override
 Override this function to implement the resource loading. More...
 
virtual void CloseDataStream (const ezResource *pResource, const ezResourceLoadData &loaderData) override
 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 override
 If this function returns true, a resource is unloaded and loaded again to update its content. More...
 

Detailed Description

A default implementation of ezResourceTypeLoader for standard file loading.

The loader will interpret the ezResource 'resource ID' as a path, read that full file into a memory stream. The file modification data is stored as well. Resources that use this loader can update their data as if they were reading the file directly.

Member Function Documentation

◆ IsResourceOutdated()

bool ezResourceLoaderFromFile::IsResourceOutdated ( const ezResource pResource) const
overridevirtual

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 from ezResourceTypeLoader.

Reimplemented in ezRmlUiResourceLoader.

◆ OpenDataStream()

ezResourceLoadData ezResourceLoaderFromFile::OpenDataStream ( const ezResource pResource)
overridevirtual

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

Implements ezResourceTypeLoader.


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