Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > DerivedDataCache > FDerivedDataBackendInterface

Light Theme

Dark Theme

FDerivedDataBackendInterface

Interface for cache server backends.

Windows

MacOS

Linux

References

Module	DerivedDataCache
Header	/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBackendInterface.h
Include	#include "DerivedDataBackendInterface.h"

Syntax

class FDerivedDataBackendInterface

Remarks

Interface for cache server backends. The entire API should be callable from any thread (except the singleton can be assumed to be called at least once before concurrent access).

Destructors

	Name	Description
	~FDerivedDataBackendInterface()

Functions

	Name	Description
bool	ApplyDebugOptions ( FBackendDebugOptions& InOptions )	Ask a backend to apply debug behavior to simulate different conditions.
bool	BackfillLowerCacheLevels()	Return true if hits on this cache should propagate to lower cache level.
bool	CachedDataProbablyExists ( const TCHAR* CacheKey )	Synchronous test for the existence of a cache item
TSharedRef< ...	GatherUsageStats()	Retrieve usage stats for this backend.
bool	GetCachedData ( const TCHAR* CacheKey, TArray< uint8 >& OutData )	Synchronous retrieve of a cache item
FString	GetDisplayName()	Return a name for this interface
FString	GetName()	Return a name for this interface
ESpeedClass	GetSpeedClass()	Returns a class of speed for this interface
bool	IsWritable()	Return true if this cache is writable
void	PutCachedData ( const TCHAR* CacheKey, TArrayView< const uint8 > InData, bool bPutEvenIfExists )	Asynchronous, fire-and-forget placement of a cache item
void	RemoveCachedData ( const TCHAR* CacheKey, bool bTransient )	Remove data from cache (used in the event that corruption is detected at a higher level and possibly house keeping)
bool	TryToPrefetch ( const TCHAR* CacheKey )	Synchronous attempt to make sure the cached data will be available as optimally as possible.
bool	WouldCache ( const TCHAR* CacheKey, TArrayView< const uint8 > InData )	Allows the DDC backend to determine if it wants to cache the provided data.

Classes

	Name	Description
	FBackendDebugOptions	Debug options that can be applied to backends to simulate different behavior

Enums

	Name	Description
	ESpeedClass	Speed classes. Higher values are faster so > / < comparisons make sense.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss