UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FDerivedDataIoBatch Class Reference

#include <DerivedData.h>

Public Member Functions

void Reset ()
 
bool IsEmpty () const
 
UE_API FDerivedDataIoRequest Read (const FDerivedData &Data, const FDerivedDataIoOptions &Options={})
 
UE_API FDerivedDataIoRequest Cache (const FDerivedData &Data, const FDerivedDataIoOptions &Options={})
 
UE_API FDerivedDataIoRequest Exists (const FDerivedData &Data, const FDerivedDataIoOptions &Options={})
 
UE_API void Dispatch (FDerivedDataIoResponse &OutResponse)
 
UE_API void Dispatch (FDerivedDataIoResponse &OutResponse, FDerivedDataIoPriority Priority)
 
UE_API void Dispatch (FDerivedDataIoResponse &OutResponse, FDerivedDataIoPriority Priority, FDerivedDataIoComplete &&OnComplete)
 
UE_API void Dispatch (FDerivedDataIoResponse &OutResponse, FDerivedDataIoComplete &&OnComplete)
 

Detailed Description

Batch of requests to access Derived Data References.

Gather related requests into a batch before issuing it to reduce the overhead of accessing related data.

Member Function Documentation

◆ Cache()

FDerivedDataIoRequest UE::FDerivedDataIoBatch::Cache ( const FDerivedData Data,
const FDerivedDataIoOptions Options = {} 
)

Caches the derived data into local storage without loading it. Not executed until Dispatch() is invoked.

The size and status will be available on the response. Status is Ok if it caches and Error if not.

Returns
A request to query the response with. May be discarded by the caller if not needed.

◆ Dispatch() [1/4]

void UE::FDerivedDataIoBatch::Dispatch ( FDerivedDataIoResponse OutResponse)

Dispatches the requests that have been queued to this batch and resets this batch to empty.

The response must be kept alive until the batch completes, otherwise it will be automatically canceled.

Parameters
OutResponseResponse that is assigned before any requests begin executing.
PriorityPriority of this batch relative to other batches.
OnCompleteCompletion callback invoked when the entire batch is complete or canceled.

◆ Dispatch() [2/4]

void UE::FDerivedDataIoBatch::Dispatch ( FDerivedDataIoResponse OutResponse,
FDerivedDataIoComplete &&  OnComplete 
)

◆ Dispatch() [3/4]

void UE::FDerivedDataIoBatch::Dispatch ( FDerivedDataIoResponse OutResponse,
FDerivedDataIoPriority  Priority 
)

◆ Dispatch() [4/4]

void UE::FDerivedDataIoBatch::Dispatch ( FDerivedDataIoResponse OutResponse,
FDerivedDataIoPriority  Priority,
FDerivedDataIoComplete &&  OnComplete 
)

◆ Exists()

FDerivedDataIoRequest UE::FDerivedDataIoBatch::Exists ( const FDerivedData Data,
const FDerivedDataIoOptions Options = {} 
)

Caches the derived data into local storage without loading it. Not executed until Dispatch() is invoked.

The size and status will be available on the response. Status is Ok if it exists and Error if not.

Returns
A request to query the response with. May be discarded by the caller if not needed.

◆ IsEmpty()

bool UE::FDerivedDataIoBatch::IsEmpty ( ) const
inline

Returns true if this batch has no queued requests.

◆ Read()

FDerivedDataIoRequest UE::FDerivedDataIoBatch::Read ( const FDerivedData Data,
const FDerivedDataIoOptions Options = {} 
)

Reads the derived data into memory. Not executed until Dispatch() is invoked.

The data, size, and status will be available on the response.

Returns
A request to query the response with. May be discarded by the caller if not needed.

◆ Reset()

void UE::FDerivedDataIoBatch::Reset ( )
inline

Resets this to an empty batch.


The documentation for this class was generated from the following files: