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

Public Member Functions

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

Detailed Description

The rendering thread heartbeat runnable object.

Member Function Documentation

◆ Exit()

virtual void FRenderingThreadTickHeartbeat::Exit ( void  )
inlinevirtual

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 FRenderingThreadTickHeartbeat::Init ( void  )
inlinevirtual

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 FRenderingThreadTickHeartbeat::Run ( void  )
inlinevirtual

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.

◆ Stop()

virtual void FRenderingThreadTickHeartbeat::Stop ( void  )
inlinevirtual

Stops the runnable object.

This is called if a thread is requested to terminate early.

See also
Init, Run, Exit

Reimplemented from FRunnable.


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