className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
KeyInitType | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | typedef const [FCacheKey](API\Developer\DerivedDataCache\FCacheKey) & KeyInitType | [] |
|
KeyType | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | typedef [FCacheKey](API\Developer\DerivedDataCache\FCacheKey) KeyType | [] |
|
FCacheRecordKeyFuncs::Matches | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | static bool Matches ( [KeyInitType](API\Developer\DerivedDataCache\FCacheRecordKeyFuncs\KeyInitType) A, [KeyInitType](API\Developer\DerivedDataCache\FCacheRecordKeyFuncs\KeyInitType) B ) | [] |
|
FCacheRecordKeyFuncs | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | An implementation of KeyFuncs to compareFCacheRecordby itsFCacheKey. | DerivedDataCache | struct FCacheRecordKeyFuncs | [] |
FCacheRecordPolicy::GetBasePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns the base cache policy that this was constructed from. | DerivedDataCache | [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) GetBasePolicy() const | [] |
FCacheRecordPolicy::GetRecordPolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns the cache policy to use for the record. | DerivedDataCache | [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) GetRecordPolicy() const | [] |
FCacheRecordPolicy::GetValuePolicies | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns the array of cache policy overrides for values, sorted by ID. | DerivedDataCache | TConstArrayView< [FCacheValuePolicy](API\Developer\DerivedDataCache\FCacheValuePolicy) > GetValuePolicies() const | [] |
FCacheRecordPolicy::GetValuePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns the cache policy to use for the value. | DerivedDataCache | [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) GetValuePolicy ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id ) const | [] |
FCacheRecordPolicy::IsDefault | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns true if this is the default cache policy with no overrides for values. | DerivedDataCache | bool IsDefault() const | [] |
FCacheRecordPolicy::IsUniform | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns true if the record and every value use the same cache policy. | DerivedDataCache | bool IsUniform() const | [] |
FCacheRecordPolicy::Transform | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Returns a copy of this policy transformed by an operation. | DerivedDataCache | [FCacheRecordPolicy](API\Developer\DerivedDataCache\FCacheRecordPolicy) Transform ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy)([ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy))> Op ) const | [] |
FCacheRecordPolicy::FCacheRecordPolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Construct a cache record policy that uses the default policy. | DerivedDataCache | FCacheRecordPolicy() | [] |
FCacheRecordPolicy::FCacheRecordPolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Construct a cache record policy with a uniform policy for the record and every value. | DerivedDataCache | FCacheRecordPolicy ( [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) BasePolicy ) | [] |
FCacheRecordPolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Examples: | DerivedDataCache | class FCacheRecordPolicy | [] |
FCacheRecordPolicyBuilder::AddValuePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Adds a cache policy override for a value. Must contain only flags in FCacheRecordValue::PolicyMask. | DerivedDataCache | void AddValuePolicy ( const [FCacheValuePolicy](API\Developer\DerivedDataCache\FCacheValuePolicy) & Value ) | [] |
FCacheRecordPolicyBuilder::AddValuePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | DerivedDataCache | void AddValuePolicy ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) Policy ) | [] |
|
FCacheRecordPolicyBuilder::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Build a cache record policy, which makes this builder subsequently unusable. | DerivedDataCache | [FCacheRecordPolicy](API\Developer\DerivedDataCache\FCacheRecordPolicy) Build() | [] |
FCacheRecordPolicyBuilder::FCacheRecordPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Construct a policy builder that uses the default policy as its base policy. | DerivedDataCache | FCacheRecordPolicyBuilder() | [] |
FCacheRecordPolicyBuilder::FCacheRecordPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Construct a policy builder that uses the provided policy for the record and values with no override. | DerivedDataCache | FCacheRecordPolicyBuilder ( [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) Policy ) | [] |
FCacheRecordPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | A cache record policy builder is used to construct a cache record policy. | DerivedDataCache | class FCacheRecordPolicyBuilder | [] |
PolicyMask | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | Flags that are valid on a value policy. | DerivedDataCache | static constexpr [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) PolicyMask = ECachePolicy::Default | ECachePolicy::SkipData; | [] |
FCacheValuePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCachePolicy.h | A value ID and the cache policy to use for that value. | DerivedDataCache | struct FCacheValuePolicy | [
{
"type": "FValueId",
"name": "Id",
"description": ""
},
{
"type": "ECachePolicy",
"name": "Policy",
"description": ""
}
] |
FDerivedDataCacheInterface::AddToAsyncCompletionCounter | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Adds or subtracts a number from the thread safe counter which tracks outstanding async requests. This is used to ensure everything is complete prior to shutdown. | DerivedDataCache | void AddToAsyncCompletionCounter ( int32 Addend ) | [] |
FDerivedDataCacheInterface::AllCachedDataProbablyExists | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Returns true if the data associated with each key is likely to exist in the cache. Even if this function returns true, a get for one of the keys may still fail! | DerivedDataCache | bool AllCachedDataProbablyExists ( TConstArrayView< [FString](API\Runtime\Core\Containers\FString) > CacheKeys ) | [] |
FDerivedDataCacheInterface::AnyAsyncRequestsRemaining | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Are there any async DDC requests in progress? | DerivedDataCache | bool AnyAsyncRequestsRemaining() const | [] |
FDerivedDataCacheInterface::BuildCacheKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Static function to build a cache key out of the plugin name, versions and plugin specific info
Assembled cache key | DerivedDataCache | static [FString](API\Runtime\Core\Containers\FString) BuildCacheKey ( const TCHAR * PluginName, const TCHAR * VersionString, const TCHAR * PluginSpecificCacheKeySuffix ) | [] |
FDerivedDataCacheInterface::BuildCacheKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | static [FString](API\Runtime\Core\Containers\FString) BuildCacheKey ( FStringView PluginName, FStringView VersionString, FStringView PluginSpecificCacheKeySuffix ) | [] |
|
FDerivedDataCacheInterface::CachedDataProbablyExists | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Returns true if the data associated with the key is likely to exist in the cache. Even if this function returns true, a get for this key may still fail! | DerivedDataCache | bool CachedDataProbablyExists ( const TCHAR * CacheKey ) | [] |
FDerivedDataCacheInterface::CachedDataProbablyExistsBatch | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Returns whether the data associated with each key is likely to exist in the cache. Even if this function returns true, a get for one of the keys may still fail!
A bit array with bits indicating whether the data for the corresponding key will probably be found | DerivedDataCache | [TBitArray](API\Runtime\Core\Containers\TBitArray) CachedDataProbablyExistsBatch ( TConstArrayView< [FString](API\Runtime\Core\Containers\FString) > CacheKeys ) | [] |
EDDCNotification | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | enum EDDCNotification { SharedDDCPerformanceNotification, } | [] |
|
FOnDDCNotification | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | typedef TMulticastDelegate_OneParam< void, [EDDCNotification](API\Developer\DerivedDataCache\FDerivedDataCacheInterface\EDDCNotification) > FOnDDCNotification | [] |
|
FDerivedDataCacheInterface::GatherAnalytics | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | void GatherAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & Attributes ) const | [] |
|
FDerivedDataCacheInterface::GatherResourceStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | void GatherResourceStats ( [TArray](API\Runtime\Core\Containers\TArray)< [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) > & DDCResourceStats ) const | [] |
|
FDerivedDataCacheInterface::GatherSummaryStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | void GatherSummaryStats ( [FDerivedDataCacheSummaryStats](API\Developer\DerivedDataCache\FDerivedDataCacheSummaryStats) & DDCSummaryStats ) const | [] |
|
FDerivedDataCacheInterface::GatherUsageStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve usage stats by the DDC | DerivedDataCache | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDerivedDataCacheStatsNode](API\Developer\DerivedDataCache\FDerivedDataCacheStatsNode) > GatherUsageStats() const | [] |
FDerivedDataCacheInterface::GatherUsageStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve usage stats by the DDC | DerivedDataCache | void GatherUsageStats ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FDerivedDataCacheUsageStats](API\Developer\DerivedDataCache\FDerivedDataCacheUsageStats) > & UsageStats ) | [] |
FDerivedDataCacheInterface::GetAsynchronous | /Engine/Source/Developer/DerivedDataCache/Public/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.
a handle that can be used for PollAsynchronousCompletion, WaitAsynchronousCompletion and GetAsynchronousResults | DerivedDataCache | uint32 GetAsynchronous ( class [FDerivedDataPluginInterface](API\Developer\DerivedDataCache\FDerivedDataPluginInterface) * DataDeriver ) | [] |
FDerivedDataCacheInterface::GetAsynchronous | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Prefer to use aFDerivedDataPluginInterfaceinstead of generating the key directly.
A handle that can be used for PollAsynchronousCompletion, WaitAsynchronousCompletion, and GetAsynchronousResults. | DerivedDataCache | uint32 GetAsynchronous ( const TCHAR * CacheKey, FStringView DebugContext ) | [] |
FDerivedDataCacheInterface::GetAsynchronousResults | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieves the results from an async lookup / build. MUST only be called after the results are known to be ready by one of the aforementioned calls.
true if the data was retrieved from the cache or the deriver built the data successfully. false can only occur if the plugin returns false. | DerivedDataCache | bool GetAsynchronousResults ( uint32 Handle, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutData, bool * bDataWasBuilt ) | [] |
FDerivedDataCacheInterface::GetAsynchronousResults | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | bool GetAsynchronousResults ( uint32 Handle, TArray64< uint8 > & OutData, bool * bDataWasBuilt ) | [] |
|
FDerivedDataCacheInterface::GetDDCNotificationEvent | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve the event delegate for cache put notifications | DerivedDataCache | [FOnDDCNotification](API\Developer\DerivedDataCache\FDerivedDataCacheInterface\FOnDDCNotification) & GetDDCNotificationEvent() | [] |
FDerivedDataCacheInterface::GetDefaultGraphName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve the name of the 'default' graph, which may or may not be the active graph currently. | DerivedDataCache | const TCHAR * GetDefaultGraphName() const | [] |
FDerivedDataCacheInterface::GetDirectories | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve the directories used by the DDC | DerivedDataCache | void GetDirectories ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutResults ) | [] |
FDerivedDataCacheInterface::GetGraphName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve the name of the graph used when configuring DDC | DerivedDataCache | const TCHAR * GetGraphName() const | [] |
FDerivedDataCacheInterface::GetSynchronous | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | 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
true if the data was retrieved from the cache or the deriver built the data sucessfully. false can only occur if the plugin returns false. | DerivedDataCache | bool GetSynchronous ( class [FDerivedDataPluginInterface](API\Developer\DerivedDataCache\FDerivedDataPluginInterface) * DataDeriver, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutData, bool * bDataWasBuilt ) | [] |
FDerivedDataCacheInterface::GetSynchronous | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Prefer to use aFDerivedDataPluginInterfaceinstead of generating the key directly.
true if the data was retrieved from the cache. | DerivedDataCache | bool GetSynchronous ( const TCHAR * CacheKey, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutData, FStringView DebugContext ) | [] |
FDerivedDataCacheInterface::GetSynchronous | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | bool GetSynchronous ( const TCHAR * CacheKey, TArray64< uint8 > & OutData, FStringView DebugContext ) | [] |
|
FDerivedDataCacheInterface::GetUsingSharedDDC | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Retrieve whether a Shared DDC is being used | DerivedDataCache | bool GetUsingSharedDDC() const | [] |
FDerivedDataCacheInterface::IsDefaultGraph | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Are we currently using the default graph configuration? | DerivedDataCache | bool IsDefaultGraph() const | [] |
FDerivedDataCacheInterface::IsValidCacheChar | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Returns true if character is valid in a DDC cache key without escaping | DerivedDataCache | static bool IsValidCacheChar ( const TCHAR C ) | [] |
FDerivedDataCacheInterface::MarkTransient | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Hint that the data associated with the key is transient and may be optionally purged from the cache. | DerivedDataCache | void MarkTransient ( const TCHAR * CacheKey ) | [] |
FDerivedDataCacheInterface::NotifyBootComplete | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Notify the system that the boot process is complete and so we can write the boot cache and get rid of it | DerivedDataCache | void NotifyBootComplete() | [] |
FDerivedDataCacheInterface::SanitizeCacheKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Static function to make sure a cache key contains only legal characters by using an escape
Sanitized cache key | DerivedDataCache | static [FString](API\Runtime\Core\Containers\FString) SanitizeCacheKey ( const TCHAR * CacheKey ) | [] |
FDerivedDataCacheInterface::Put | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Prefer to use aFDerivedDataPluginInterfaceinstead of generating the key directly. | DerivedDataCache | void Put ( const TCHAR * CacheKey, TArrayView64< const uint8 > Data, FStringView DataContext, bool bPutEvenIfExists ) | [] |
FDerivedDataCacheInterface::PollAsynchronousCompletion | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Polls a previous GetAsynchronous get for completion.
true if the build / retrieve is complete and the results can be obtained. | DerivedDataCache | bool PollAsynchronousCompletion ( uint32 Handle ) | [] |
FDerivedDataCacheInterface::TryToPrefetch | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Synchronous attempt to make sure the cached data will be available as optimally as possible.
true if the data will probably be found in a fast backend on a future request. | DerivedDataCache | bool TryToPrefetch ( TConstArrayView< [FString](API\Runtime\Core\Containers\FString) > CacheKeys, FStringView DebugContext ) | [] |
ValidCacheKeyChars | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Low Level Static Helpers. | DerivedDataCache | static constexpr [FAsciiSet](API\Runtime\Core\Misc\FAsciiSet) ValidCacheKeyChars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_$"; | [] |
FDerivedDataCacheInterface::WaitAsynchronousCompletion | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Blocks the current thread until an previous GetAsynchronous request is ready | DerivedDataCache | void WaitAsynchronousCompletion ( uint32 Handle ) | [] |
FDerivedDataCacheInterface::WaitForQuiescence | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Wait for all outstanding async DDC operations to complete. | DerivedDataCache | void WaitForQuiescence ( bool bShutdown ) | [] |
FDerivedDataCacheInterface::~FDerivedDataCacheInterface | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | DerivedDataCache | virtual ~FDerivedDataCacheInterface() | [] |
|
FDerivedDataCacheInterface | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h | Interface for the derived data cache This API is fully threadsafe (with the possible exception of the system interface: NotfiyBootComplete, etc). | DerivedDataCache | class FDerivedDataCacheInterface | [] |
FDerivedDataCacheResourceStat::operator+ | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & operator+ ( const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & OtherStat ) | [] |
|
FDerivedDataCacheResourceStat::operator+= | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & operator+= ( const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & OtherStat ) | [] |
|
FDerivedDataCacheResourceStat::operator- | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & operator- ( const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & OtherStat ) | [] |
|
FDerivedDataCacheResourceStat::operator-= | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & operator-= ( const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & OtherStat ) | [] |
|
FDerivedDataCacheResourceStat::FDerivedDataCacheResourceStat | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | FDerivedDataCacheResourceStat ( [FString](API\Runtime\Core\Containers\FString) InAssetType, bool bIsGameThreadTime, double InLoadTimeSec, double InLoadSizeMB, int64 InAssetsLoaded, double InBuildTimeSec, double InBuildSizeMB, int64 InAssetsBuilt ) | [] |
|
FDerivedDataCacheResourceStat | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | struct FDerivedDataCacheResourceStat | [
{
"type": "FString",
"name": "AssetType",
"description": ""
},
{
"type": "int64",
"name": "BuildCount",
"description": ""
},
{
"type": "double",
"name": "BuildSizeMB",
"description": ""
},
{
"type": "double",
"name": "BuildTimeSec",
"description": ""
},
{
"type": "double",
"name": "GameThreadTimeSec",
"description": ""
},
{
"type": "int64",
"name": "LoadCount",
"description": ""
},
{
"type": "double",
"name": "LoadSizeMB",
"description": ""
},
{
"type": "double",
"name": "LoadTimeSec",
"description": ""
}
] |
|
FDerivedDataCacheResourceStatKeyFuncs::GetKeyHash | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | static uint32 GetKeyHash ( const [FString](API\Runtime\Core\Containers\FString) & Key ) | [] |
|
FDerivedDataCacheResourceStatKeyFuncs::GetSetKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | static const [FString](API\Runtime\Core\Containers\FString) & GetSetKey ( const [FDerivedDataCacheResourceStat](API\Developer\DerivedDataCache\FDerivedDataCacheResourceStat) & Element ) | [] |
|
FDerivedDataCacheResourceStatKeyFuncs::Matches | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | static bool Matches ( const [FString](API\Runtime\Core\Containers\FString) & A, const [FString](API\Runtime\Core\Containers\FString) & B ) | [] |
|
FDerivedDataCacheResourceStatKeyFuncs | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | struct FDerivedDataCacheResourceStatKeyFuncs : public [BaseKeyFuncs< FDerivedDataCacheResourceStat, FString, false >](API\Runtime\Core\Containers\BaseKeyFuncs) | [] |
|
FDerivedDataCacheSpeedStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Performance stats for this backend | DerivedDataCache | struct FDerivedDataCacheSpeedStats | [
{
"type": "double",
"name": "LatencyMS",
"description": ""
},
{
"type": "double",
"name": "ReadSpeedMBs",
"description": ""
},
{
"type": "double",
"name": "WriteSpeedMBs",
"description": ""
}
] |
FDerivedDataCacheStatsNode::ForEachDescendant | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | void ForEachDescendant ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FDerivedDataCacheStatsNode](API\Developer\DerivedDataCache\FDerivedDataCacheStatsNode) >)> Predicate ) const | [] |
|
FDerivedDataCacheStatsNode::GatherLegacyUsageStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | void GatherLegacyUsageStats ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FDerivedDataCacheUsageStats](API\Developer\DerivedDataCache\FDerivedDataCacheUsageStats) > & UsageStatsMap, [FString](API\Runtime\Core\Containers\FString) && GraphPath ) const | [] |
|
FDerivedDataCacheStatsNode::GetCacheName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FString](API\Runtime\Core\Containers\FString) & GetCacheName() const | [] |
|
FDerivedDataCacheStatsNode::GetCacheStatus | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [EDerivedDataCacheStatus](API\Developer\DerivedDataCache\EDerivedDataCacheStatus) GetCacheStatus() const | [] |
|
FDerivedDataCacheStatsNode::GetCacheStatusText | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FString](API\Runtime\Core\Containers\FString) & GetCacheStatusText() const | [] |
|
FDerivedDataCacheStatsNode::GetCacheType | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | const [FString](API\Runtime\Core\Containers\FString) & GetCacheType() const | [] |
|
FDerivedDataCacheStatsNode::IsLocal | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | bool IsLocal() const | [] |
|
FDerivedDataCacheStatsNode::ToLegacyUsageMap | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FDerivedDataCacheUsageStats](API\Developer\DerivedDataCache\FDerivedDataCacheUsageStats) > ToLegacyUsageMap() const | [] |
|
FDerivedDataCacheStatsNode::FDerivedDataCacheStatsNode | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | FDerivedDataCacheStatsNode() | [] |
|
FDerivedDataCacheStatsNode::FDerivedDataCacheStatsNode | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | FDerivedDataCacheStatsNode ( const [FString](API\Runtime\Core\Containers\FString) & InCacheType, const [FString](API\Runtime\Core\Containers\FString) & InCacheName, bool bInIsLocal, [EDerivedDataCacheStatus](API\Developer\DerivedDataCache\EDerivedDataCacheStatus) InCacheStatus, const TCHAR * InCacheStatusText ) | [] |
|
FDerivedDataCacheStatsNode | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Hierarchical usage stats for the DDC nodes. | DerivedDataCache | class FDerivedDataCacheStatsNode : public [TSharedFromThis< FDerivedDataCacheStatsNode >](API\Runtime\Core\Templates\TSharedFromThis) | [
{
"type": "bool",
"name": "bIsLocal",
"description": ""
},
{
"type": "FString",
"name": "CacheName",
"description": ""
},
{
"type": "EDerivedDataCac...",
"name": "CacheStatus",
"description": ""
},
{
"type": "FString",
"name": "CacheStatusText",
"description": ""
},
{
"type": "FString",
"name": "CacheType",
"description": ""
},
{
"type": "TArray<TShared...",
"name": "Children",
"description": ""
},
{
"type": "TArray<FCookSt...",
"name": "CustomStats",
"description": ""
},
{
"type": "FDerivedDataCac...",
"name": "SpeedStats",
"description": ""
},
{
"type": "TMap<FString, ...",
"name": "UsageStats",
"description": ""
}
] |
FDerivedDataCacheSummaryStat | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | typedef [FCookStatsManager::StringKeyValue](API\Runtime\Core\ProfilingDebugging\FCookStatsManager\StringKeyValue) FDerivedDataCacheSummaryStat | [] |
|
FDerivedDataCacheSummaryStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | struct FDerivedDataCacheSummaryStats | [
{
"type": "TArray<FDerive...",
"name": "Stats",
"description": ""
}
] |
|
FDerivedDataCacheUsageStats::Combine | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | void Combine ( const [FDerivedDataCacheUsageStats](API\Developer\DerivedDataCache\FDerivedDataCacheUsageStats) & Other ) | [] |
|
FDerivedDataCacheUsageStats::LogStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | DerivedDataCache | void LogStats ( [FCookStatsManager::AddStatFuncRef](API\Runtime\Core\ProfilingDebugging\FCookStatsManager\AddStatFuncRef) AddStat, const [FString](API\Runtime\Core\Containers\FString) & StatName, const [FString](API\Runtime\Core\Containers\FString) & NodeName ) const | [] |
|
FDerivedDataCacheUsageStats::TimeGet | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Call this at the top of the GetCachedData override. auto Timer =TimeGet(); Use AddHit on the returned type to track a cache hit. | DerivedDataCache | [FCookStats::FScopedStatsCounter](API\Runtime\Core\ProfilingDebugging\FCookStats\FScopedStatsCounter) TimeGet() | [] |
FDerivedDataCacheUsageStats::TimeProbablyExists | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Call this at the top of the CachedDataProbablyExists override. auto Timer =TimeProbablyExists(); | DerivedDataCache | [FCookStats::FScopedStatsCounter](API\Runtime\Core\ProfilingDebugging\FCookStats\FScopedStatsCounter) TimeProbablyExists() | [] |
FDerivedDataCacheUsageStats::TimePrefetch | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Call this at the top of the PutCachedData override. auto Timer =TimePut(); Use AddHit on the returned type to track a cache hit. | DerivedDataCache | [FCookStats::FScopedStatsCounter](API\Runtime\Core\ProfilingDebugging\FCookStats\FScopedStatsCounter) TimePrefetch() | [] |
FDerivedDataCacheUsageStats::TimePut | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Call this at the top of the PutCachedData override. auto Timer =TimePut(); Use AddHit on the returned type to track a cache hit. | DerivedDataCache | [FCookStats::FScopedStatsCounter](API\Runtime\Core\ProfilingDebugging\FCookStats\FScopedStatsCounter) TimePut() | [] |
FDerivedDataCacheUsageStats | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheUsageStats.h | Usage would be something like this in a concrete FDerivedDataBackendInterface implementation: class MyBackend : public FDerivedDataBackendInterface {FDerivedDataCacheUsageStatsUsageStats; public:=""> { auto Timer = UsageStats.TimeExists(); ... }=""> { auto Timer = UsageStats.TimeGet(); ...Timer.AddHit(DataSize); // Misses are automatically tracked }=""> { auto Timer = UsageStats.TimePut(); ...=""> Timer.AddHit(DataSize); // Misses are automatically tracked }=""> { // Add this node's UsageStats to the usage map. Your Key name should be UNIQUE to the entire graph (so use the file name, or pointer to this if you have to). UsageStatsMap.Add(FString::Printf(TEXT("%s:"), *GraphPath), UsageStats); } } | DerivedDataCache | class FDerivedDataCacheUsageStats | [
{
"type": "FCookStats::Cal...",
"name": "ExistsStats",
"description": ""
},
{
"type": "FCookStats::Cal...",
"name": "GetStats",
"description": "Expose these publicly for low level access. These should really never be accessed directly except when finished accumulating them."
},
{
"type": "FCookStats::Cal...",
"name": "PrefetchStats",
"description": ""
},
{
"type": "FCookStats::Cal...",
"name": "PutStats",
"description": ""
}
] |
FDerivedDataPluginInterface::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Does the work of deriving the data.
true if successful, in the event of failure the cache is not updated and failure is propagated to the original caller. | DerivedDataCache | bool Build ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutData ) | [] |
FDerivedDataPluginInterface::GetCustomThreadPool | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | IfIsBuildThreadsafe()returns true, then this is the thread pool that is used to run the background task.
The threadpool to run the task with | DerivedDataCache | virtual [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool) * GetCustomThreadPool() const | [] |
FDerivedDataPluginInterface::GetDebugContextString | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | A string used to describe the data being generated. Typically the path to the object that it is generated from is sufficient. | DerivedDataCache | virtual [FString](API\Runtime\Core\Containers\FString) GetDebugContextString() const | [] |
FDerivedDataPluginInterface::GetPluginName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Get the plugin name, this is used as the first part of the cache key
Name of the plugin | DerivedDataCache | const TCHAR * GetPluginName() const | [] |
FDerivedDataPluginInterface::GetPluginSpecificCacheKeySuffix | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Returns the largest and plugin specific part of the cache key. This must be a alphanumeric+underscore
Version number of the plugin, for licensees. | DerivedDataCache | [FString](API\Runtime\Core\Containers\FString) GetPluginSpecificCacheKeySuffix() const | [] |
FDerivedDataPluginInterface::GetVersionString | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Get the version of the plugin, this is used as part of the cache key. This is supposed to be a guid string ( ex. "69C8C8A6-A9F8-4EFC-875C-CFBB72E66486" )
Version string of the plugin | DerivedDataCache | const TCHAR * GetVersionString() const | [] |
FDerivedDataPluginInterface::IsBuildThreadsafe | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Indicates that this plugin is threadsafe. Note, the system itself will not call it concurrently if this false, however, then you are responsible for not calling the system itself concurrently.
true if this plugin is threadsafe | DerivedDataCache | bool IsBuildThreadsafe() const | [] |
FDerivedDataPluginInterface::IsDeterministic | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataPluginInterface.h | Indicated that this plugin generates deterministic data. This is used for DDC verification | DerivedDataCache | virtual bool IsDeterministic() const | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.