FDebugSubstep

Debug only class used to control the pausing/stepping/substepping of a debug solver thread.

Windows
MacOS
Linux

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/DebugSubstep.h

Include

#include "Chaos/Framework/DebugSubstep.h"

Syntax

class FDebugSubstep

Remarks

Debug only class used to control the pausing/stepping/substepping of a debug solver thread.

Constructors

Name Description

Public function

FDebugSubstep()

Destructors

Name Description

Public function

~FDebugSubstep()

Functions

Name Description

Public function Const

void

 

Add

(
    const TCHAR* Label
)

Add a new potential pause point where the debug solver thread can wait until the next step/substep command.

Public function

void

 

Enable

(
    bool bEnable
)

Enable/disable substep pause points.

Public function Const

bool

 

IsEnabled()

Return whether debugging mode/pausing to substeps is enabled.

Public function

void

 

ProgressToStep()

Allow progress to the next step (only works once this object is enabled).

Public function

void

 

ProgressToSubstep()

Allow progress to the next substep (only works once this object is enabled).

Enums

Name

Description

Private enum

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