FDerivedDataCacheInterface

Interface for the derived data cache This API is fully threadsafe (with the possible exception of the system interface: NotfiyBootComplete, etc).

API > API/Developer > API/Developer/DerivedDataCache

Interface for the derived data cache This API is fully threadsafe (with the possible exception of the system interface: NotfiyBootComplete, etc).

   
Name FDerivedDataCacheInterface
Type class
Header File /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h
Include Path #include "DerivedDataCacheInterface.h"

Syntax

class FDerivedDataCacheInterface

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDerivedDataCacheInterface()

   DerivedDataCacheInterface.h  

Constants

Name Type Remarks Include Path
ValidCacheKeyChars FAsciiSet Low Level Static Helpers. DerivedDataCacheInterface.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PRAGMA_DISABLE_DEPRECATION_WARNINGS     DerivedDataCacheInterface.h  
PRAGMA_ENABLE_DEPRECATION_WARNINGS     DerivedDataCacheInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddToAsyncCompletionCounter ( int32 Addend
)

   DerivedDataCacheInterface.h  

bool AllCachedDataProbablyExists ( TConstArrayView< FString > CacheKeys
)

 Returns true if the data associated with each key is likely to exist in the cache. DerivedDataCacheInterface.h  

bool AnyAsyncRequestsRemaining()

 Are there any async DDC requests in progress? DerivedDataCacheInterface.h  

bool CachedDataProbablyExists ( const TCHAR* CacheKey
)

 Returns true if the data associated with the key is likely to exist in the cache. DerivedDataCacheInterface.h  

TBitArray CachedDataProbablyExistsBatch ( TConstArrayView< FString > CacheKeys
)

 Returns whether the data associated with each key is likely to exist in the cache. DerivedDataCacheInterface.h  

void GatherResourceStats ( TArray< FDerivedDataCacheResourceStat >& DDCResourceStats
) const

   DerivedDataCacheInterface.h  

void GatherSummaryStats ( FDerivedDataCacheSummaryStats& DDCSummaryStats
) const

   DerivedDataCacheInterface.h  

void GatherUsageStats ( TMap< FString, FDerivedDataCacheUsageStats >& UsageStats
)

 Retrieve usage stats by the DDC DerivedDataCacheInterface.h  
Retrieve usage stats by the DDC DerivedDataCacheInterface.h  

UE_INTERNAL void GatherVerificationStats ( FDerivedDataCacheVerificationStats& OutStats
) const

 Retrieve stats about the integrity of DDC data vs generated data DerivedDataCacheInterface.h  

uint32 GetAsynchronous ( const TCHAR* CacheKey,
FStringView DebugContext
)

 Starts the async process of checking the cache and if the item is present, retrieving the cached results. DerivedDataCacheInterface.h  
Starts the async process of checking the cache and if the item is present, retrieving the cached results, otherwise telling the deriver to build the data and then updating the cache If the plugin does not support threading, all of the above will be completed before the call returns. DerivedDataCacheInterface.h  

bool GetAsynchronousResults ( uint32 Handle,
TArray64< uint8 >& OutData,
bool* bDataWasBuilt
)

   DerivedDataCacheInterface.h  

bool GetAsynchronousResults ( uint32 Handle,
TArray< uint8 >& OutData,
bool* bDataWasBuilt
)

 Retrieves the results from an async lookup / build. DerivedDataCacheInterface.h  

FOnDDCNotification & GetDDCNotificationEvent()

   DerivedDataCacheInterface.h  

const TCHAR * GetDefaultGraphName()

 Retrieve the name of the 'default' graph, which may or may not be the active graph currently. DerivedDataCacheInterface.h  

void GetDirectories ( TArray< FString >& OutResults
)

   DerivedDataCacheInterface.h  

const TCHAR * GetGraphName()

 Retrieve the name of the graph used when configuring DDC DerivedDataCacheInterface.h  

bool GetSynchronous ( FDerivedDataPluginInterface* DataDeriver,
TArray< uint8 >& OutData,
bool* bDataWasBuilt
)

 Synchronously checks the cache and if the item is present, it returns the cached results, otherwise tells the deriver to build the data and then updates the cache DerivedDataCacheInterface.h  

bool GetSynchronous ( const TCHAR* CacheKey,
TArray64< uint8 >& OutData,
FStringView DebugContext
)

   DerivedDataCacheInterface.h  

bool GetSynchronous ( const TCHAR* CacheKey,
TArray< uint8 >& OutData,
FStringView DebugContext
)

 Synchronously checks the cache and if the item is present, it returns the cached results, otherwise it returns false. DerivedDataCacheInterface.h  

bool GetUsingSharedDDC()

   DerivedDataCacheInterface.h  

bool IsDefaultGraph()

 Are we currently using the default graph configuration? DerivedDataCacheInterface.h  

void MarkTransient ( const TCHAR* CacheKey
)

 Hint that the data associated with the key is transient and may be optionally purged from the cache. DerivedDataCacheInterface.h  

void NotifyBootComplete()

   DerivedDataCacheInterface.h  

bool PollAsynchronousCompletion ( uint32 Handle
)

 Polls a previous GetAsynchronous get for completion. DerivedDataCacheInterface.h  

void Put ( const TCHAR* CacheKey,
TArrayView64< const uint8 > Data,
FStringView DataContext,
bool bPutEvenIfExists
)

 Puts data into the cache. DerivedDataCacheInterface.h  

bool TryToPrefetch ( TConstArrayView< FString > CacheKeys,
FStringView DebugContext
)

 Synchronous attempt to make sure the cached data will be available as optimally as possible. DerivedDataCacheInterface.h  

void WaitAsynchronousCompletion ( uint32 Handle
)

 Blocks the current thread until an previous GetAsynchronous request is ready DerivedDataCacheInterface.h  

void WaitForQuiescence ( bool bShutdown
)

 Wait for all outstanding async DDC operations to complete. DerivedDataCacheInterface.h  

Public Virtual

Static

Name Remarks Include Path Unreal Specifiers

static void AppendSanitized ( FString& Out,
FStringView In
)

   DerivedDataCacheInterface.h  

static FString BuildCacheKey ( FStringView PluginName,
FStringView VersionString,
FStringView PluginSpecificCacheKeySuffix
)

   DerivedDataCacheInterface.h  

static FString BuildCacheKey ( const TCHAR* PluginName,
const TCHAR* VersionString,
const TCHAR* PluginSpecificCacheKeySuffix
)

 Static function to build a cache key out of the plugin name, versions and plugin specific info DerivedDataCacheInterface.h  

static bool IsValidCacheChar ( const TCHAR C
)

 Returns true if character is valid in a DDC cache key without escaping DerivedDataCacheInterface.h  

static FString SanitizeCacheKey ( const TCHAR* CacheKey
)

 Static function to make sure a cache key contains only legal characters by using an escape DerivedDataCacheInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page