FDebugDrawQueue

A thread safe way to generate latent debug drawing.

Windows
MacOS
Linux

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/DebugDrawQueue.h

Include

#include "Chaos/DebugDrawQueue.h"

Syntax

class FDebugDrawQueue

Remarks

A thread safe way to generate latent debug drawing. (This is picked up later by the geometry collection component which is a total hack for now, but needed to get into an engine world )

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

 

DrawDebugBox

(
    FVector const& Center,
    FVector const& Extent,
    const FQuat& Rotation,
    FColor const& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugCapsule

(
    const FVector& Center,
    float HalfHeight,
    float Radius,
    const FQuat& Rotation,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugCircle

(
    const FVector& Center,
    float Radius,
    int32 Segments,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness,
    const FVector& YAxis,
    const FVector& ZAxis,
    bool bDrawAxis
)

Public function

void

 

DrawDebugDirectionalArrow

(
    const FVector& LineStart,
    const FVector& LineEnd,
    float ArrowSize,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugLine

(
    const FVector& LineStart,
    const FVector& LineEnd,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugPoint

(
    const FVector& Position,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugSphere

(
    FVector const& Center,
    float Radius,
    int32 Segments,
    const FColor& Color,
    bool bPersistentLines,
    float LifeTime,
    uint8 DepthPriority,
    float Thickness
)

Public function

void

 

DrawDebugString

(
    FVector const& TextLocation,
    const FString& Text,
    AActor* TestBaseActor,
    FColor const& Color,
    float Duration,
    bool bDrawShadow,
    float FontScale
)

Public function

void

 

ExtractAllElements

(
    TArray< FLatentDrawCommand >& OutD...,
    bool bClear
)

Public function Static

FDebugDrawQu...

 

GetInstance()

Public function Static

bool

 

IsDebugDrawingEnabled()

Public function Static

FAutoConsole...

 

MakeCVarRef()

Public function

void

 

SetConsumerActive

(
    void* Consumer,
    bool bConsumerActive
)

Enums

Name

Description

Public enum

EBuffer

Constants

Name

Description

EnableDebugDrawing

NumConsumers

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