UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FZeroLoad Class Reference

#include <ZeroLoad.h>

+ Inheritance diagram for FZeroLoad:

Public Member Functions

virtual bool Init () override
 
virtual uint32 Run () override
 
virtual void Stop () override
 
virtual void Exit () override
 
bool GetHitchMessages (TArray< FString > &OutArray)
 
bool GetFrameTimeHistogram (FHistogram &OutHistogram)
 
 FZeroLoad (double InTickRate)
 
 FZeroLoad (double InTickRate, const TArray< double > &FrameTimeHistogramBucketsMs)
 
virtual ~FZeroLoad ()
 
- Public Member Functions inherited from FRunnable
virtual class FSingleThreadRunnableGetSingleThreadInterface ()
 
virtual ~FRunnable ()
 

Constructor & Destructor Documentation

◆ FZeroLoad() [1/2]

FZeroLoad::FZeroLoad ( double  InTickRate)

◆ FZeroLoad() [2/2]

FZeroLoad::FZeroLoad ( double  InTickRate,
const TArray< double > &  FrameTimeHistogramBucketsMs 
)

◆ ~FZeroLoad()

virtual FZeroLoad::~FZeroLoad ( )
inlinevirtual

Member Function Documentation

◆ Exit()

void FZeroLoad::Exit ( void  )
overridevirtual

Exits the runnable object.

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

See also
Init, Run, Stop

Reimplemented from FRunnable.

◆ GetFrameTimeHistogram()

bool FZeroLoad::GetFrameTimeHistogram ( FHistogram OutHistogram)

Gets frame time histogram - not guarded, should only be accessed after thread has stopped!

◆ GetHitchMessages()

bool FZeroLoad::GetHitchMessages ( TArray< FString > &  OutArray)

Gets messages to log - can block.

◆ Init()

bool FZeroLoad::Init ( void  )
overridevirtual

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()

uint32 FZeroLoad::Run ( )
overridevirtual

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()

void FZeroLoad::Stop ( void  )
overridevirtual

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 files: