DerivedDataCache

Windows
MacOS
Linux

Classes

Name

Description

Public class

FBuildAction

A build action is an immutable reference to a build function and its inputs.

Public class

FBuildActionBuilder

A build action builder is used to construct a build action.

Public struct

FBuildActionKey

A key that uniquely identifies a build action.

Public struct

FBuildCompleteParams

Parameters for the completion callback for build requests.

Public class

FBuildConfigContext

A build config context allows cache and build behavior to be modified based on constant inputs.

Public class

FBuildContext

A build context provides the inputs for a build function and saves its outputs.

Public class

FBuildDefinition

A build definition is an immutable reference to a build function and its inputs.

Public class

FBuildDefinitionBuilder

A build definition builder is used to construct a build definition.

Public struct

FBuildInputDataByKey

Data for build inputs with the input key.

Public struct

FBuildInputDataResolvedParams

Parameters for the resolved callback for build input data requests.

Public struct

FBuildInputMetaByKey

Metadata for build inputs with the input key.

Public struct

FBuildInputMetaResolvedParams

Parameters for the resolved callback for build input metadata requests.

Public class

FBuildInputs

Build inputs are an immutable container of key/value pairs for the inputs to a build function.

Public class

FBuildInputsBuilder

A build inputs builder is used to construct build inputs.

Public struct

FBuildJobCompleteParams

Parameters for the completion callback for build jobs.

Public struct

FBuildKey

A key that uniquely identifies a build definition.

Public struct

FBuildKeyResolvedParams

Parameters for the resolved callback for build definition requests.

Public class

FBuildOutput

A build output is an immutable container of values, messages, and logs produced by a build.

Public class

FBuildOutputBuilder

A build output builder is used to construct a build output.

Public struct

FBuildOutputLog

A build output log is a log message captured from a build function.

Public struct

FBuildOutputMessage

A build output message is diagnostic output from a build function and must be deterministic.

Public class

FBuildPolicy

Flags to control the behavior of build requests, with optional overrides by value.

Public class

FBuildPolicyBuilder

A build policy builder is used to construct a build policy.

Public struct

FBuildSchedulerParams

Parameters that describe a build job to the build scheduler.

Public class

FBuildSession

A build session is the main point to the build scheduler.

Public struct

FBuildValueKey

A key that uniquely identifies a value within a build output.

Public struct

FBuildValuePolicy

A value ID and the build policy to use for that value.

Public class

FBuildVersionBuilder

A type that builds a build version from arbitrary values serialized to it.

Public class

FBuildWorker

Public struct

FBuildWorkerActionCompleteParams

Public class

FBuildWorkerBuilder

Public struct

FBuildWorkerFileDataCompleteParams

Public class

FCacheBucket

An alphanumeric identifier that groups related cache records.

Public struct

FCacheGetChunkRequest

Parameters to request a chunk, which is a subset of a value, from a cache record or cache value.

Public struct

FCacheGetChunkResponse

Parameters for the completion callback for cache chunk requests.

Public struct

FCacheGetRequest

Parameters to request to get a cache record.

Public struct

FCacheGetResponse

Parameters for the completion callback for cache get requests.

Public struct

FCacheGetValueRequest

Parameters to request to get a cache value.

Public struct

FCacheGetValueResponse

Parameters for the completion callback for cache value get requests.

Public struct

FCacheKey

A key that uniquely identifies a cache record.

Public struct

FCachePutRequest

Parameters to request to put a cache record.

Public struct

FCachePutResponse

Parameters for the completion callback for cache put requests.

Public struct

FCachePutValueRequest

Parameters to request to put a cache value.

Public struct

FCachePutValueResponse

Parameters for the completion callback for cache value put requests.

Public class

FCacheRecord

A cache record is a key, an array of values, and metadata.

Public class

FCacheRecordBuilder

A cache record builder is used to construct a cache record.

Public struct

FCacheRecordKeyFuncs

An implementation of KeyFuncs to compare FCacheRecord by its FCacheKey.

Public class

FCacheRecordPolicy

Flags to control the behavior of cache record requests, with optional overrides by value.

Public class

FCacheRecordPolicyBuilder

A cache record policy builder is used to construct a cache record policy.

Public struct

FCacheValuePolicy

A value ID and the cache policy to use for that value.

Public class

FDerivedDataCacheInterface

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

Public struct

FDerivedDataCacheResourceStat

Public struct

FDerivedDataCacheResourceStatKeyFuncs

Public class

FDerivedDataCacheStatsNode

Hierarchical usage stats for the DDC nodes.

Public struct

FDerivedDataCacheSummaryStats

Public class

FDerivedDataCacheUsageStats

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FDerivedDataPluginInterface

Interface for data deriving backends This API will not be called concurrently, except that Build might be called on different instances if IsBuildThreadsafe.

Public class

FOptionalBuildAction

A build action that can be null.

Public class

FOptionalBuildDefinition

A build definition that can be null.

Public class

FOptionalBuildInputs

Build inputs that can be null.

Public class

FOptionalBuildOutput

A build output that can be null.

Public class

FOptionalBuildSession

A build session that can be null.

Public class

FOptionalCacheRecord

A cache record that can be null.

Public class

FRequestBarrier

A request barrier is expected to be used when an owner may have new requests added to it.

Public class

FRequestBase

An asynchronous request base type that provides reference counting.

Public class

FRequestOwner

A concrete request owner that also presents as a request.

Public class

FValue

A value is a compressed buffer identified by its raw hash and raw size.

Public struct

FValueId

A 12-byte value that uniquely identifies a value in the context that it was created.

Public class

FValueWithId

A value with an ID.

Public class

IBuild

Interface to the build system.

Public class

IBuildActionBuilderInternal

Public class

IBuildActionInternal

Public class

IBuildDefinitionBuilderInternal

Public class

IBuildDefinitionInternal

Public class

IBuildFunction

A build function is referenced by a build definition as the way to build its inputs.

Public class

IBuildFunctionFactory

DO NOT USE DIRECTLY.

Public class

IBuildFunctionRegistry

A build function registry maintains a collection of build functions.

Public class

IBuildInputResolver

Interface to resolve references to build inputs.

Public class

IBuildInputsBuilderInternal

Public class

IBuildInputsInternal

Public class

IBuildJob

A build job is responsible for the execution of one build.

Public class

IBuildJobSchedule

Scheduling interface and context for a build job.

Public class

IBuildOutputBuilderInternal

Public class

IBuildOutputInternal

Public class

IBuildPolicyShared

Interface for the private implementation of the build policy.

Public class

IBuildScheduler

A build scheduler is responsible for deciding when and where a job executes in certain states.

Public class

IBuildSessionInternal

Public class

IBuildWorkerExecutor

Public class

IBuildWorkerFactory

Public class

IBuildWorkerRegistry

A build worker registry maintains a collection of build workers.

Public class

ICache

Interface to the cache.

Public class

ICacheRecordBuilderInternal

Public class

ICacheRecordInternal

Public class

ICacheRecordPolicyShared

Interface for the private implementation of the cache record policy.

Public class

ICacheStore

Interface to a store of cache records and cache values.

Public class

ICacheStoreMaintainer

A cache store may register an instance of this interface to take part in cache maintenance.

Public class

IDDCCleanup

Public class

IDerivedDataCacheModule

Module for the Derived Data Cache and Derived Data Build.

Public class

IRequest

Interface to an asynchronous request that can be prioritized or canceled.

Public class

IRequestOwner

A request owner manages requests throughout their execution.

Public class

TBuildFunctionFactory

Factory that creates and registers a build function.

Public struct

TChunkEqual

Binary predicate that compares chunks by key, then value ID, then raw offset.

Public struct

TChunkLess

Binary predicate that compares chunks by key, then value ID, then raw offset.

Public class

TSharedString

A reference to an immutable, shared, reference-counted string.

Typedefs

Enums

Name

Description

Public enum

UE::DerivedData::EBuildOutputLogLevel

Temporary interface for tunneling the EditorBuildInputResolver into CoreUObject.

Public enum

UE::DerivedData::EBuildOutputMessageLevel

Temporary interface for tunneling the EditorBuildInputResolver into CoreUObject.

Public enum

UE::DerivedData::EBuildPolicy

Flags to control the behavior of build requests.

Public enum

UE::DerivedData::EBuildStatus

Flags for build request completion callbacks.

Public enum

UE::DerivedData::ECachePolicy

Flags to control the behavior of cache requests.

Public enum

UE::DerivedData::EPriority

Priority for scheduling a request.

Public enum

UE::DerivedData::ERequestBarrierFlags

Flags to control the behavior of request barriers.

Public enum

UE::DerivedData::EStatus

Status of a request that has completed.

Functions

Name Description

Public function

 

COOK_STAT

(
    using FDerivedDataCacheSummaryStat
)

Public function

constexpr co...

 

UE::DerivedData::GetData

(
    const TSharedString< CharType > Str...
)

Public function

constexpr au...

 

UE::DerivedData::GetNum

(
    const TSharedString< CharType > Str...
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const FBuildKey& Key
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const FBuildActionKey& Key
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const FBuildValueKey& Key
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const FCacheKey& Key
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const TSharedString< CharType >& S...
)

Public function

uint32

 

UE::DerivedData::GetTypeHash

(
    const FValueId& Id
)

Public function

constexpr bo...

 

UE::DerivedData::operator!

(
    EBuildPolicy E
)

Public function

constexpr bo...

 

UE::DerivedData::operator!

(
    EBuildStatus E
)

Public function

constexpr bo...

 

UE::DerivedData::operator!

(
    ECachePolicy E
)

Public function

constexpr bo...

 

UE::DerivedData::operator!

(
    ERequestBarrierFlags E
)

Public function

bool

 

UE::DerivedData::operator!=

(
    const FValueId& A,
    const FValueId& B
)

Public function

bool

 

UE::DerivedData::operator!=

(
    const FCacheKey& A,
    const FCacheKey& B
)

Public function

bool

 

UE::DerivedData::operator!=

(
    const FBuildKey& A,
    const FBuildKey& B
)

Public function

bool

 

UE::DerivedData::operator!=

(
    const FBuildActionKey& A,
    const FBuildActionKey& B
)

Public function

bool

 

UE::DerivedData::operator!=

(
    const FBuildValueKey& A,
    const FBuildValueKey& B
)

Public function

constexpr EB...

 

UE::DerivedData::operator&

(
    EBuildPolicy Lhs,
    EBuildPolicy Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator&

(
    EBuildStatus Lhs,
    EBuildStatus Rhs
)

Public function

constexpr EC...

 

UE::DerivedData::operator&

(
    ECachePolicy Lhs,
    ECachePolicy Rhs
)

Public function

constexpr ER...

 

UE::DerivedData::operator&

(
    ERequestBarrierFlags Lhs,
    ERequestBarrierFlags Rhs
)

Public function

EBuildPolicy...

 

UE::DerivedData::operator&=

(
    EBuildPolicy& Lhs,
    EBuildPolicy Rhs
)

Public function

EBuildStatus...

 

UE::DerivedData::operator&=

(
    EBuildStatus& Lhs,
    EBuildStatus Rhs
)

Public function

ECachePolicy...

 

UE::DerivedData::operator&=

(
    ECachePolicy& Lhs,
    ECachePolicy Rhs
)

Public function

ERequestBarr...

 

UE::DerivedData::operator&=

(
    ERequestBarrierFlags& Lhs,
    ERequestBarrierFlags Rhs
)

Public function

constexpr ER...

 

UE::DerivedData::operator^

(
    ERequestBarrierFlags Lhs,
    ERequestBarrierFlags Rhs
)

Public function

constexpr EC...

 

UE::DerivedData::operator^

(
    ECachePolicy Lhs,
    ECachePolicy Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator^

(
    EBuildPolicy Lhs,
    EBuildPolicy Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator^

(
    EBuildStatus Lhs,
    EBuildStatus Rhs
)

Public function

EBuildPolicy...

 

UE::DerivedData::operator^=

(
    EBuildPolicy& Lhs,
    EBuildPolicy Rhs
)

Public function

EBuildStatus...

 

UE::DerivedData::operator^=

(
    EBuildStatus& Lhs,
    EBuildStatus Rhs
)

Public function

ECachePolicy...

 

UE::DerivedData::operator^=

(
    ECachePolicy& Lhs,
    ECachePolicy Rhs
)

Public function

ERequestBarr...

 

UE::DerivedData::operator^=

(
    ERequestBarrierFlags& Lhs,
    ERequestBarrierFlags Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator|

(
    EBuildPolicy Lhs,
    EBuildPolicy Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator|

(
    EBuildStatus Lhs,
    EBuildStatus Rhs
)

Public function

constexpr EC...

 

UE::DerivedData::operator|

(
    ECachePolicy Lhs,
    ECachePolicy Rhs
)

Public function

constexpr ER...

 

UE::DerivedData::operator|

(
    ERequestBarrierFlags Lhs,
    ERequestBarrierFlags Rhs
)

Public function

ERequestBarr...

 

UE::DerivedData::operator|=

(
    ERequestBarrierFlags& Lhs,
    ERequestBarrierFlags Rhs
)

Public function

ECachePolicy...

 

UE::DerivedData::operator|=

(
    ECachePolicy& Lhs,
    ECachePolicy Rhs
)

Public function

EBuildPolicy...

 

UE::DerivedData::operator|=

(
    EBuildPolicy& Lhs,
    EBuildPolicy Rhs
)

Public function

EBuildStatus...

 

UE::DerivedData::operator|=

(
    EBuildStatus& Lhs,
    EBuildStatus Rhs
)

Public function

constexpr EB...

 

UE::DerivedData::operator~

(
    EBuildPolicy E
)

Public function

constexpr EB...

 

UE::DerivedData::operator~

(
    EBuildStatus E
)

Public function

constexpr EC...

 

UE::DerivedData::operator~

(
    ECachePolicy E
)

Public function

constexpr ER...

 

UE::DerivedData::operator~

(
    ERequestBarrierFlags E
)

Public function

bool

 

UE::DerivedData::operator==

(
    const TSharedString< CharType >& L...,
    const TSharedString< CharType >& R...
)

Public function

bool

 

UE::DerivedData::operator==

(
    const FValue& A,
    const FValue& B
)

Compare values by the hash and size of their raw buffer.

Public function

bool

 

UE::DerivedData::operator==

(
    const FCacheKey& A,
    const FCacheKey& B
)

Public function

bool

 

UE::DerivedData::operator==

(
    const FValueWithId& A,
    const FValueWithId& B
)

Compare values by their ID and the hash and size of their raw buffer.

Public function

bool

 

UE::DerivedData::operator==

(
    const FBuildActionKey& A,
    const FBuildActionKey& B
)

Public function

bool

 

UE::DerivedData::operator==

(
    const FBuildKey& A,
    const FBuildKey& B
)

Public function

bool

 

UE::DerivedData::operator==

(
    const FBuildValueKey& A,
    const FBuildValueKey& B
)

Public function

bool

 

UE::DerivedData::operator==

(
    const FValueId& A,
    const FValueId& B
)