plResourceLoaderFromFile Class Reference

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

#include <ResourceTypeLoader.h>

Inheritance diagram for plResourceLoaderFromFile:

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

Detailed Description

A default implementation of plResourceTypeLoader for standard file loading.

The loader will interpret the plResource '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

CloseDataStream()

void plResourceLoaderFromFile::CloseDataStream ( const plResource * pResource, const plResourceLoadData & loaderData )

overridevirtual

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.

Implements plResourceTypeLoader.

IsResourceOutdated()

bool plResourceLoaderFromFile::IsResourceOutdated ( const plResource * pResource ) const

overridevirtual

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

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

Reimplemented from plResourceTypeLoader.

Reimplemented in plRmlUiResourceLoader.

OpenDataStream()

plResourceLoadData plResourceLoaderFromFile::OpenDataStream ( const plResource * 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

plResourceLoadData

Implements plResourceTypeLoader.

---

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

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