1. Epic GamesDeveloper
  3. UTextRenderComponent

UTextRenderComponent

Renders text in the world with given font.

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/TextRenderComponent.h
Include #include "Components/TextRenderComponent.h"

Syntax

UCLASS (ClassGroup=Rendering,  
       HideCategories=(Object, LOD, Physics, TextureStreaming, Activation, "Components|Activation", Collision),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent=""), MinimalAPI)  
class UTextRenderComponent : public UPrimitiveComponent

Remarks

Renders text in the world with given font. Contains usual font related attributes such as Scale, Alignment, Color etc.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 bAlwaysRenderAsText Allows text to draw unmodified when using debug visualization modes.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UFont > Font Text font
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TEnumAsByte< enum EHorizTextAligment > HorizontalAlignment Horizontal text alignment
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly float HorizSpacingAdjust Horizontal adjustment per character, default is 0.0
Public variable UProperty float InvDefaultSize The inverse of the Font's character height.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FText Text Text content, can be multi line using
as line separator      
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UMaterialInterface > TextMaterial Text material
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FColor TextRenderColor Color of the text, can be accessed as vertex color
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TEnumAsByte< enum EVerticalTextAligment > VerticalAlignment Vertical text alignment
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly float VertSpacingAdjust Vertical adjustment per character, default is 0.0
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float WorldSize Vertical size of the fonts largest character in world units.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float XScale Horizontal scale, default is 1.0
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float YScale Vertical scale, default is 1.0

Constructors

  Type Name Description
Public function  

UTextRenderComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category FVector Get local size of text
Public function Const UFunction BlueprintCallable, Category FVector Get world space size of text
Public function Static void  
Public function UFunction BlueprintCallable, Category, Meta void

K2_SetText ( const FText& Value
)

 Change the text value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetFont ( UFont* Value
)

 Change the font and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void Change the horizontal alignment and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetHorizSpacingAdjust ( float Value
)

 Change the text horizontal spacing adjustment and signal the primitives to be rebuilt
Public function UFunction void

SetText ( const FText& Value
)

 Change the text value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void Change the text material and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void Change the text render color and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void Change the vertical alignment and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetVertSpacingAdjust ( float Value
)

 Change the text vertical spacing adjustment and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetWorldSize ( float Value
)

 Change the world size of the text and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetXScale ( float Value
)

 Change the text X scale and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category void

SetYScale ( float Value
)

 Change the text Y scale and signal the primitives to be rebuilt
Public function Static void  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const FMatrix Returns the matrix that should be used to render this component.
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Public function Virtual Const bool Determines whether the proxy for this primitive type needs to be recreated whenever the primitive moves.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual bool

GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials
Public function Virtual void Note: this is required because GetRenderMatrix is overridden, and therefore the updated world-space bounds must be based on that (not the component transform)

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Precache all PSOs which can be used by the primitive component
Public function Virtual Const bool Return true if this component requires end of frame updates to happen from the game thread.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page