#include <DebugSubstep.h>

Public Member Functions
	FDebugSubstep ()

CHAOS_API	~FDebugSubstep ()

bool	IsEnabled () const

FORCEINLINE void	Add (const TCHAR *Label=nullptr) const

CHAOS_API void	Enable (bool bEnable)

CHAOS_API void	ProgressToSubstep ()

CHAOS_API void	ProgressToStep ()

Friends
class	FDebugSolverTask

class	FDebugSolverTasks

Detailed Description

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

Constructor & Destructor Documentation

◆ FDebugSubstep()

Chaos::FDebugSubstep::FDebugSubstep ( )

◆ ~FDebugSubstep()

CHAOS_API Chaos::FDebugSubstep::~FDebugSubstep ( )

Member Function Documentation

◆ Add()

FORCEINLINE void Chaos::FDebugSubstep::Add ( const TCHAR * Label = nullptr ) const

inline

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

Parameters

Label The reference (if any) that will be used in verbose logs when this point is reached, or nullptr otherwise. Only call from the solver thread. It will fail if called from inside a parallel for loop, or any other thread.

◆ Enable()

CHAOS_API void Chaos::FDebugSubstep::Enable ( bool bEnable )

Enable/disable substep pause points.

◆ IsEnabled()

bool Chaos::FDebugSubstep::IsEnabled ( ) const

inline

Return whether debugging mode/pausing to substeps is enabled.

◆ ProgressToStep()

CHAOS_API void Chaos::FDebugSubstep::ProgressToStep ( )

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

◆ ProgressToSubstep()

CHAOS_API void Chaos::FDebugSubstep::ProgressToSubstep ( )

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

Friends And Related Symbol Documentation

◆ FDebugSolverTask

friend class FDebugSolverTask

friend

◆ FDebugSolverTasks

friend class FDebugSolverTasks