UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FDebugCanvasDrawer Class Reference

#include <DebugCanvas.h>

+ Inheritance diagram for FDebugCanvasDrawer:

Public Member Functions

 FDebugCanvasDrawer ()
 
 ~FDebugCanvasDrawer ()
 
FCanvas * GetGameThreadDebugCanvas ()
 
void BeginRenderingCanvas (const FIntRect &InCanvasRect)
 
void InitDebugCanvas (FViewportClient *ViewportClient, UWorld *InWorld)
 
void ReleaseResources ()
 
void ReleaseInternalTexture ()
 
virtual void AddReferencedObjects (FReferenceCollector &Collector) override
 
virtual FString GetReferencerName () const override
 
- Public Member Functions inherited from ICustomSlateElement
virtual ~ICustomSlateElement ()
 
virtual void PostCustomElementAdded (FSlateElementBatcher &ElementBatcher) const
 
struct UE_DEPRECATED (5.5, "Use ICustomSlateElement::Draw instead") FSlateCustomDrawParams
 
virtual void DrawRenderThread (FRHICommandListImmediate &RHICmdList, const void *RenderTarget)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void Draw_RenderThread (FRHICommandListImmediate &RHICmdList, const void *RenderTarget, const FSlateCustomDrawParams &Params)
 
virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UsesAdditionalRHIParams () const
 
- Public Member Functions inherited from FGCObject
 FGCObject ()
 
 FGCObject (const FGCObject &Other)
 
 FGCObject (FGCObject &&Other)
 
 FGCObject (EFlags Flags)
 
virtual ~FGCObject ()
 
FGCObject & operator= (const FGCObject &)
 
FGCObject & operator= (FGCObject &&)
 
COREUOBJECT_API void RegisterGCObject ()
 
COREUOBJECT_API void UnregisterGCObject ()
 
virtual bool GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const
 

Additional Inherited Members

- Public Types inherited from FGCObject
enum class  EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
 
- Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void StaticInit ()
 
- Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer * GGCObjectReferencer = nullptr
 

Detailed Description

Custom Slate drawer to render a debug canvas on top of a Slate window

Constructor & Destructor Documentation

◆ FDebugCanvasDrawer()

FDebugCanvasDrawer::FDebugCanvasDrawer ( )

◆ ~FDebugCanvasDrawer()

FDebugCanvasDrawer::~FDebugCanvasDrawer ( )

Member Function Documentation

◆ AddReferencedObjects()

void FDebugCanvasDrawer::AddReferencedObjects ( FReferenceCollector &  Collector)
overridevirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters
CollectorThe collector of referenced objects.

Implements FGCObject.

◆ BeginRenderingCanvas()

void FDebugCanvasDrawer::BeginRenderingCanvas ( const FIntRect &  InCanvasRect)

Sets up the canvas for rendering

◆ GetGameThreadDebugCanvas()

FCanvas * FDebugCanvasDrawer::GetGameThreadDebugCanvas ( )
Returns
The debug canvas that the game thread can use

◆ GetReferencerName()

virtual FString FDebugCanvasDrawer::GetReferencerName ( ) const
inlineoverridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

◆ InitDebugCanvas()

void FDebugCanvasDrawer::InitDebugCanvas ( FViewportClient *  ViewportClient,
UWorld *  InWorld 
)

Creates a new debug canvas and enqueues the previous one for deletion

◆ ReleaseInternalTexture()

void FDebugCanvasDrawer::ReleaseInternalTexture ( )

Release the internal layer texture (game thread)

◆ ReleaseResources()

void FDebugCanvasDrawer::ReleaseResources ( )
inline

Releases rendering resources

The documentation for this class was generated from the following files: