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
|
---|---|---|---|---|---|
FBuildPolicyBuilder::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h | Build a build policy, which makes this builder subsequently unusable. | DerivedDataCache | [FBuildPolicy](API\Developer\DerivedDataCache\FBuildPolicy) Build() | [] |
FBuildPolicyBuilder::FBuildPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h | Construct a policy builder that uses the default policy. | DerivedDataCache | FBuildPolicyBuilder() | [] |
FBuildPolicyBuilder::FBuildPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h | Construct a policy builder that uses the provided policy for values with no override. | DerivedDataCache | FBuildPolicyBuilder ( [EBuildPolicy](API\Developer\DerivedDataCache\UE__DerivedData__EBuildPolicy) Policy ) | [] |
FBuildSchedulerParams | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildScheduler.h | Parameters that describe a build job to the build scheduler. | DerivedDataCache | struct FBuildSchedulerParams | [
{
"type": "FBuildActionKey",
"name": "Key",
"description": "Available from the CacheQuery state onward."
},
{
"type": "uint64",
"name": "MissingLocalInputsSize",
"description": "Total size of inputs that need to be resolved for local execution. Available in ResolveInputData."
},
{
"type": "uint64",
"name": "MissingRemoteInputsSize",
"description": "Total size of inputs that need to be resolved for remote execution. Available in ResolveInputData."
},
{
"type": "uint64",
"name": "ResolvedInputsSize",
"description": "Total size of constants and resolved inputs that are in memory now."
},
{
"type": "uint64",
"name": "TotalInputsSize",
"description": "Total size of constants and inputs, whether resolved or not."
},
{
"type": "uint64",
"name": "TotalRequiredMemory",
"description": "Estimate of the peak memory required to execute the build, including constants and inputs."
},
{
"type": "FUtf8SharedStri...",
"name": "TypeName",
"description": "Type name from the build function for the job. Available from the CacheQuery state onward."
}
] |
FBuildPolicyBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h | A build policy builder is used to construct a build policy. | DerivedDataCache | class FBuildPolicyBuilder | [] |
FBuildSession::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildSession.h | The callback will always be called, and may be called from an arbitrary thread. | DerivedDataCache | void Build ( const [FBuildKey](API\Developer\DerivedDataCache\FBuildKey) & Key, const [FBuildPolicy](API\Developer\DerivedDataCache\FBuildPolicy) & Policy, [IRequestOwner](API\Developer\DerivedDataCache\IRequestOwner) & Owner, [FOnBuildComplete](API\Developer\DerivedDataCache\FOnBuildComplete) && OnComplete ) | [] |
FBuildSession::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildSession.h | The callback will always be called, and may be called from an arbitrary thread. | DerivedDataCache | void Build ( const [FBuildDefinition](API\Developer\DerivedDataCache\FBuildDefinition) & Definition, const [FOptionalBuildInputs](API\Developer\DerivedDataCache\FOptionalBuildInputs) & Inputs, const [FBuildPolicy](API\Developer\DerivedDataCache\FBuildPolicy) & Policy, [IRequestOwner](API\Developer\DerivedDataCache\IRequestOwner) & Owner, [FOnBuildComplete](API\Developer\DerivedDataCache\FOnBuildComplete) && OnComplete ) | [] |
FBuildSession::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildSession.h | The callback will always be called, and may be called from an arbitrary thread. | DerivedDataCache | void Build ( const [FBuildAction](API\Developer\DerivedDataCache\FBuildAction) & Action, const [FOptionalBuildInputs](API\Developer\DerivedDataCache\FOptionalBuildInputs) & Inputs, const [FBuildPolicy](API\Developer\DerivedDataCache\FBuildPolicy) & Policy, [IRequestOwner](API\Developer\DerivedDataCache\IRequestOwner) & Owner, [FOnBuildComplete](API\Developer\DerivedDataCache\FOnBuildComplete) && OnComplete ) | [] |
FBuildSession::GetName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildSession.h | Returns the name by which to identify this session for logging and profiling. | DerivedDataCache | const [FSharedString](API\Runtime\CoreUObject\Serialization\FSharedString) & GetName() const | [] |
FBuildSession | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildSession.h | No constructors are accessible with public or protected access. | DerivedDataCache | class FBuildSession | [] |
Empty | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildKey.h | A value key with an empty build key and a null value identifier. | DerivedDataCache | static const [FBuildValueKey](API\Developer\DerivedDataCache\FBuildValueKey) Empty; | [] |
FBuildValueKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildKey.h | A key that uniquely identifies a value within a build output. | DerivedDataCache | struct FBuildValueKey | [
{
"type": "FBuildKey",
"name": "BuildKey",
"description": ""
},
{
"type": "FValueId",
"name": "Id",
"description": ""
}
] |
FBuildValuePolicy | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildTypes.h | A value ID and the build policy to use for that value. | DerivedDataCache | struct FBuildValuePolicy | [
{
"type": "FValueId",
"name": "Id",
"description": ""
},
{
"type": "EBuildPolicy",
"name": "Policy",
"description": ""
}
] |
FBuildVersionBuilder::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | DerivedDataCache | [FGuid](API\Runtime\Core\Misc\FGuid) Build() const | [] |
|
FBuildVersionBuilder::GetArchiveName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | This is overridden for the specific Archive Types | DerivedDataCache | virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const | [] |
FBuildVersionBuilder::operator<< | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | This operator can be implemented by sub-classes that wish to serializeFNameinstances.
This instance. | DerivedDataCache | virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FName](API\Runtime\Core\UObject\FName) & Value ) | [] |
FBuildVersionBuilder::operator<< | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | DerivedDataCache | template<typename ArgType> [FBuildVersionBuilder](API\Developer\DerivedDataCache\FBuildVersionBuilder) & operator<< ( ArgType && Arg ) | [] |
|
FBuildVersionBuilder::Serialize | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | DerivedDataCache | virtual void Serialize ( void * Data, int64 Num ) | [] |
|
FBuildVersionBuilder::FBuildVersionBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | DerivedDataCache | FBuildVersionBuilder() | [] |
|
FBuildVersionBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildVersion.h | FGuidGetVersion() const final {FBuildVersionBuilderBuilder; Builder <<FGuid(TEXT("a3ae79ff-6a89-4124-afd6-dc095e000488")); Builder << ThirdPartyLibraryVersion; returnBuilder.Build(); } | DerivedDataCache | class FBuildVersionBuilder : public [FArchive](API\Runtime\Core\Serialization\FArchive) | [] |
FBuildWorker::GetHostPlatform | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | FStringView GetHostPlatform() const | [] |
|
FBuildWorker::GetBuildSystemVersion | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | [FGuid](API\Runtime\Core\Misc\FGuid) GetBuildSystemVersion() const | [] |
|
FBuildWorker::GetName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | FStringView GetName() const | [] |
|
FBuildWorker::FindFileData | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void FindFileData ( TConstArrayView< [FIoHash](API\Runtime\Core\IO\FIoHash) > RawHashes, [IRequestOwner](API\Developer\DerivedDataCache\IRequestOwner) & Owner, [FOnBuildWorkerFileDataComplete](API\Developer\DerivedDataCache\FOnBuildWorkerFileDataComplete) && OnComplete ) const | [] |
|
FBuildWorker::GetPath | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | FStringView GetPath() const | [] |
|
FBuildWorker::IterateEnvironment | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void IterateEnvironment ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FStringView Name, FStringViewValue)> Visitor ) const | [] |
|
FBuildWorker::IterateFiles | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void IterateFiles ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FStringView Path, const [FIoHash](API\Runtime\Core\IO\FIoHash) &RawHash, uint64 RawSize)> Visitor ) const | [] |
|
FBuildWorker::IterateExecutables | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void IterateExecutables ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FStringView Path, const [FIoHash](API\Runtime\Core\IO\FIoHash) &RawHash, uint64 RawSize)> Visitor ) const | [] |
|
FBuildWorker::IterateFunctions | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void IterateFunctions ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(FUtf8StringView Name, const [FGuid](API\Runtime\Core\Misc\FGuid) &Version)> Visitor ) const | [] |
|
FBuildWorker::~FBuildWorker | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | virtual ~FBuildWorker() | [] |
|
FBuildWorker | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | class FBuildWorker | [] |
|
FBuildWorkerActionCompleteParams | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | struct FBuildWorkerActionCompleteParams | [
{
"type": "FBuildActionKey",
"name": "Key",
"description": ""
},
{
"type": "TConstArrayView...",
"name": "MissingInputs",
"description": ""
},
{
"type": "FOptionalBuildO...",
"name": "Output",
"description": ""
},
{
"type": "EStatus",
"name": "Status",
"description": ""
}
] |
|
FBuildWorkerBuilder::AddExecutable | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void AddExecutable ( FStringView Path, const [FIoHash](API\Runtime\Core\IO\FIoHash) & RawHash, uint64 RawSize ) | [] |
|
FBuildWorkerBuilder::AddFile | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void AddFile ( FStringView Path, const [FIoHash](API\Runtime\Core\IO\FIoHash) & RawHash, uint64 RawSize ) | [] |
|
FBuildWorkerBuilder::AddFunction | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void AddFunction ( FUtf8StringView Name, const [FGuid](API\Runtime\Core\Misc\FGuid) & Version ) | [] |
|
FBuildWorkerBuilder::SetBuildSystemVersion | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void SetBuildSystemVersion ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Version ) | [] |
|
FBuildWorkerBuilder::SetEnvironment | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void SetEnvironment ( FStringView Name, FStringView Value ) | [] |
|
FBuildWorkerBuilder::SetHostPlatform | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void SetHostPlatform ( FStringView Name ) | [] |
|
FBuildWorkerBuilder::SetName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void SetName ( FStringView Name ) | [] |
|
FBuildWorkerBuilder::SetPath | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | void SetPath ( FStringView Path ) | [] |
|
FBuildWorkerBuilder::~FBuildWorkerBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | virtual ~FBuildWorkerBuilder() | [] |
|
FBuildWorkerBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | class FBuildWorkerBuilder | [] |
|
FBuildWorkerFileDataCompleteParams | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildWorker.h | DerivedDataCache | struct FBuildWorkerFileDataCompleteParams | [
{
"type": "TConstArrayView...",
"name": "Files",
"description": ""
},
{
"type": "EStatus",
"name": "Status",
"description": ""
}
] |
|
FCacheBucket::IsNull | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Whether this is null. | DerivedDataCache | bool IsNull() const | [] |
FCacheBucket::IsValid | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Whether this is not null. | DerivedDataCache | bool IsValid() const | [] |
FCacheBucket::IsValidName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Returns true if the name is a valid cache bucket name. | DerivedDataCache | template<typename CharType> static bool IsValidName ( [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > Name ) | [] |
LengthOffset | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | DerivedDataCache | static constexpr int32 LengthOffset = -1; | [] |
|
MaxNameLen | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Maximum number of code units in a valid cache bucket name. | DerivedDataCache | static constexpr int32 MaxNameLen = 63; | [] |
FCacheBucket::operator== | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | DerivedDataCache | bool operator== ( [FCacheBucket](API\Developer\DerivedDataCache\FCacheBucket) Other ) const | [] |
|
FCacheBucket::operator< | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | DerivedDataCache | bool operator< ( [FCacheBucket](API\Developer\DerivedDataCache\FCacheBucket) Other ) const | [] |
|
FCacheBucket::operator!= | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | DerivedDataCache | bool operator!= ( [FCacheBucket](API\Developer\DerivedDataCache\FCacheBucket) Other ) const | [] |
|
FCacheBucket::Reset | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Reset this to null. | DerivedDataCache | void Reset() | [] |
FCacheBucket::ToCString | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Get the name of the cache bucket as a null-terminated string. | DerivedDataCache | const ANSICHAR * ToCString() const | [] |
FCacheBucket::ToDisplayName | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Append the display name if available or the bucket name if not. | DerivedDataCache | void ToDisplayName ( FStringBuilderBase & OutDisplayName ) const | [] |
FCacheBucket::ToString | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Get the name of the cache bucket as a string. | DerivedDataCache | FAnsiStringView ToString() const | [] |
FCacheBucket::FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Construct a null cache bucket. | DerivedDataCache | FCacheBucket() | [] |
FCacheBucket::FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Create a cache bucket from a name. | DerivedDataCache | FCacheBucket ( FUtf8StringView Name ) | [] |
FCacheBucket::FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Construct a null cache bucket. | DerivedDataCache | FCacheBucket ( FWideStringView Name ) | [] |
FCacheBucket::FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | Create a cache bucket from a name and a display name. | DerivedDataCache | FCacheBucket ( FUtf8StringView Name, FStringView DisplayName ) | [] |
FCacheBucket::FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | DerivedDataCache | FCacheBucket ( FWideStringView Name, FStringView DisplayName ) | [] |
|
FCacheGetChunkRequest::MakeResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Make a default response for this request, with the provided status. | DerivedDataCache | [FCacheGetChunkResponse](API\Developer\DerivedDataCache\FCacheGetChunkResponse) MakeResponse ( [EStatus](API\Developer\DerivedDataCache\UE__DerivedData__EStatus) Status ) const | [] |
FCacheBucket | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | A cache bucket name must be alphanumeric, non-empty, and contain fewer than 64 code units. | DerivedDataCache | class FCacheBucket | [
{
"type": "const ANSICHAR ...",
"name": "Name",
"description": "Name stored as a null-terminated string preceded by one byte containing its length."
}
] |
FCacheGetChunkRequest | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters to request a chunk, which is a subset of a value, from a cache record or cache value. | DerivedDataCache | struct FCacheGetChunkRequest | [
{
"type": "FValueId",
"name": "Id",
"description": "An ID identifying the value to fetch, if fetching from a record, otherwise null."
},
{
"type": "FCacheKey",
"name": "Key",
"description": "A key identifying the record or value to fetch the chunk from."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A name to identify this request for logging and profiling. An object path is typically sufficient."
},
{
"type": "ECachePolicy",
"name": "Policy",
"description": "Flags to control the behavior of the request. See ECachePolicy."
},
{
"type": "FIoHash",
"name": "RawHash",
"description": "The raw hash of the entire value to fetch, if available, otherwise zero."
},
{
"type": "uint64",
"name": "RawOffset",
"description": "The offset into the raw bytes of the value at which to start fetching."
},
{
"type": "uint64",
"name": "RawSize",
"description": "The maximum number of raw bytes of the value to fetch, starting from the offset."
},
{
"type": "uint64",
"name": "UserData",
"description": "A value that will be returned in the completion callback."
}
] |
FCacheGetChunkResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters for the completion callback for cache chunk requests. | DerivedDataCache | struct FCacheGetChunkResponse | [
{
"type": "FValueId",
"name": "Id",
"description": "A copy of the ID from the request."
},
{
"type": "FCacheKey",
"name": "Key",
"description": "A copy of the key from the request."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A copy of the name from the request."
},
{
"type": "FSharedBuffer",
"name": "RawData",
"description": "Data for the subset of the value that was fetched when Status is Ok, otherwise null."
},
{
"type": "FIoHash",
"name": "RawHash",
"description": "The hash of the entire value, even if only a subset was fetched."
},
{
"type": "uint64",
"name": "RawOffset",
"description": "A copy of the offset from the request."
},
{
"type": "uint64",
"name": "RawSize",
"description": "The size, in bytes, of the subset of the value that was fetched, if any."
},
{
"type": "EStatus",
"name": "Status",
"description": "The status of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A copy of the value from the request."
}
] |
FCacheGetRequest::MakeResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Make a default response for this request, with the provided status. | DerivedDataCache | [FCacheGetResponse](API\Developer\DerivedDataCache\FCacheGetResponse) MakeResponse ( [EStatus](API\Developer\DerivedDataCache\UE__DerivedData__EStatus) Status ) const | [] |
FCacheGetRequest | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters to request to get a cache record. | DerivedDataCache | struct FCacheGetRequest | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A key identifying the record to fetch."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A name to identify this request for logging and profiling. An object path is typically sufficient."
},
{
"type": "FCacheRecordPol...",
"name": "Policy",
"description": "Flags to control the behavior of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A value that will be returned in the completion callback."
}
] |
FCacheGetResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters for the completion callback for cache get requests. | DerivedDataCache | struct FCacheGetResponse | [
{
"type": "FSharedString",
"name": "Name",
"description": "A copy of the name from the request."
},
{
"type": "FCacheRecord",
"name": "Record",
"description": "Record for the request that completed or was canceled."
},
{
"type": "EStatus",
"name": "Status",
"description": "The status of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A copy of the value from the request."
}
] |
FCacheGetValueRequest::MakeResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Make a default response for this request, with the provided status. | DerivedDataCache | [FCacheGetValueResponse](API\Developer\DerivedDataCache\FCacheGetValueResponse) MakeResponse ( [EStatus](API\Developer\DerivedDataCache\UE__DerivedData__EStatus) Status ) const | [] |
FCacheGetValueRequest | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters to request to get a cache value. | DerivedDataCache | struct FCacheGetValueRequest | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A key identifying the value to fetch."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A name to identify this request for logging and profiling. An object path is typically sufficient."
},
{
"type": "ECachePolicy",
"name": "Policy",
"description": "Flags to control the behavior of the request. See ECachePolicy."
},
{
"type": "uint64",
"name": "UserData",
"description": "A value that will be returned in the completion callback."
}
] |
FCacheGetValueResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters for the completion callback for cache value get requests. | DerivedDataCache | struct FCacheGetValueResponse | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A copy of the key from the request."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A copy of the name from the request."
},
{
"type": "EStatus",
"name": "Status",
"description": "The status of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A copy of the value from the request."
},
{
"type": "FValue",
"name": "Value",
"description": "Value for the request that completed or was canceled."
}
] |
Empty | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | A key with a null bucket and a zero hash. | DerivedDataCache | static const [FCacheKey](API\Developer\DerivedDataCache\FCacheKey) Empty; | [] |
FCacheKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheKey.h | A key that uniquely identifies a cache record. | DerivedDataCache | struct FCacheKey | [
{
"type": "FCacheBucket",
"name": "Bucket",
"description": ""
},
{
"type": "FIoHash",
"name": "Hash",
"description": ""
}
] |
FCachePutRequest::MakeResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Make a default response for this request, with the provided status. | DerivedDataCache | [FCachePutResponse](API\Developer\DerivedDataCache\FCachePutResponse) MakeResponse ( [EStatus](API\Developer\DerivedDataCache\UE__DerivedData__EStatus) Status ) const | [] |
FCachePutRequest | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters to request to put a cache record. | DerivedDataCache | struct FCachePutRequest | [
{
"type": "FSharedString",
"name": "Name",
"description": "A name to identify this request for logging and profiling. An object path is typically sufficient."
},
{
"type": "FCacheRecordPol...",
"name": "Policy",
"description": "Flags to control the behavior of the request."
},
{
"type": "FCacheRecord",
"name": "Record",
"description": "A record to store."
},
{
"type": "uint64",
"name": "UserData",
"description": "A value that will be returned in the completion callback."
}
] |
FCachePutResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters for the completion callback for cache put requests. | DerivedDataCache | struct FCachePutResponse | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A copy of the key from the request."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A copy of the name from the request."
},
{
"type": "EStatus",
"name": "Status",
"description": "The status of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A copy of the value from the request."
}
] |
FCachePutValueRequest::MakeResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Make a default response for this request, with the provided status. | DerivedDataCache | [FCachePutValueResponse](API\Developer\DerivedDataCache\FCachePutValueResponse) MakeResponse ( [EStatus](API\Developer\DerivedDataCache\UE__DerivedData__EStatus) Status ) const | [] |
FCachePutValueRequest | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters to request to put a cache value. | DerivedDataCache | struct FCachePutValueRequest | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A key that will uniquely identify the value in the cache."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A name to identify this request for logging and profiling. An object path is typically sufficient."
},
{
"type": "ECachePolicy",
"name": "Policy",
"description": "Flags to control the behavior of the request. See ECachePolicy."
},
{
"type": "uint64",
"name": "UserData",
"description": "A value that will be returned in the completion callback."
},
{
"type": "FValue",
"name": "Value",
"description": "A value to store."
}
] |
FCachePutValueResponse | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCache.h | Parameters for the completion callback for cache value put requests. | DerivedDataCache | struct FCachePutValueResponse | [
{
"type": "FCacheKey",
"name": "Key",
"description": "A copy of the key from the request."
},
{
"type": "FSharedString",
"name": "Name",
"description": "A copy of the name from the request."
},
{
"type": "EStatus",
"name": "Status",
"description": "The status of the request."
},
{
"type": "uint64",
"name": "UserData",
"description": "A copy of the value from the request."
}
] |
FCacheRecord::GetKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Returns the key that identifies this record in the cache. | DerivedDataCache | const [FCacheKey](API\Developer\DerivedDataCache\FCacheKey) & GetKey() const | [] |
FCacheRecord::GetMeta | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Returns the metadata. Null when requested withECachePolicy::SkipMeta. | DerivedDataCache | const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & GetMeta() const | [] |
FCacheRecord::GetValue | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Returns the value matching the ID. Null if no match. Data is null if skipped. | DerivedDataCache | const [FValueWithId](API\Developer\DerivedDataCache\FValueWithId) & GetValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id ) const | [] |
FCacheRecord::GetValues | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Returns a view of the values ordered by ID. Data is null if skipped. | DerivedDataCache | TConstArrayView< [FValueWithId](API\Developer\DerivedDataCache\FValueWithId) > GetValues() const | [] |
FCacheRecord::Load | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Load a cache record from a compact binary package. Null on error. | DerivedDataCache | static [FOptionalCacheRecord](API\Developer\DerivedDataCache\FOptionalCacheRecord) Load ( const [FCbPackage](API\Runtime\Core\Serialization\FCbPackage) & Package ) | [] |
FCacheRecord::Load | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Load a cache record from a compact binary package. Null on error. | DerivedDataCache | static [FOptionalCacheRecord](API\Developer\DerivedDataCache\FOptionalCacheRecord) Load ( const [FCbPackage](API\Runtime\Core\Serialization\FCbPackage) & Attachments, const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & Object ) | [] |
FCacheRecord::Save | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Save the cache record to a compact binary package. | DerivedDataCache | [FCbPackage](API\Runtime\Core\Serialization\FCbPackage) Save() const | [] |
FCacheRecord::Save | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Append the cache record to an existing package and writer for e.g. a batch of records. | DerivedDataCache | void Save ( [FCbPackage](API\Runtime\Core\Serialization\FCbPackage) & Attachments, [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer ) const | [] |
FCacheRecord | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | No constructors are accessible with public or protected access. | DerivedDataCache | class FCacheRecord | [] |
FCacheRecordBuilder::AddValue | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | The ID for the value must be unique within this cache record. | DerivedDataCache | void AddValue ( const [FValueWithId](API\Developer\DerivedDataCache\FValueWithId) & Value ) | [] |
FCacheRecordBuilder::AddValue | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Add a value to the cache record. | DerivedDataCache | void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FValue](API\Developer\DerivedDataCache\FValue) & Value ) | [] |
FCacheRecordBuilder::AddValue | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Add a value to the cache record. | DerivedDataCache | void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & Buffer, uint64 BlockSize ) | [] |
FCacheRecordBuilder::AddValue | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Add a value to the cache record. | DerivedDataCache | void AddValue ( const [FValueId](API\Developer\DerivedDataCache\FValueId) & Id, const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & Buffer, uint64 BlockSize ) | [] |
FCacheRecordBuilder::Build | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | PreferBuildAsync()when the values are added from raw buffers, which requires compressing those buffers before constructing the cache record. | DerivedDataCache | [FCacheRecord](API\Developer\DerivedDataCache\FCacheRecord) Build() | [] |
FCacheRecordBuilder::BuildAsync | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | PreferBuild()when the values are added from compressed buffers as compression is already complete andBuildAsync()will complete immediately in that case. | DerivedDataCache | void BuildAsync ( [IRequestOwner](API\Developer\DerivedDataCache\IRequestOwner) & Owner, [FOnCacheRecordComplete](API\Developer\DerivedDataCache\FOnCacheRecordComplete) && OnComplete ) | [] |
FCacheRecordBuilder::SetMeta | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Set the metadata for the cache record. | DerivedDataCache | void SetMeta ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) && Meta ) | [] |
FCacheRecordBuilder::FCacheRecordBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | Create a cache record builder from a cache key. | DerivedDataCache | FCacheRecordBuilder ( const [FCacheKey](API\Developer\DerivedDataCache\FCacheKey) & Key ) | [] |
FCacheRecordBuilder | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | FCacheRecord | DerivedDataCache | class FCacheRecordBuilder | [] |
bAllowDuplicateKeys | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | static constexpr bool bAllowDuplicateKeys = false; | [] |
|
ElementInitType | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | typedef const [FCacheRecord](API\Developer\DerivedDataCache\FCacheRecord) & ElementInitType | [] |
|
FCacheRecordKeyFuncs::GetKeyHash | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | static uint32 GetKeyHash ( [KeyInitType](API\Developer\DerivedDataCache\FCacheRecordKeyFuncs\KeyInitType) Key ) | [] |
|
FCacheRecordKeyFuncs::GetSetKey | /Engine/Source/Developer/DerivedDataCache/Public/DerivedDataCacheRecord.h | DerivedDataCache | static [KeyInitType](API\Developer\DerivedDataCache\FCacheRecordKeyFuncs\KeyInitType) GetSetKey ( [ElementInitType](API\Developer\DerivedDataCache\FCacheRecordKeyFuncs\ElementInitType) Record ) | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.