FGameplayDebuggerCanvasContext

Windows
MacOS
Linux

Syntax

class FGameplayDebuggerCanvasContext

Variables

Name Description

Public variable

TWeakObjectPtr<...

 

Canvas

Canvas used for drawing

Public variable

float

 

CursorX

Position of cursor

Public variable

float

 

CursorY

Public variable

float

 

DefaultX

Default position of cursor

Public variable

float

 

DefaultY

Public variable

TWeakObjectPtr<...

 

Font

Current text font

Public variable

FFontRenderInfo

 

FontRenderInfo

Font render data

Constructors

Name Description

Public function

FGameplayDebuggerCanvasContext()

Public function

FGameplayDebuggerCanvasContext

(
    UCanvas* InCanvas,
    UFont* InFont
)

Functions

Name Description

Public function

void

 

DrawIcon

(
    const FColor& Color,
    const FCanvasIcon& Icon,
    float PosX,
    float PosY,
    float Scale
)

Draw icon on canvas

Public function

void

 

DrawItem

(
    FCanvasItem& Item,
    float PosX,
    float PosY
)

Draw item on canvas

Public function Const

float

 

GetLineHeight()

Get height of single line text

Public function Const

bool

 

IsLocationVisible

(
    const FVector& Location
)

Check if world location is visible in current view

Public function Const

void

 

MeasureString

(
    const FString& String,
    float& OutSizeX,
    float& OutSizeY
)

Calculate size of string

Public function

void

 

MoveToNewLine()

Moves cursor to new line

Public function

void

 

Print

(
    const FString& String
)

Print string on canvas

Public function

void

 

Print

(
    const FColor& Color,
    const FString& String
)

Print string on canvas

Public function

void

 

PrintAt

(
    float PosX,
    float PosY,
    const FString& String
)

Print string on canvas

Public function

void

 

PrintAt

(
    float PosX,
    float PosY,
    const FColor& Color,
    const FString& String
)

Print string on canvas

Public function

void

 

Printf

(
    const FmtType& Fmt,
    Types... Args
)

Print formatted string on canvas

Public function

void

 

Printf

(
    const FColor& Color,
    const FmtType& Fmt,
    Types... Args
)

Public function

void

 

PrintfAt

(
    float PosX,
    float PosY,
    const FmtType& Fmt,
    Types... Args
)

Public function

void

 

PrintfAt

(
    float PosX,
    float PosY,
    const FColor& Color,
    const FmtType& Fmt,
    Types... Args
)

Public function Const

FVector2D

 

ProjectLocation

(
    const FVector& Location
)

Project world location on canvas

References

Module

GameplayDebugger

Header

Developer/GameplayDebugger/Public/GameplayDebuggerTypes.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback