UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRenderingThread Class Reference
+ Inheritance diagram for FRenderingThread:

Public Member Functions

 FRenderingThread ()
 
virtual ~FRenderingThread ()
 
virtual bool Init (void) override
 
virtual void Exit (void) override
 
void SetupRenderThread ()
 
virtual uint32 Run (void) override
 
- Public Member Functions inherited from FRunnable
virtual void Stop ()
 
virtual class FSingleThreadRunnableGetSingleThreadInterface ()
 
virtual ~FRunnable ()
 

Public Attributes

FEventTaskGraphBoundSyncEvent
 

Detailed Description

The rendering thread runnable object.

Constructor & Destructor Documentation

◆ FRenderingThread()

FRenderingThread::FRenderingThread ( )
inline

◆ ~FRenderingThread()

virtual FRenderingThread::~FRenderingThread ( )
inlinevirtual

Member Function Documentation

◆ Exit()

virtual void FRenderingThread::Exit ( void  )
inlineoverridevirtual

Exits the runnable object.

Called in the context of the aggregating thread to perform any cleanup.

See also
Init, Run, Stop

Reimplemented from FRunnable.

◆ Init()

virtual bool FRenderingThread::Init ( void  )
inlineoverridevirtual

Initializes the runnable object.

This method is called in the context of the thread object that aggregates this, not the thread that passes this runnable to a new thread.

Returns
True if initialization was successful, false otherwise
See also
Run, Stop, Exit

Reimplemented from FRunnable.

◆ Run()

virtual uint32 FRenderingThread::Run ( void  )
inlineoverridevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns
The exit code of the runnable object
See also
Init, Stop, Exit

Implements FRunnable.

◆ SetupRenderThread()

void FRenderingThread::SetupRenderThread ( )
inline

Member Data Documentation

◆ TaskGraphBoundSyncEvent

FEvent* FRenderingThread::TaskGraphBoundSyncEvent

Sync event to make sure that render thread is bound to the task graph before main thread queues work against it.


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