Navigation
API > API/Runtime > API/Runtime/Chaos
Debug only class used to control the pausing/stepping/substepping of a debug solver thread.
| Name | FDebugSubstep |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/DebugSubstep.h |
| Include Path | #include "Chaos/Framework/DebugSubstep.h" |
Syntax
class FDebugSubstep
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chaos/Framework/DebugSubstep.h | |||
FDebugSubstep
(
const FDebugSubstep& |
Chaos/Framework/DebugSubstep.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDebugSubstep() |
Chaos/Framework/DebugSubstep.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEnabled | FThreadSafeBool | Chaos/Framework/DebugSubstep.h | ||
| bShouldEnable | bool | Chaos/Framework/DebugSubstep.h | ||
| bWaitForStep | bool | Chaos/Framework/DebugSubstep.h | ||
| CommandQueue | TQueue< ECommand, EQueueMode::Mpsc > | Chaos/Framework/DebugSubstep.h | ||
| ProgressEvent | FEvent * | Chaos/Framework/DebugSubstep.h | ||
| SubstepEvent | FEvent * | Chaos/Framework/DebugSubstep.h | ||
| ThreadId | uint32 | Chaos/Framework/DebugSubstep.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Add
(
const TCHAR* Label |
Add a new potential pause point where the debug solver thread can wait until the next step/substep command. | Chaos/Framework/DebugSubstep.h | |
void Enable
(
bool bEnable |
Enable/disable substep pause points. | Chaos/Framework/DebugSubstep.h | |
bool IsEnabled() |
Return whether debugging mode/pausing to substeps is enabled. | Chaos/Framework/DebugSubstep.h | |
void ProgressToStep() |
Allow progress to the next step (only works once this object is enabled). | Chaos/Framework/DebugSubstep.h | |
void ProgressToSubstep() |
Allow progress to the next substep (only works once this object is enabled). | Chaos/Framework/DebugSubstep.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDebugSubstep & operator=
(
const FDebugSubstep& |
Chaos/Framework/DebugSubstep.h |