FGameThreadHitchHeartBeatThreaded

Windows
MacOS
Linux

Inheritance Hierarchy

FRunnable

FGameThreadHitchHeartBeatThreaded

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/ThreadHeartBeat.h

Include

#include "HAL/ThreadHeartBeat.h"

Syntax

class FGameThreadHitchHeartBeatThreaded : public FRunnable

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Name Description

Public function

void

 

FrameStart

(
    bool bSkipThisFrame
)

Called at the start of a frame to register the time we are looking to detect a hitch

Public function Static

FGameThreadH...

 

Get()

Gets the heartbeat singleton

Public function

double

 

GetCurrentTime()

Public function

double

 

GetFrameStartTime()

Public function Static

FGameThreadH...

 

GetNoInit()

Gets the heartbeat singleton

Public function

void

 

Restart()

No-op, used in FUnixSignalGameHitchHeartBeat.

Public function

void

 

ResumeHeartBeat()

Resume heartbeat hitch detection. Call only after first calling SuspendHeartBeat.

Public function

void

 

SuspendHeartBeat()

Suspend heartbeat hitch detection. Must call ResumeHeartBeat later to resume.

Overridden from FRunnable

Name Description

Public function Virtual

bool

 

Init()

Initializes the runnable object.

Public function Virtual

uint32

 

Run()

Runs the runnable object.

Public function Virtual

void

 

Stop()

Stops the runnable object.

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

Enums

Name

Description

Public enum

EConstants

Constants

Name

Description

MaxStackDepth

Singleton

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss