1. Epic GamesDeveloper
  3. FBuildContext

FBuildContext

A build context provides the inputs for a build function and saves its outputs.

API > API/Developer > API/Developer/DerivedDataCache

References

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

Syntax

class FBuildContext

Remarks

A build context provides the inputs for a build function and saves its outputs.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type 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

AddMeta ( FUtf8StringView Key,
const FCbField& Meta
)

 Adds metadata to the build output.
Public function void

AddValue ( const FValueId& Id,
const FCbObject& Object
)

  
Public function void

AddValue ( const FValueId& Id,
const FCompressedBuffer& Buffer
)

  
Public function void

AddValue ( const FValueId& Id,
const FValue& Value
)

 Adds a value to the build output. Must have a non-null buffer and a unique ID.
Public function void

AddValue ( const FValueId& Id,
const FCompositeBuffer& Buffer,
uint64 BlockSize
)

  
Public function void

AddValue ( const FValueId& Id,
const FSharedBuffer& Buffer,
uint64 BlockSize
)

  
Public function void

AddWarning ( FStringView Message
)

 Adds the warning to the build output. Must be deterministic and based only on inputs.
Public function void Make this an asynchronous build by making the caller responsible for completing the build.
Public function void Mark the end of an asynchronous build.
Public function Const FCbObject Returns the constant with the matching key, or an object with no fields if not found.
Public function Const FSharedBuffer Returns the input with the matching key, or a null buffer if not found.
Public function Const const FSharedString &

GetName ()

 Returns the name by which to identify this build for logging and profiling.
Public function Const uint64 Returns estimate of memory required for this operation.
Public function void Overrides the cache policy mask used when writing this build in the cache.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page