IBuildFunction

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

Unreal Engine C++ API Reference > Developer > DerivedDataCache

Inheritance Hierarchy

  • IBuildFunction

References

   
Module DerivedDataCache
Header /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Include #include "DerivedDataBuildFunction.h"

Syntax

class IBuildFunction  

Remarks

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

Functions are expected to be pure and maintain no state. Inputs are provided through the build context, and outputs are saved through the build context.

Functions have a version which is used as a proxy for their code. Any code changes that affect the behavior of a function must have a corresponding change in the function version.

Functions must be registered by a build function factory to be available to the build system.

Destructors

Type Name Description
  ~IBuildFunction ()  

Functions

Type Name Description
void Build ( FBuildContext& Context ) Build the output for the input in the build context.
void CancelAsyncBuild ( FBuildContext& Context ) Cancel an asynchronous build.
void Configure ( FBuildConfigContext& Context ) Configure the build based on its constants.
const FUtf8S... GetName () Returns the name of the build function, which identifies it in a build definition.
FGuid GetVersion () Returns the version of the build function, which must change when the function changes.

See Also

FBuildContext

FBuildConfigContext

TBuildFunctionFactory


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library