Navigation
API > API/Plugins > API/Plugins/GameplayCameras
Rendering utility for colored debug text.
| Name | FDebugTextRenderer |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Debug/DebugTextRenderer.h |
| Include Path | #include "Debug/DebugTextRenderer.h" |
Syntax
class FDebugTextRenderer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Creates a new debug text renderer. | Debug/DebugTextRenderer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEndWithNewLine | bool | Moves the next draw position to a new line at the end of the text render. | Debug/DebugTextRenderer.h | |
| LeftMargin | float | The X coordinate for where text drawing starts, and where new lines start from. | Debug/DebugTextRenderer.h | |
| LineSpacing | float | Space between the lines, defaults to max font character height. | Debug/DebugTextRenderer.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Canvas | FCanvas * | Debug/DebugTextRenderer.h | ||
| DrawColor | FColor | Debug/DebugTextRenderer.h | ||
| Font | const UFont * | Debug/DebugTextRenderer.h | ||
| NextDrawPosition | FVector2f | Debug/DebugTextRenderer.h | ||
| RightMargin | float | Debug/DebugTextRenderer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteCommands
(
float StartingDrawY, |
Executes the given command queue. | Debug/DebugTextRenderer.h | |
void ExecuteCommands
(
FVector2f StartingDrawPosition, |
Debug/DebugTextRenderer.h | ||
FVector2f GetEndDrawPosition() |
Gets the coordinate of where any new text would go, just after the last render. | Debug/DebugTextRenderer.h | |
float GetRightMargin() |
Gets the maximum horizontal extent of the rendered text. | Debug/DebugTextRenderer.h | |
void RenderText
(
float StartingDrawY, |
Renders the given text to the canvas. | Debug/DebugTextRenderer.h | |
void RenderText
(
FVector2f StartingDrawPosition, |
Debug/DebugTextRenderer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetStringViewSize
(
const UFont* Font, |
Debug/DebugTextRenderer.h |