Navigation
| Name | DerivedDataCache |
| Type | Developer |
| Location | /Engine/Source/Developer/DerivedDataCache/ |
| Module Build Rules | DerivedDataCache.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FBuildAction | A build action is an immutable reference to a build function and its inputs. |
| FBuildActionBuilder | A build action builder is used to construct a build action. |
| FBuildConfigContext | A build config context allows cache and build behavior to be modified based on constant inputs. |
| FBuildContext | A build context provides the inputs for a build function and saves its outputs. |
| FBuildDefinition | A build definition is an immutable reference to a build function and its inputs. |
| FBuildDefinitionBuilder | A build definition builder is used to construct a build definition. |
| FBuildInputs | Build inputs are an immutable container of key/value pairs for the inputs to a build function. |
| FBuildInputsBuilder | A build inputs builder is used to construct build inputs.Create using IBuild::CreateInputs(). |
| FBuildOutput | A build output is an immutable container of values, messages, and logs produced by a build. |
| FBuildOutputBuilder | A build output builder is used to construct a build output.Create using IBuild::CreateOutput(). |
| FBuildPolicy | Flags to control the behavior of build requests, with optional overrides by value. |
| FBuildPolicyBuilder | A build policy builder is used to construct a build policy. |
| FBuildSession | A build session is the main point to the build scheduler. |
| FBuildVersionBuilder | A type that builds a build version from arbitrary values serialized to it. |
| FBuildWorker | |
| FBuildWorkerBuilder | |
| FCacheBucket | An alphanumeric identifier that groups related cache records. |
| FCacheKeyBuilder | A type that builds a cache key from arbitrary values serialized to it. |
| FCacheRecord | A cache record is a key, an array of values, and metadata. |
| FCacheRecordBuilder | A cache record builder is used to construct a cache record. |
| FCacheRecordPolicy | Flags to control the behavior of cache record requests, with optional overrides by value. |
| FCacheRecordPolicyBuilder | A cache record policy builder is used to construct a cache record policy. |
| FDerivedDataCacheInterface | Interface for the derived data cache This API is fully threadsafe (with the possible exception of the system interface: NotfiyBootComplete, etc). |
| FDerivedDataCacheStatsNode | Hierarchical usage stats for the DDC nodes. |
| FDerivedDataCacheUsageStats | |
| FDerivedDataPluginInterface | Interface for data deriving backends This API will not be called concurrently, except that Build might be called on different instances if IsBuildThreadsafe. |
| FOptionalBuildAction | A build action that can be null. |
| FOptionalBuildDefinition | A build definition that can be null. |
| FOptionalBuildInputs | Build inputs that can be null. |
| FOptionalBuildOutput | A build output that can be null. |
| FOptionalBuildSession | A build session that can be null. |
| FOptionalCacheRecord | A cache record that can be null. |
| FOptionalCacheRecordPolicy | A cache record policy that can be null. |
| FRequestBarrier | A request barrier is expected to be used when an owner may have new requests added to it. |
| FRequestBase | An asynchronous request base type that provides reference counting. |
| FRequestOwner | A concrete request owner that also presents as a request. |
| FValue | A value is a compressed buffer identified by its raw hash and raw size. |
| FValueWithId | A value with an ID. |
| TBuildFunctionFactory | Factory that creates and registers a build function. |
| TFunctionRef |
Structs
| Name | Remarks |
|---|---|
| FBuildActionKey | A key that uniquely identifies a build action. |
| FBuildCompleteParams | Parameters for the completion callback for build requests. |
| FBuildInputDataByKey | Data for build inputs with the input key. |
| FBuildInputDataResolvedParams | Parameters for the resolved callback for build input data requests. |
| FBuildInputMetaByKey | Metadata for build inputs with the input key. |
| FBuildInputMetaResolvedParams | Parameters for the resolved callback for build input metadata requests. |
| FBuildJobCompleteParams | Parameters for the completion callback for build jobs. |
| FBuildKey | A key that uniquely identifies a build definition. |
| FBuildKeyResolvedParams | Parameters for the resolved callback for build definition requests. |
| FBuildOutputLog | A build output log is a log message captured from a build function. |
| FBuildOutputMessage | A build output message is diagnostic output from a build function and must be deterministic. |
| FBuildSchedulerParams | Parameters that describe a build job to the build scheduler. |
| FBuildValueKey | A key that uniquely identifies a value within a build output. |
| FBuildValuePolicy | A value ID and the build policy to use for that value. |
| FBuildWorkerActionCompleteParams | |
| FBuildWorkerFileDataCompleteParams | |
| FCacheGetChunkRequest | Parameters to request a chunk, which is a subset of a value, from a cache record or cache value. |
| FCacheGetChunkResponse | Parameters for the completion callback for cache chunk requests. |
| FCacheGetRequest | Parameters to request to get a cache record. |
| FCacheGetResponse | Parameters for the completion callback for cache get requests. |
| FCacheGetValueRequest | Parameters to request to get a cache value. |
| FCacheGetValueResponse | Parameters for the completion callback for cache value get requests. |
| FCacheKey | A key that uniquely identifies a cache record. |
| FCachePutRequest | Parameters to request to put a cache record. |
| FCachePutResponse | Parameters for the completion callback for cache put requests. |
| FCachePutValueRequest | Parameters to request to put a cache value. |
| FCachePutValueResponse | Parameters for the completion callback for cache value put requests. |
| FCacheRecordKeyFuncs | An implementation of KeyFuncs to compare FCacheRecord by its FCacheKey. |
| FCacheValuePolicy | A value ID and the cache policy to use for that value. |
| FDerivedDataCacheResourceStat | |
| FDerivedDataCacheResourceStatKeyFuncs | |
| FDerivedDataCacheSpeedStats | Performance stats for this backend |
| FDerivedDataCacheSummaryStats | |
| FValueId | A 12-byte value that uniquely identifies a value in the context that it was created. |
| TChunkEqual | Binary predicate that compares chunks by key, then value ID, then raw offset. |
| TChunkLess | Binary predicate that compares chunks by key, then value ID, then raw offset. |
Interfaces
| Name | Remarks |
|---|---|
| IBuild | Interface to the build system. |
| IBuildActionBuilderInternal | |
| IBuildActionInternal | |
| IBuildDefinitionBuilderInternal | |
| IBuildDefinitionInternal | |
| IBuildFunction | A build function is referenced by a build definition as the way to build its inputs. |
| IBuildFunctionFactory | DO NOT USE DIRECTLY. |
| IBuildFunctionRegistry | A build function registry maintains a collection of build functions. |
| IBuildInputResolver | Interface to resolve references to build inputs. |
| IBuildInputsBuilderInternal | |
| IBuildInputsInternal | |
| IBuildJob | A build job is responsible for the execution of one build. |
| IBuildJobSchedule | Scheduling interface and context for a build job. |
| IBuildOutputBuilderInternal | |
| IBuildOutputInternal | |
| IBuildPolicyShared | Interface for the private implementation of the build policy. |
| IBuildScheduler | A build scheduler is responsible for deciding when and where a job executes in certain states. |
| IBuildSchedulerMemoryQueue | Allows execution of a build to be queued until there is sufficient memory available. |
| IBuildSchedulerTypeQueue | Allows execution of a build to be queued in a type-specific way. |
| IBuildSessionInternal | |
| IBuildWorkerExecutor | |
| IBuildWorkerFactory | |
| IBuildWorkerRegistry | A build worker registry maintains a collection of build workers. |
| ICache | Interface to the cache. |
| ICacheRecordBuilderInternal | |
| ICacheRecordInternal | |
| ICacheRecordPolicyShared | Interface for the private implementation of the cache record policy. |
| ICacheStoreMaintainer | A cache store may register an instance of this interface to take part in cache maintenance. |
| IDDCCleanup | |
| IDerivedDataCacheModule | Module for the Derived Data Cache and Derived Data Build. |
| IRequest | Interface to an asynchronous request that can be prioritized or canceled. |
| IRequestOwner | A request owner manages requests throughout their execution. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FBuildInputFilter | TUniqueFunction< bool(FUtf8StringView Key)> | DerivedDataBuildInputResolver.h | |
| FOnBuildComplete | TUniqueFunction< void(FBuildCompleteParams &&Params)> | DerivedDataBuildTypes.h | |
| FOnBuildInputDataResolved | TUniqueFunction< void(FBuildInputDataResolvedParams &&Params)> | DerivedDataBuildInputResolver.h | |
| FOnBuildInputMetaResolved | TUniqueFunction< void(FBuildInputMetaResolvedParams &&Params)> | DerivedDataBuildInputResolver.h | |
| FOnBuildJobComplete | TUniqueFunction< void(FBuildJobCompleteParams &&Params)> | DerivedDataBuildJob.h | |
| FOnBuildKeyResolved | TUniqueFunction< void(FBuildKeyResolvedParams &&Params)> | DerivedDataBuildInputResolver.h | |
| FOnBuildWorkerActionComplete | TUniqueFunction< void(FBuildWorkerActionCompleteParams &&Params)> | DerivedDataBuildWorker.h | |
| FOnBuildWorkerFileDataComplete | TUniqueFunction< void(FBuildWorkerFileDataCompleteParams &&Params)> | DerivedDataBuildWorker.h | |
| FOnCacheGetChunkComplete | TUniqueFunction< void(FCacheGetChunkResponse &&Response)> | DerivedDataCache.h | |
| FOnCacheGetComplete | TUniqueFunction< void(FCacheGetResponse &&Response)> | DerivedDataCache.h | |
| FOnCacheGetValueComplete | TUniqueFunction< void(FCacheGetValueResponse &&Response)> | DerivedDataCache.h | |
| FOnCachePutComplete | TUniqueFunction< void(FCachePutResponse &&Response)> | DerivedDataCache.h | |
| FOnCachePutValueComplete | TUniqueFunction< void(FCachePutValueResponse &&Response)> | DerivedDataCache.h | |
| FOnCacheRecordComplete | TUniqueFunction< void(FCacheRecord &&Record)> | DerivedDataCacheRecord.h |
Enums
Public
| Name | Remarks |
|---|---|
| EDerivedDataCacheStatus | |
| UE::DerivedData::EBuildOutputLogLevel | |
| UE::DerivedData::EBuildOutputMessageLevel | |
| UE::DerivedData::EBuildPolicy | Flags to control the behavior of build requests. |
| UE::DerivedData::EBuildStatus | Flags for build request completion callbacks. |
| UE::DerivedData::ECachePolicy | Flags to control the behavior of cache requests. |
| UE::DerivedData::EPriority | Priority for scheduling a request. |
| UE::DerivedData::ERequestBarrierFlags | Flags to control the behavior of request barriers. |
| UE::DerivedData::EStatus | Status of a request that has completed. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
COOK_STAT
(
using FDerivedDataCacheSummaryStat |
DerivedDataCacheUsageStats.h | ||
void GatherDerivedDataCacheResourceStats
(
TArray< FDerivedDataCacheResourceStat >& DDCResourceStats |
DerivedDataCacheUsageStats.h | ||
void GatherDerivedDataCacheSummaryStats
(
FDerivedDataCacheSummaryStats& DDCSummaryStats |
DerivedDataCacheUsageStats.h | ||
| DerivedDataBuildTypes.h | |||
| DerivedDataBuildTypes.h | |||
| DerivedDataCachePolicy.h | |||
| DerivedDataRequestOwner.h | |||
uint32 UE::DerivedData::GetTypeHash
(
const FBuildKey& Key |
DerivedDataBuildKey.h | ||
uint32 UE::DerivedData::GetTypeHash
(
const FBuildActionKey& Key |
DerivedDataBuildKey.h | ||
uint32 UE::DerivedData::GetTypeHash
(
const FBuildValueKey& Key |
DerivedDataBuildKey.h | ||
uint32 UE::DerivedData::GetTypeHash
(
const FValueId& Id |
DerivedDataValueId.h | ||
bool UE::DerivedData::operator!=
(
const FBuildKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator!=
(
const FBuildActionKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator!=
(
const FBuildValueKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator!=
(
const FValueId& A, |
DerivedDataValueId.h | ||
bool UE::DerivedData::operator==
(
const FBuildKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator==
(
const FBuildActionKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator==
(
const FBuildValueKey& A, |
DerivedDataBuildKey.h | ||
bool UE::DerivedData::operator==
(
const FValue& A, |
Compare values by the hash and size of their raw buffer. | DerivedDataValue.h | |
bool UE::DerivedData::operator==
(
const FValueWithId& A, |
Compare values by their ID and the hash and size of their raw buffer. | DerivedDataValue.h | |
bool UE::DerivedData::operator==
(
const FValueId& A, |
DerivedDataValueId.h |