UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::AssetRegistry::Premade::FAsyncConsumer Struct Reference

#include <AssetRegistryImpl.h>

Public Member Functions

 ~FAsyncConsumer ()
 
void PrepareForConsume ()
 
void Wait (FInterfaceWriteScopeLock &ScopeLock)
 
void Consume (UAssetRegistryImpl &UARI, UE::AssetRegistry::Impl::FEventContext &EventContext, ELoadResult LoadResult, FAssetRegistryState &&ARState)
 

Detailed Description

A struct to consume a Premade asset registry on an async thread. It supports a cheap Wait() call so that it can be Waited on by frequent AssetRegistry interface calls for the rest of the process.

Constructor & Destructor Documentation

◆ ~FAsyncConsumer()

UE::AssetRegistry::Premade::FAsyncConsumer::~FAsyncConsumer ( )

Member Function Documentation

◆ Consume()

void UE::AssetRegistry::Premade::FAsyncConsumer::Consume ( UAssetRegistryImpl UARI,
UE::AssetRegistry::Impl::FEventContext EventContext,
ELoadResult  LoadResult,
FAssetRegistryState &&  ARState 
)

Callback from the async thread to consume the Premade ARState

◆ PrepareForConsume()

void UE::AssetRegistry::Premade::FAsyncConsumer::PrepareForConsume ( )

Sets the Consumer into need-to-wait mode; Wait will block until Consume is called.

◆ Wait()

void UE::AssetRegistry::Premade::FAsyncConsumer::Wait ( FInterfaceWriteScopeLock ScopeLock)

Does not return until after the Premade AssetRegistryState has been added into the target AssetRegistry, or it has been decided not to be used. For performance reasons, this must be called within the WriteScopeLock, and the caller must handle the possibility that it leaves and reenters the lock.


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