Navigation
Unreal Engine C++ API Reference > Runtime > Engine
Inheritance Hierarchy
- FCanvasItem
- FCanvasTextItemBase
- FCanvasShapedTextItem
- FCanvasTextItem
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/CanvasItem.h |
| Include | #include "CanvasItem.h" |
Syntax
class FCanvasTextItemBase : public FCanvasItem
Remarks
Base item used for drawing text
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FBatchedElements * | BatchedElements | These are used by the DrawStringInternal function. Used for batching. |
 |
bool | bCentreX | Centre the text in the viewport on horizontally. |
 |
bool | bCentreY | Centre the text in the viewport on vertically. |
 |
bool | bDontCorrectStereoscopic | Disables correction of font render issue when using stereoscopic display. |
 |
bool | bOutlined | Draw an outline on the text. |
 |
float | Depth | Depth sort key. |
 |
FVector2D | DrawnSize | The size of the drawn text after the draw call. |
 |
FFontRenderInfo | FontRenderInfo | Custom font render information. |
 |
float | HorizSpacingAdjust | Horizontal spacing adjustment. |
 |
FLinearColor | OutlineColor | The color of the outline. |
 |
FVector2D | Scale | The scale of the text |
 |
FLinearColor | ShadowColor | The color of the shadow |
 |
FVector2D | ShadowOffset | The offset of the shadow. |
 |
FCanvasTileItem | TileItem | Background tile used to fixup 3d text issues. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FCanvasTextItemBase
(
const FVector2D& InPosition, |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Disable the shadow | |
 |
void | DrawStringInternal
(
FCanvas* InCanvas, |
Internal string drawIn a method to make it simpler to do effects like shadow, outline |
 |
void | EnableShadow
(
const FLinearColor& InColor, |
Set the shadow offset and color. |
  |
ESimpleElementBlendMode | GetTextBlendMode
(
const bool bHasShadow |
Get the blend mode we should use to draw this text |
  |
FVector2D | GetTextSize
(
float DPIScale |
Get the measured size of the text to draw |
  |
bool | HasValidText () |
Does this text item have valid text to draw? |
Overridden from FCanvasItem
| Type | Name | Description | |
|---|---|---|---|
  |
void | Draw the item at the given coordinates. | |
  |
void | SetColor
(
const FLinearColor& InColor |
Set the Color of the item. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FTextEffect |