IRuntimeAssetCacheBuilder Class Reference

#include <RuntimeAssetCachePluginInterface.h>

Inheritance diagram for IRuntimeAssetCacheBuilder:

Public Member Functions
virtual const TCHAR *	GetBucketConfigName () const =0
virtual const TCHAR *	GetBuilderName () const =0
virtual FString	GetAssetUniqueName () const =0
virtual FVoidPtrParam	Build ()=0
virtual void	SerializeData (FArchive &Ar, FVoidPtrParam InData)
virtual int32	GetAssetVersion ()=0
virtual bool	CachedAssetVersionIsUpToDate (int32 CachedAssetVersion)
virtual bool	ShouldBuildAsynchronously () const
virtual bool	IsBuildThreadSafe () const =0

Detailed Description

Interface for runtime asset cache cache builders. This API will be called concurrently.

Member Function Documentation

Build()

virtual FVoidPtrParam IRuntimeAssetCacheBuilder::Build ( )

pure virtual

Does the work of creating serialized cache entry.

Returns

Pointer to contiguous memory block with serialized cache entry on success, nullptr otherwise.

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

CachedAssetVersionIsUpToDate()

virtual bool IRuntimeAssetCacheBuilder::CachedAssetVersionIsUpToDate ( int32  CachedAssetVersion )

inlinevirtual

Check if the cached asset is up to date. If the current AssetVersion is greater than the cached AssetVersion, the cached asset will be re-built.

Returns

Whether the cached asset is good (return true) or needs to be rebuilt (return false).

GetAssetUniqueName()

virtual FString IRuntimeAssetCacheBuilder::GetAssetUniqueName ( ) const

pure virtual

Returns the name uniquely describing the asset.

Returns

Asset unique name.

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

GetAssetVersion()

virtual int32 IRuntimeAssetCacheBuilder::GetAssetVersion ( )

pure virtual

Gets asset version to rebuild cache if cached asset is too old.

Returns

Asset version.

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

GetBucketConfigName()

virtual const TCHAR * IRuntimeAssetCacheBuilder::GetBucketConfigName ( ) const

pure virtual

Get the builder type name. This is used to categorize cached data to buckets.

Returns

Type name of builder.

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

GetBuilderName()

virtual const TCHAR * IRuntimeAssetCacheBuilder::GetBuilderName ( ) const

pure virtual

Get the name of cache builder, this is used as part of the cache key.

Returns

Name of cache builder

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

IsBuildThreadSafe()

virtual bool IRuntimeAssetCacheBuilder::IsBuildThreadSafe ( ) const

pure virtual

Gets whether Build function is threadsafe

Returns

true if Build is threadsafe, false otherwise.

Implemented in URuntimeAssetCacheBuilder_ObjectBase.

SerializeData()

virtual void IRuntimeAssetCacheBuilder::SerializeData ( FArchive &  Ar, FVoidPtrParam  InData  )

inlinevirtual

Serializes data into archive

Parameters

Ar	Archive to serialize to.
InData	Data to serialize.

ShouldBuildAsynchronously()

virtual bool IRuntimeAssetCacheBuilder::ShouldBuildAsynchronously ( ) const

inlinevirtual

Gets whether Build function must be called asynchronously.

Returns

true if Build should be called asynchronously, false otherwise.

Reimplemented in URuntimeAssetCacheBuilder_ObjectBase.

---

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

• Engine/Source/Runtime/RuntimeAssetCache/Public/RuntimeAssetCachePluginInterface.h