FBuildDefinition

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

Unreal Engine C++ API Reference > Developer > DerivedDataCache

Inheritance Hierarchy

  • FBuildDefinition

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

Type Name Description
const FUtf8S... GetFunction () Returns the name of the build function with which to build this definition.
const FBuild... GetKey () Returns the key that uniquely identifies this build definition.
const FShare... GetName () Returns the name by which to identify this definition for logging and profiling.
bool HasConstants () Returns whether the definition has any constants.
bool HasInputs () Returns whether the definition has any inputs.
void IterateConstants ( TFunctionRef< void(FUtf8StringView ... ) Visits every constant in order by key. The key view is valid for the lifetime of the definition.
void IterateInputBuilds ( TFunctionRef< void(FUtf8StringView ... ) Visits every input build value in order by key.
void IterateInputBulkData ( TFunctionRef< void(FUtf8StringView ... ) Visits every input bulk data in order by key.
void IterateInputFiles ( TFunctionRef< void(FUtf8StringView ... ) Visits every input file in order by key.
void IterateInputHashes ( TFunctionRef< void(FUtf8StringView ... ) Visits every input hash in order by key. The key view is valid for the lifetime of the definition.
FOptionalBui... Load ( const FSharedString& Name, FCbObject&& Definition ) Load a build definition from compact binary.
void Save ( FCbWriter& Writer ) Saves the build definition to a compact binary object. Calls BeginObject and EndObject.

See Also

FBuildDefinitionBuilder

FBuildSession


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library