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

#include <GameplayDebuggerTypes.h>

Public Member Functions

 FGameplayDebuggerCanvasContext ()
 
GAMEPLAYDEBUGGER_API FGameplayDebuggerCanvasContext (UCanvas *InCanvas, UFont *InFont)
 
GAMEPLAYDEBUGGER_API void Print (const FString &String)
 
GAMEPLAYDEBUGGER_API void Print (const FColor &Color, const FString &String)
 
GAMEPLAYDEBUGGER_API void Print (const FColor &Color, const float Alpha, const FString &String)
 
GAMEPLAYDEBUGGER_API void PrintAt (float PosX, float PosY, const FString &String)
 
GAMEPLAYDEBUGGER_API void PrintAt (float PosX, float PosY, const FColor &Color, const FString &String)
 
GAMEPLAYDEBUGGER_API void PrintAt (float PosX, float PosY, const FColor &Color, const float Alpha, const FString &String)
 
template<typename FmtType , typename... Types>
void Printf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void Printf (const FColor &Color, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void Printf (const FColor &Color, const float Alpha, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void PrintfAt (float PosX, float PosY, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void PrintfAt (float PosX, float PosY, const FColor &Color, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void PrintfAt (float PosX, float PosY, const FColor &Color, const float Alpha, const FmtType &Fmt, Types... Args)
 
GAMEPLAYDEBUGGER_API void MoveToNewLine ()
 
GAMEPLAYDEBUGGER_API void MeasureString (const FString &String, float &OutSizeX, float &OutSizeY) const
 
GAMEPLAYDEBUGGER_API float GetLineHeight () const
 
GAMEPLAYDEBUGGER_API FVector2D ProjectLocation (const FVector &Location) const
 
GAMEPLAYDEBUGGER_API bool IsLocationVisible (const FVector &Location) const
 
GAMEPLAYDEBUGGER_API void DrawItem (FCanvasItem &Item, float PosX, float PosY)
 
GAMEPLAYDEBUGGER_API void DrawIcon (const FColor &Color, const FCanvasIcon &Icon, float PosX, float PosY, float Scale=1.f)
 
GAMEPLAYDEBUGGER_API UWorld * GetWorld () const
 

Public Attributes

TWeakObjectPtr< UCanvas > Canvas
 
TWeakObjectPtr< UFont > Font
 
TWeakObjectPtr< APlayerController > PlayerController
 
TWeakObjectPtr< UWorld > World
 
FFontRenderInfo FontRenderInfo
 
float CursorX
 
float CursorY
 
float DefaultX
 
float DefaultY
 

Constructor & Destructor Documentation

◆ FGameplayDebuggerCanvasContext() [1/2]

FGameplayDebuggerCanvasContext::FGameplayDebuggerCanvasContext ( )
inline

◆ FGameplayDebuggerCanvasContext() [2/2]

FGameplayDebuggerCanvasContext::FGameplayDebuggerCanvasContext ( UCanvas *  InCanvas,
UFont *  InFont 
)

Member Function Documentation

◆ DrawIcon()

void FGameplayDebuggerCanvasContext::DrawIcon ( const FColor &  Color,
const FCanvasIcon &  Icon,
float  PosX,
float  PosY,
float  Scale = 1.f 
)

◆ DrawItem()

void FGameplayDebuggerCanvasContext::DrawItem ( FCanvasItem &  Item,
float  PosX,
float  PosY 
)

◆ GetLineHeight()

float FGameplayDebuggerCanvasContext::GetLineHeight ( ) const

◆ GetWorld()

UWorld * FGameplayDebuggerCanvasContext::GetWorld ( ) const

◆ IsLocationVisible()

bool FGameplayDebuggerCanvasContext::IsLocationVisible ( const FVector &  Location) const

◆ MeasureString()

void FGameplayDebuggerCanvasContext::MeasureString ( const FString &  String,
float &  OutSizeX,
float &  OutSizeY 
) const

◆ MoveToNewLine()

void FGameplayDebuggerCanvasContext::MoveToNewLine ( )

◆ Print() [1/3]

void FGameplayDebuggerCanvasContext::Print ( const FColor &  Color,
const float  Alpha,
const FString &  String 
)

◆ Print() [2/3]

void FGameplayDebuggerCanvasContext::Print ( const FColor &  Color,
const FString &  String 
)

◆ Print() [3/3]

void FGameplayDebuggerCanvasContext::Print ( const FString &  String)

◆ PrintAt() [1/3]

void FGameplayDebuggerCanvasContext::PrintAt ( float  PosX,
float  PosY,
const FColor &  Color,
const float  Alpha,
const FString &  String 
)

◆ PrintAt() [2/3]

void FGameplayDebuggerCanvasContext::PrintAt ( float  PosX,
float  PosY,
const FColor &  Color,
const FString &  String 
)

◆ PrintAt() [3/3]

void FGameplayDebuggerCanvasContext::PrintAt ( float  PosX,
float  PosY,
const FString &  String 
)

◆ Printf() [1/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::Printf ( const FColor &  Color,
const float  Alpha,
const FmtType &  Fmt,
Types...  Args 
)
inline

◆ Printf() [2/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::Printf ( const FColor &  Color,
const FmtType &  Fmt,
Types...  Args 
)
inline

◆ Printf() [3/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::Printf ( const FmtType &  Fmt,
Types...  Args 
)
inline

◆ PrintfAt() [1/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::PrintfAt ( float  PosX,
float  PosY,
const FColor &  Color,
const float  Alpha,
const FmtType &  Fmt,
Types...  Args 
)
inline

◆ PrintfAt() [2/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::PrintfAt ( float  PosX,
float  PosY,
const FColor &  Color,
const FmtType &  Fmt,
Types...  Args 
)
inline

◆ PrintfAt() [3/3]

template<typename FmtType , typename... Types>
void FGameplayDebuggerCanvasContext::PrintfAt ( float  PosX,
float  PosY,
const FmtType &  Fmt,
Types...  Args 
)
inline

◆ ProjectLocation()

FVector2D FGameplayDebuggerCanvasContext::ProjectLocation ( const FVector &  Location) const

Member Data Documentation

◆ Canvas

TWeakObjectPtr<UCanvas> FGameplayDebuggerCanvasContext::Canvas

canvas used for drawing

◆ CursorX

float FGameplayDebuggerCanvasContext::CursorX

position of cursor

◆ CursorY

float FGameplayDebuggerCanvasContext::CursorY

◆ DefaultX

float FGameplayDebuggerCanvasContext::DefaultX

default position of cursor

◆ DefaultY

float FGameplayDebuggerCanvasContext::DefaultY

◆ Font

TWeakObjectPtr<UFont> FGameplayDebuggerCanvasContext::Font

current text font

◆ FontRenderInfo

FFontRenderInfo FGameplayDebuggerCanvasContext::FontRenderInfo

font render data

◆ PlayerController

TWeakObjectPtr<APlayerController> FGameplayDebuggerCanvasContext::PlayerController

the player controller associated with this debugger context

◆ World

TWeakObjectPtr<UWorld> FGameplayDebuggerCanvasContext::World

the world associated with this debugger context

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