FRenderAssetUpdate | Unreal Engine 5.6 Documentation

Inheritance Hierarchy

References


Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/RenderAssetUpdate.h
Include	#include "RenderAssetUpdate.h"

Syntax

class FRenderAssetUpdate : public IRefCountedObject

Remarks

This class provides a framework for loading and unloading the texture/mesh LODs. Each thread essentially calls Tick() until the job is done. The object can be safely deleted when IsCompleted() returns true.

Variables

Type	Name	Description
bool	bDeferExecution	Defer execution even if a task pushes a new task on the same thread.
bool	bIsCancelled	Whether the task has been cancelled because the update could not proceed or because the user called Abort().
bool	bSuccess	Whether this update finished successfully. True means that it is TS_Done and not cancelled mid way.
FCriticalSection	CS	Critical Section.
const int32	CurrentFirstLODIdx	The resident first LOD resource index. With domain = [0, ResourceState.NumLODs[. NOT THE ASSET LOD INDEX!
const int32	PendingFirstLODIdx	The requested first LOD resource index. With domain = [0, ResourceState.NumLODs[. NOT THE ASSET LOD INDEX!
const FStreamableRenderResourceState	ResourceState	The streamable state requested.
int32	ScheduledAsyncTasks	Number of Ticks scheduled on async tasks.
int32	ScheduledGTTasks	Number of Ticks scheduled on the game thread.
int32	ScheduledRenderTasks	Number of Ticks scheduled on the render thread.
const UStreamableRenderAsset *	StreamableAsset	The asset updated
volatile ETaskState	TaskState	The state of the work yet to be performed to complete the update or cancelation.
FThreadSafeCounter	TaskSynchronization	Synchronization used for trigger the task next step execution.

Constructors

	Type	Name	Description
		FRenderAssetUpdate ( const UStreamableRenderAsset* InAsset )

Destructors

	Type	Name	Description
		~FRenderAssetUpdate ()

Functions

Type	Name	Description
void	Abort ()	Cancel the current update.
ETaskState	DoLock ()	Perform a lock on the object, preventing any other thread from processing a pending task in Tick().
void	DoUnlock ( ETaskState PreviousTaskState )	Release any lock on the object, allowing other thread to modify it.
EThreadType	GetRelevantThread ()	Return the thread relevant to the next step of execution.
bool	IsCancelled ()	Returns whether the task was aborted through Abort() or cancelled.
bool	IsCompleted ()	Returns whether the task has finished executing and there is no other thread possibly accessing it.
bool	IsLocked ()
bool	IsSuccessfullyFinished ()	Returns whether this update has finished successfully.
void	MarkAsCancelled ()	Set the task state as cancelled.
void	MarkAsSuccessfullyFinished ()
void	ScheduleAsyncTask ()
void	ScheduleGTTask ()
void	ScheduleRenderTask ()
void	Tick ( EThreadType InCurrentThread )	Do or schedule any pending work for a given texture.
ETaskState	TickInternal ( EThreadType InCurrentThread, bool bCheckForSuspension )