className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FBuildConfigContext::AddError
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds the error to the build output. Must be deterministic and based only on inputs.
DerivedDataCache
void AddError ( FStringView Message )
[]
FBuildConfigContext::AddWarning
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds the warning to the build output. Must be deterministic and based only on inputs.
DerivedDataCache
void AddWarning ( FStringView Message )
[]
FBuildConfigContext::FindConstant
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the constant with the matching key, or an object with no fields if not found.
DerivedDataCache
[FCbObject](API\Runtime\Core\Serialization\FCbObject) FindConstant ( FUtf8StringView Key ) const
[]
FBuildConfigContext::GetBuildPolicyMask
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the build policy mask used when executing this build.
DerivedDataCache
[EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) GetBuildPolicyMask() const
[]
FBuildConfigContext::GetCachePolicyMask
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the cache policy mask used when reading or writing this build in the cache.
DerivedDataCache
[ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) GetCachePolicyMask() const
[]
FBuildConfigContext::GetName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the name by which to identify this build for logging and profiling.
DerivedDataCache
const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const
[]
FBuildConfigContext::SetBuildPolicyMask
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Set the mask to the bitwise complement of the flags to be cleared: ~EBuildPolicyBuildRemote.
DerivedDataCache
void SetBuildPolicyMask ( [EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) Policy )
[]
FBuildConfigContext::SetCacheBucket
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Overrides the cache bucket used when reading or writing this build in the cache.
DerivedDataCache
void SetCacheBucket ( [FCacheBucket](API\Developer\DerivedDataCache\FCacheBucket) Bucket )
[]
FBuildConfigContext::SetCachePolicyMask
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Set the mask to the bitwise complement of the flags to be cleared: ~ECachePolicyRemote.
DerivedDataCache
void SetCachePolicyMask ( [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) Policy )
[]
FBuildConfigContext::SetRequiredMemory
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Sets the estimated peak memory required to execute the build, excluding input size.
DerivedDataCache
void SetRequiredMemory ( uint64 RequiredMemory )
[]
FBuildConfigContext::SetTypeName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Overrides the name of the type for the build. Defaults to the function name.
DerivedDataCache
void SetTypeName ( const [FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & TypeName )
[]
FBuildConfigContext::SkipDeterministicOutputCheck
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Skips verification that this function has deterministic output.
DerivedDataCache
void SkipDeterministicOutputCheck()
[]
FBuildConfigContext::~FBuildConfigContext
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
virtual ~FBuildConfigContext()
[]
FBuildContext::AddMessage
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds the message to the build output. Must be deterministic and based only on inputs.
DerivedDataCache
void AddMessage ( FStringView Message )
[]
FBuildContext::AddError
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds the error to the build output. Must be deterministic and based only on inputs.
DerivedDataCache
void AddError ( FStringView Message )
[]
FBuildConfigContext
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
A build config context allows cache and build behavior to be modified based on constant inputs.
DerivedDataCache
class FBuildConfigContext
[]
FBuildContext::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds a value to the build output. Must have a non-null buffer and a unique ID.
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FValue](API\Developer\DerivedDataCache\FValue) & Value )
[]
FBuildContext::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & Buffer )
[]
FBuildContext::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & Object )
[]
FBuildContext::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & Buffer, uint64 BlockSize )
[]
FBuildContext::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & Buffer, uint64 BlockSize )
[]
FBuildContext::BeginAsyncBuild
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
This may be called at most once on a build context. A function that uses this must support async cancellation by implementing CancelAsyncBuild. Once this has been called, the caller is responsible for calling EndAsyncBuild to finish this build. An async build may end from any thread, but the context is only safe to use from one thread at a time.
DerivedDataCache
void BeginAsyncBuild()
[]
FBuildContext::AddWarning
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Adds the warning to the build output. Must be deterministic and based only on inputs.
DerivedDataCache
void AddWarning ( FStringView Message )
[]
FBuildContext::EndAsyncBuild
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
It is invalid to call any other function on the build context after calling this.
DerivedDataCache
void EndAsyncBuild()
[]
FBuildContext::FindConstant
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the constant with the matching key, or an object with no fields if not found.
DerivedDataCache
[FCbObject](API\Runtime\Core\Serialization\FCbObject) FindConstant ( FUtf8StringView Key ) const
[]
FBuildContext::FindInput
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the input with the matching key, or a null buffer if not found.
DerivedDataCache
[FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) FindInput ( FUtf8StringView Key ) const
[]
FBuildContext::GetName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Returns the name by which to identify this build for logging and profiling.
DerivedDataCache
const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const
[]
FBuildContext::SetCachePolicyMask
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
Overrides the cache policy mask used when writing this build in the cache.
DerivedDataCache
void SetCachePolicyMask ( [ECachePolicy](API\Developer\DerivedDataCache\UE__DerivedData__ECachePolicy) Policy )
[]
FBuildContext::~FBuildContext
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
DerivedDataCache
virtual ~FBuildContext()
[]
FBuildContext
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildFunction.h
A build context provides the inputs for a build function and saves its outputs.
DerivedDataCache
class FBuildContext
[]
FBuildDefinition::GetFunction
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Returns the name of the build function with which to build this definition.
DerivedDataCache
const [FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & GetFunction() const
[]
FBuildDefinition::GetKey
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Returns the key that uniquely identifies this build definition.
DerivedDataCache
const [FBuildKey](API\Developer\DerivedDataCache\FBuildKey) & GetKey() const
[]
FBuildDefinition::GetName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Returns the name by which to identify this definition for logging and profiling.
DerivedDataCache
const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const
[]
FBuildDefinition::HasConstants
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Returns whether the definition has any constants.
DerivedDataCache
bool HasConstants() const
[]
FBuildDefinition::IterateConstants
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Visits every constant in order by key. The key view is valid for the lifetime of the definition.
DerivedDataCache
void IterateConstants ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, [FCbObject](API\Runtime\Core\Serialization\FCbObject) &&Value)> Visitor ) const
[]
FBuildDefinition::HasInputs
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Returns whether the definition has any inputs.
DerivedDataCache
bool HasInputs() const
[]
FBuildDefinition::IterateInputBuilds
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Visits every input build value in order by key. The key view is valid for the lifetime of the definition.
DerivedDataCache
void IterateInputBuilds ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, const [FBuildValueKey](API\Developer\DerivedDataCache\FBuildValueKey) &ValueKey)> Visitor ) const
[]
FBuildDefinition::IterateInputFiles
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Visits every input file in order by key. The key and path views are valid for the lifetime of the definition.
DerivedDataCache
void IterateInputFiles ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, FUtf8StringView Path)> Visitor ) const
[]
FBuildDefinition::IterateInputBulkData
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Visits every input bulk data in order by key. The key view is valid for the lifetime of the definition.
DerivedDataCache
void IterateInputBulkData ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, const [FGuid](API\Runtime\Core\Misc\FGuid) &BulkDataId)> Visitor ) const
[]
FBuildDefinition::Load
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Load a build definition from compact binary. A valid build definition, or null on error.
DerivedDataCache
static [FOptionalBuildDefinition](API\Developer\DerivedDataCache\FOptionalBuildDefinition) Load ( const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & Name, [FCbObject](API\Runtime\Core\Serialization\FCbObject) && Definition )
[]
FBuildDefinition::IterateInputHashes
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Visits every input hash in order by key. The key view is valid for the lifetime of the definition.
DerivedDataCache
void IterateInputHashes ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, const [FIoHash](API\Runtime\Core\IO\FIoHash) &RawHash)> Visitor ) const
[]
FBuildDefinition::Save
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Saves the build definition to a compact binary object. Calls BeginObject and EndObject.
DerivedDataCache
void Save ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer ) const
[]
FBuildDefinition
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
FBuildSession
DerivedDataCache
class FBuildDefinition
[]
FBuildDefinitionBuilder::AddConstant
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Add a constant object with a key that is unique within this definition.
DerivedDataCache
void AddConstant ( FUtf8StringView Key, const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & Value )
[]
FBuildDefinitionBuilder::AddInputBuild
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Add a value from another build with a key that is unique within this definition.
DerivedDataCache
void AddInputBuild ( FUtf8StringView Key, const [FBuildValueKey](API\Developer\DerivedDataCache\FBuildValueKey) & ValueKey )
[]
FBuildDefinitionBuilder::AddInputBulkData
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Add a bulk data input with a key that is unique within this definition.
DerivedDataCache
void AddInputBulkData ( FUtf8StringView Key, const [FGuid](API\Runtime\Core\Misc\FGuid) & BulkDataId )
[]
FBuildDefinitionBuilder::AddInputFile
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Add a file input with a key that is unique within this definition.
DerivedDataCache
void AddInputFile ( FUtf8StringView Key, FUtf8StringView Path )
[]
FBuildDefinitionBuilder::AddInputHash
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Add a hash input with a key that is unique within this definition.
DerivedDataCache
void AddInputHash ( FUtf8StringView Key, const [FIoHash](API\Runtime\Core\IO\FIoHash) & RawHash )
[]
FBuildDefinitionBuilder::Build
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
Build a build definition, which makes this builder subsequently unusable.
DerivedDataCache
[FBuildDefinition](API\Developer\DerivedDataCache\FBuildDefinition) Build()
[]
FBuildDefinitionBuilder
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildDefinition.h
FBuildDefinition
DerivedDataCache
class FBuildDefinitionBuilder
[]
FBuildInputDataByKey
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
Data for build inputs with the input key.
DerivedDataCache
struct FBuildInputDataByKey
[ { "type": "FCompressedBuff...", "name": "Data", "description": "Data for the input." }, { "type": "FUtf8StringView", "name": "Key", "description": "Key used to identify this input." } ]
FBuildInputDataResolvedParams
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
Parameters for the resolved callback for build input data requests.
DerivedDataCache
struct FBuildInputDataResolvedParams
[ { "type": "TConstArrayView...", "name": "Inputs", "description": "All of the requested inputs sorted by raw hash. Only available when Status is Ok." }, { "type": "EStatus", "name": "Status", "description": "Status of the input request." } ]
FBuildInputFilter
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
DerivedDataCache
typedef [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< bool(FUtf8StringView Key)> FBuildInputFilter
[]
FBuildInputMetaByKey
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
Metadata for build inputs with the input key.
DerivedDataCache
struct FBuildInputMetaByKey
[ { "type": "FUtf8StringView", "name": "Key", "description": "Key used to identify this input." }, { "type": "FIoHash", "name": "RawHash", "description": "Hash of the raw (uncompressed) input." }, { "type": "uint64", "name": "RawSize", "description": "Size of the raw (uncompressed) input in bytes." } ]
FBuildInputMetaResolvedParams
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
Parameters for the resolved callback for build input metadata requests.
DerivedDataCache
struct FBuildInputMetaResolvedParams
[ { "type": "TConstArrayView...", "name": "Inputs", "description": "All of the requested inputs sorted by key. Only available when Status is Ok." }, { "type": "EStatus", "name": "Status", "description": "Status of the input request." } ]
FBuildInputs::FindInput
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
Finds an input by key, or a null buffer if not found.
DerivedDataCache
const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & FindInput ( FUtf8StringView Key ) const
[]
FBuildInputs::GetName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
Returns the name by which to identify the inputs for logging and profiling.
DerivedDataCache
const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const
[]
FBuildInputs::IterateInputs
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
Visits every input in order by key. The key view is valid for the lifetime of the inputs.
DerivedDataCache
void IterateInputs ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Key, const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) &Buffer)> Visitor ) const
[]
FBuildInputs
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
FBuildAction
DerivedDataCache
class FBuildInputs
[]
FBuildInputsBuilder::AddInput
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
Add an input with a key that is unique within this input.
DerivedDataCache
void AddInput ( FUtf8StringView Key, const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & Buffer )
[]
FBuildJobCompleteParams
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildJob.h
Parameters for the completion callback for build jobs.
DerivedDataCache
struct FBuildJobCompleteParams
[ { "type": "EBuildStatus", "name": "BuildStatus", "description": "Detailed status of the job." }, { "type": "constFCacheKey...", "name": "CacheKey", "description": "Key for the job in the cache. Empty if the build completes before the key is assigned." }, { "type": "constIBuildJob...", "name": "Job", "description": "Job that is complete." }, { "type": "FBuildOutput&&", "name": "Output", "description": "Output for the job that completed or was canceled." }, { "type": "EStatus", "name": "Status", "description": "Basic status of the job." } ]
FBuildInputsBuilder
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
FBuildInputs
DerivedDataCache
class FBuildInputsBuilder
[]
FBuildInputsBuilder::Build
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputs.h
Build build inputs, which makes this builder subsequently unusable.
DerivedDataCache
[FBuildInputs](API\Developer\DerivedDataCache\FBuildInputs) Build()
[]
FBuildKeyResolvedParams
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildInputResolver.h
Parameters for the resolved callback for build definition requests.
DerivedDataCache
struct FBuildKeyResolvedParams
[ { "type": "FOptionalBuildD...", "name": "Definition", "description": "The resolved build definition. Only available when Status is Ok." }, { "type": "FBuildKey", "name": "Key", "description": "Key for the build definition request that resolved or was canceled." }, { "type": "EStatus", "name": "Status", "description": "Status of the input request." } ]
FBuildKey
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildKey.h
A key that uniquely identifies a build definition.
DerivedDataCache
struct FBuildKey
[ { "type": "FIoHash", "name": "Hash", "description": "" } ]
Empty
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildKey.h
A key with a zero hash.
DerivedDataCache
static const [FBuildKey](API\Developer\DerivedDataCache\FBuildKey) Empty;
[]
FBuildOutput::GetFunction
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the name of the build function that produced this output.
DerivedDataCache
const [FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & GetFunction() const
[]
FBuildOutput::GetLogs
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the logs in the order that they were recorded.
DerivedDataCache
TConstArrayView< [FBuildOutputLog](API\Developer\DerivedDataCache\FBuildOutputLog) > GetLogs() const
[]
FBuildOutput::GetMeta
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the optional metadata.
DerivedDataCache
const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & GetMeta() const
[]
FBuildOutput::GetMessages
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the messages in the order that they were recorded.
DerivedDataCache
TConstArrayView< [FBuildOutputMessage](API\Developer\DerivedDataCache\FBuildOutputMessage) > GetMessages() const
[]
FBuildOutput::GetValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the value matching the ID. Null if no match. Buffer is null if skipped.
DerivedDataCache
const [FValueWithId](API\Developer\DerivedDataCache\FValueWithId) & GetValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id ) const
[]
FBuildOutput::GetName
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the name by which to identify this output for logging and profiling.
DerivedDataCache
const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const
[]
FBuildOutput::GetValues
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns the values in the output in order by ID.
DerivedDataCache
TConstArrayView< [FValueWithId](API\Developer\DerivedDataCache\FValueWithId) > GetValues() const
[]
FBuildOutput::HasError
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns whether the output has any errors.
DerivedDataCache
bool HasError() const
[]
FBuildOutput::HasLogs
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns whether the output has any logs.
DerivedDataCache
bool HasLogs() const
[]
FBuildOutput::Load
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Load a build output. A valid build output, or null on error.
DerivedDataCache
static [FOptionalBuildOutput](API\Developer\DerivedDataCache\FOptionalBuildOutput) Load ( const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & Name, const [FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & Function, const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & Output )
[]
FBuildOutput::Load
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Load a build output. A valid build output, or null on error.
DerivedDataCache
static [FOptionalBuildOutput](API\Developer\DerivedDataCache\FOptionalBuildOutput) Load ( const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & Name, const [FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & Function, const [FCacheRecord](API\Developer\DerivedDataCache\FCacheRecord) & Output )
[]
FBuildOutput::Save
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Saves the build output to a compact binary object with values as attachments.
DerivedDataCache
void Save ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer ) const
[]
FBuildOutput::Save
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Saves the build output to a cache record.
DerivedDataCache
void Save ( [FCacheRecordBuilder](API\Developer\DerivedDataCache\FCacheRecordBuilder) & RecordBuilder ) const
[]
FBuildOutput
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
No constructors are accessible with public or protected access.
DerivedDataCache
class FBuildOutput
[]
FBuildOutputBuilder::AddLog
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Add a log to the output.
DerivedDataCache
void AddLog ( const [FBuildOutputLog](API\Developer\DerivedDataCache\FBuildOutputLog) & Log )
[]
FBuildOutputBuilder::AddMessage
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Add a message to the output.
DerivedDataCache
void AddMessage ( const [FBuildOutputMessage](API\Developer\DerivedDataCache\FBuildOutputMessage) & Message )
[]
FBuildOutputBuilder::AddValue
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Add a value to the output. The ID must be unique in this output.
DerivedDataCache
void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FValue](API\Developer\DerivedDataCache\FValue) & Value )
[]
FBuildOutputBuilder::Build
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Build a build output, which makes this builder subsequently unusable.
DerivedDataCache
[FBuildOutput](API\Developer\DerivedDataCache\FBuildOutput) Build()
[]
FBuildOutputBuilder::HasError
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Returns whether the output has any errors.
DerivedDataCache
bool HasError() const
[]
FBuildOutputBuilder::SetMeta
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
Set the metadata for the output. Holds a reference and is cloned if not owned.
DerivedDataCache
void SetMeta ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) && Meta )
[]
FBuildOutputBuilder
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
FBuildOutput
DerivedDataCache
class FBuildOutputBuilder
[]
FBuildOutputLog
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
The build function may capture every log above a certain level of verbosity, which means these have no guarantee of being deterministic. The presence of any output logs will disable caching of the build output. To allow caching of build output with warnings or errors, replace the log statements with build messages that are added to the build context.
DerivedDataCache
struct FBuildOutputLog
[ { "type": "FUtf8StringView", "name": "Category", "description": "" }, { "type": "EBuildOutputLog...", "name": "Level", "description": "" }, { "type": "FUtf8StringView", "name": "Message", "description": "" } ]
FBuildOutputMessage
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h
A build output message is diagnostic output from a build function and must be deterministic.
DerivedDataCache
struct FBuildOutputMessage
[ { "type": "EBuildOutputMes...", "name": "Level", "description": "" }, { "type": "FUtf8StringView", "name": "Message", "description": "" } ]
FBuildPolicy::GetCombinedPolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns the build policy combined from the value policies.
DerivedDataCache
[EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) GetCombinedPolicy() const
[]
FBuildPolicy::GetDefaultPolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns the build policy to use for values with no override.
DerivedDataCache
[EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) GetDefaultPolicy() const
[]
FBuildPolicy::GetValuePolicies
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns the array of build policy overrides for values, sorted by ID.
DerivedDataCache
TConstArrayView< [FBuildValuePolicy](API\Developer\DerivedDataCache\FBuildValuePolicy) > GetValuePolicies() const
[]
FBuildPolicy::GetValuePolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns the build policy to use for the value.
DerivedDataCache
[EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) GetValuePolicy ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id ) const
[]
FBuildPolicy::IsUniform
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns true if every value uses the same build policy.
DerivedDataCache
bool IsUniform() const
[]
FBuildPolicy::Transform
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Returns a copy of this policy transformed by an operation.
DerivedDataCache
[FBuildPolicy](API\Developer\DerivedDataCache\FBuildPolicy) Transform ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< [EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy)([EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy))> Op ) const
[]
FBuildPolicy::FBuildPolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Construct a build policy that uses the default policy.
DerivedDataCache
FBuildPolicy()
[]
FBuildPolicy::FBuildPolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Construct a build policy with a single policy for every value.
DerivedDataCache
FBuildPolicy ( [EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) Policy )
[]
FBuildPolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Flags to control the behavior of build requests, with optional overrides by value.
DerivedDataCache
class FBuildPolicy
[]
FBuildPolicyBuilder::AddValuePolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
Adds a build policy override for a value.
DerivedDataCache
void AddValuePolicy ( const [FBuildValuePolicy](API\Developer\DerivedDataCache\FBuildValuePolicy) & Value )
[]
FBuildPolicyBuilder::AddValuePolicy
/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h
DerivedDataCache
void AddValuePolicy ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, [EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) Policy )
[]