IBuildFunction

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

Windows
MacOS
Linux

Inheritance Hierarchy

IBuildFunction

FTextureBuildFunction

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

Name Description

Public function Virtual

~IBuildFunction()

Functions

Name Description

Public function Const

void

 

Build

(
    FBuildContext& Context
)

Build the output for the input in the build context.

Public function Virtual Const

void

 

CancelAsyncBuild

(
    FBuildContext& Context
)

Cancel an asynchronous build.

Public function Virtual Const

void

 

Configure

(
    FBuildConfigContext& Context
)

Configure the build based on its constants.

Public function Const

FStringView

 

GetName()

Returns the name of the build function, which identifies it in a build definition.

Public function Const

FGuid

 

GetVersion()

Returns the version of the build function, which must change when the function changes.

See Also