Navigation
API > API/Runtime > API/Runtime/Chaos
A thread-local debug draw context used to access the queue to draw to for any thread on which debug draw has been set up.
| Name | FChaosDDContext |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/ChaosDebugDraw/ChaosDDContext.h |
| Include Path | #include "ChaosDebugDraw/ChaosDDContext.h" |
Syntax
class FChaosDDContext : public TThreadSingleton< FChaosDDContext >
Inheritance Hierarchy
- FTlsAutoCleanup → TThreadSingleton → FChaosDDContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosDDContext() |
ChaosDebugDraw/ChaosDDContext.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bDebugDrawEnabled | bool | Whether the system is enabled. | ChaosDebugDraw/ChaosDDContext.h |
| GlobalCommandBudget | int32 | ChaosDebugDraw/ChaosDDContext.h | |
| GlobalFrame | FChaosDDFramePtr | ChaosDebugDraw/ChaosDDContext.h | |
| GlobalFrameCS | FCriticalSection | Global frame: fallback for out-of-context debug draw. | ChaosDebugDraw/ChaosDDContext.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Frame | FChaosDDFramePtr | The frame to draw to on this thread (or null) | ChaosDebugDraw/ChaosDDContext.h |
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CreateGlobalFrame() |
ChaosDebugDraw/ChaosDDContext.h | ||
static FChaosDDFramePtr ExtractGlobalFrame() |
For internal use - collect all out-of-frame debug draw commands for rendering. | ChaosDebugDraw/ChaosDDContext.h | |
static const FChaosDDFramePtr & GetGlobalFrame() |
Global frame management. | ChaosDebugDraw/ChaosDDContext.h | |
static FChaosDDFrameWriter GetWriter() |
Write access to the debug draw frame for the current thread. | ChaosDebugDraw/ChaosDDContext.h | |
static bool IsDebugDrawEnabled() |
Whether the debug draw system is enabled. | ChaosDebugDraw/ChaosDDContext.h | |
static void SetGlobalCommandBudget
(
int32 InCommandBudget |
ChaosDebugDraw/ChaosDDContext.h | ||
static void SetGlobalDrawRegion
(
const FSphere3d& InDrawRegion |
ChaosDebugDraw/ChaosDDContext.h | ||
static void SetIsDebugDrawEnabled
(
bool bInEnabled |
Enable/Disable the debug draw system. | ChaosDebugDraw/ChaosDDContext.h |