FBuildConfigContext

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

Windows
MacOS
Linux

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h

Include

#include "DerivedDataBuildFunction.h"

Syntax

class FBuildConfigContext

Remarks

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

Destructors

Name Description

Public function Virtual

~FBuildConfigContext()

Functions

Name Description

Public function

void

 

AddError

(
    FStringView Message
)

Adds the error to the build output. Must be deterministic and based only on inputs.

Public function

void

 

AddMessage

(
    FStringView Message
)

Adds the message to the build output. Must be deterministic and based only on inputs.

Public function

void

 

AddWarning

(
    FStringView Message
)

Adds the warning to the build output. Must be deterministic and based only on inputs.

Public function Const

FCbObject

 

FindConstant

(
    FStringView Key
)

Returns the constant with the matching key, or an object with no fields if not found.

Public function Const

EBuildPolicy

 

GetBuildPolicyMask()

Returns the build policy mask used when executing this build.

Public function Const

ECachePolicy

 

GetCachePolicyMask()

Returns the cache policy mask used when reading or writing this build in the cache.

Public function Const

FStringView

 

GetName()

Returns the name by which to identify this build for logging and profiling.

Public function

void

 

SetBuildPolicyMask

(
    EBuildPolicy Policy
)

Overrides the build policy mask used when executing this build.

Public function

void

 

SetCacheBucket

(
    FCacheBucket Bucket
)

Overrides the cache bucket used when reading or writing this build in the cache.

Public function

void

 

SetCachePolicyMask

(
    ECachePolicy Policy
)

Overrides the cache policy mask used when reading or writing this build in the cache.

Public function

void

 

SetRequiredMemory

(
    uint64 RequiredMemory
)

Sets the estimated peak memory required to execute the build, excluding input size.

Public function

void

 

SkipDeterministicOutputCheck()

Skips verification that this function has deterministic output.