#include <AssetCompilingManager.h>

Public Member Functions
ENGINE_API bool	RegisterManager (IAssetCompilingManager *InAssetCompilingManager)

ENGINE_API bool	UnregisterManager (IAssetCompilingManager *InAssetCompilingManager)

ENGINE_API TArrayView< IAssetCompilingManager *const >	GetRegisteredManagers () const

ENGINE_API int32	GetNumRemainingAssets () const

ENGINE_API void	FinishAllCompilation ()

ENGINE_API void	FinishCompilationForObjects (TArrayView< UObject *const > InObjects)

ENGINE_API void	MarkCompilationAsCanceled (TArrayView< UObject *const > InObjects)

ENGINE_API void	Shutdown ()

ENGINE_API FQueuedThreadPool *	GetThreadPool () const

ENGINE_API void	ProcessAsyncTasks (bool bLimitExecutionTime=false)

ENGINE_API void	ProcessAsyncTasks (const AssetCompilation::FProcessAsyncTaskParams &Params)

FAssetPostCompileEvent &	OnAssetPostCompileEvent ()

	DECLARE_MULTICAST_DELEGATE_TwoParams (FPackageScopeEvent, UPackage *, bool)

FPackageScopeEvent &	OnPackageScopeEvent ()

Static Public Member Functions
static ENGINE_API FAssetCompilingManager &	Get ()

Friends
struct	IAssetCompilingManager

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

FAssetCompilingManager::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FPackageScopeEvent	,
		UPackage *	,
		bool
	)

Event called before and after FinishAllCompilation or ProcessAsyncTasks run operations on a specific package, used for subscribers to associate low-level actions with that Package (e.g. TObjectPtr reads). void OnPackageScopeEvent(UPackage* Package, bool bEntering) Called with bEntering=true followed by actions for Package followed by call with bEntering=false.

◆ FinishAllCompilation()

void FAssetCompilingManager::FinishAllCompilation ( )

Blocks until completion of all assets.

◆ FinishCompilationForObjects()

void FAssetCompilingManager::FinishCompilationForObjects ( TArrayView< UObject *const > InObjects )

Finish compilation of the requested objects.

◆ Get()

FAssetCompilingManager & FAssetCompilingManager::Get ( )

static

◆ GetNumRemainingAssets()

int32 FAssetCompilingManager::GetNumRemainingAssets ( ) const

Returns the number of remaining compilations.

Returns the number of outstanding asset compilations.

◆ GetRegisteredManagers()

TArrayView< IAssetCompilingManager *const > FAssetCompilingManager::GetRegisteredManagers ( ) const

Register the list of registered managers.

◆ GetThreadPool()

FQueuedThreadPool * FAssetCompilingManager::GetThreadPool ( ) const

Returns the thread-pool where asset compilation should be scheduled.

◆ MarkCompilationAsCanceled()

void FAssetCompilingManager::MarkCompilationAsCanceled ( TArrayView< UObject *const > InObjects )

Mark compilation of the provided objects as canceled. This is a hint that the compilations are no longer needed and may leave the objects in a bad state. There is no guarantee that anything will be canceled, but if supported, it might remove heavy CPU work earlier. If you need to make sure that any activity is done on these objects, a call to FinishCompilationForObjects is still required.

Finish compilation of the requested objects.

◆ OnAssetPostCompileEvent()

FAssetPostCompileEvent & FAssetCompilingManager::OnAssetPostCompileEvent ( )

inline

Event called after an asset finishes compilation.

◆ OnPackageScopeEvent()

FPackageScopeEvent & FAssetCompilingManager::OnPackageScopeEvent ( )

inline

◆ ProcessAsyncTasks() [1/2]

void FAssetCompilingManager::ProcessAsyncTasks ( bool bLimitExecutionTime = false )

Called once per frame, fetches completed tasks and applies them to the scene.

◆ ProcessAsyncTasks() [2/2]

void FAssetCompilingManager::ProcessAsyncTasks ( const AssetCompilation::FProcessAsyncTaskParams & Params )

Called once per frame, fetches completed tasks and applies them to the scene.

◆ RegisterManager()

bool FAssetCompilingManager::RegisterManager ( IAssetCompilingManager * InAssetCompilingManager )

Register an asset compiling manager.

◆ Shutdown()

void FAssetCompilingManager::Shutdown ( )

Cancel any pending work and blocks until it is safe to shut down.

◆ UnregisterManager()

bool FAssetCompilingManager::UnregisterManager ( IAssetCompilingManager * InAssetCompilingManager )

Unregister an asset compiling manager.

Friends And Related Symbol Documentation

◆ IAssetCompilingManager

friend struct IAssetCompilingManager

friend

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

Engine/Source/Runtime/Engine/Public/AssetCompilingManager.h
Engine/Source/Runtime/Engine/Private/AssetCompilingManager.cpp

Public Member Functions

Static Public Member Functions

Friends