Navigation
API > API/Runtime > API/Runtime/Engine
Custom Slate drawer to render a debug canvas on top of a Slate window
| Name | FDebugCanvasDrawer |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Slate/DebugCanvas.h |
| Include Path | #include "Slate/DebugCanvas.h" |
Syntax
class FDebugCanvasDrawer :
public ICustomSlateElement ,
public FGCObject
Inheritance Hierarchy
- FGCObject → FDebugCanvasDrawer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDebugCanvasDrawer() |
Slate/DebugCanvas.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDebugCanvasDrawer() |
Slate/DebugCanvas.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanvasRenderedLastFrame | bool | True if the RenderThreadCanvas rendered elements last frame | Slate/DebugCanvas.h | |
| GameThreadCanvas | FCanvasPtr | The canvas that can be used by the game thread | Slate/DebugCanvas.h | |
| LayerID | uint32 | HMD layer ID | Slate/DebugCanvas.h | |
| LayerResource | FTextureRenderTargetResource * | LayerTexture's resource, for use on the render thread | Slate/DebugCanvas.h | |
| LayerTexture | TObjectPtr< UTextureRenderTarget2D > | Rendertarget used in case of self textured canvas | Slate/DebugCanvas.h | |
| RenderTarget | FSlateCanvasRenderTarget * | Render target that the canvas renders to | Slate/DebugCanvas.h | |
| RenderThreadCanvas | FCanvasPtr | The canvas that can be used by the render thread | Slate/DebugCanvas.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginRenderingCanvas
(
const FIntRect& InCanvasRect |
Sets up the canvas for rendering | Slate/DebugCanvas.h | |
FCanvas * GetGameThreadDebugCanvas() |
Slate/DebugCanvas.h | ||
void InitDebugCanvas
(
FViewportClient* ViewportClient, |
Creates a new debug canvas and enqueues the previous one for deletion | Slate/DebugCanvas.h | |
void ReleaseInternalTexture() |
Release the internal layer texture (game thread) | Slate/DebugCanvas.h | |
void ReleaseResources() |
Releases rendering resources | Slate/DebugCanvas.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Slate/DebugCanvas.h | ||
virtual FString GetReferencerName() |
Slate/DebugCanvas.h |