FBuildDefinition

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

Windows
MacOS
Linux

Inheritance Hierarchy

FBuildDefinition

FOptionalBuildDefinition

References

Module

DerivedDataCache

Header

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

Include

#include "DerivedDataBuildDefinition.h"

Syntax

class FBuildDefinition

Remarks

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

The purpose of a definition is to capture everything required to execute a derived data build. The definition is partly fixed (function name, constants, input hashes) and is partly variable (function version, build dependencies, bulk data, files), and the variable components mean the output from building the definition can vary depending on the versions of those components.

The key for the definition uniquely identifies the definition using the hash of the serialized compact binary representation of the definition.

The keys for constants and inputs are names that are unique within the build definition.

To build a definition against a specific version of the function and inputs, queue it to build on a build session, which uses its build input provider to convert it to a build action.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Const

FStringView

 

GetFunction()

Returns the name of the build function with which to build this definition.

Public function Const

const FBuild...

 

GetKey()

Returns the key that uniquely identifies this build definition.

Public function Const

FStringView

 

GetName()

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

Public function Const

bool

 

HasConstants()

Returns whether the definition has any constants.

Public function Const

bool

 

HasInputs()

Returns whether the definition has any inputs.

Public function Const

void

 

IterateConstants

(
    TFunctionRef< void Key,...
)

Visits every constant in order by key.

Public function Const

void

 

IterateInputBuilds

(
    TFunctionRef< void Key,...
)

Visits every input build value in order by key.

Public function Const

void

 

IterateInputBulkData

(
    TFunctionRef< void Key,...
)

Visits every input bulk data in order by key.

Public function Const

void

 

IterateInputFiles

(
    TFunctionRef< void Key,...
)

Visits every input file in order by key.

Public function Const

void

 

IterateInputHashes

(
    TFunctionRef< void Key,...
)

Visits every input hash in order by key.

Public function Static

FOptionalBui...

 

Load

(
    FStringView Name,
    FCbObject&& Definition
)

Load a build definition from compact binary.

Public function Const

void

 

Save

(
    FCbWriter& Writer
)

Saves the build definition to a compact binary object. Calls BeginObject and EndObject.

See Also