1. Epic GamesDeveloper
  3. UTextRenderComponent

UTextRenderComponent

Renders text in the world with given font.

API > API/Runtime > API/Runtime/Engine

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

   
Name UTextRenderComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/TextRenderComponent.h
Include Path #include "Components/TextRenderComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UTextRenderComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/TextRenderComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAlwaysRenderAsText uint32 Allows text to draw unmodified when using debug visualization modes. Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category=Rendering
Font TObjectPtr< class UFont > Text font Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
HorizontalAlignment TEnumAsByte< enum EHorizTextAligment > Horizontal text alignment Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
  • Meta=(DisplayName="Horizontal Alignment")
HorizSpacingAdjust float Horizontal adjustment per character, default is 0.0 Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category=Text
InvDefaultSize float The inverse of the Font's character height. Components/TextRenderComponent.h  
Text FText Text content, can be multi line using    
as line separator Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
  • Meta=(MultiLine=true)
    
TextMaterial TObjectPtr< class UMaterialInterface > Text material Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
TextRenderColor FColor Color of the text, can be accessed as vertex color Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
VerticalAlignment TEnumAsByte< enum EVerticalTextAligment > Vertical text alignment Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
  • Meta=(DisplayName="Vertical Alignment")
VertSpacingAdjust float Vertical adjustment per character, default is 0.0 Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category=Text
WorldSize float Vertical size of the fonts largest character in world units. Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
XScale float Horizontal scale, default is 1.0 Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text
YScale float Vertical scale, default is 1.0 Components/TextRenderComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Text

Functions

Public

Name Remarks Include Path Unreal Specifiers

FVector GetTextLocalSize()

 Get local size of text Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

FVector GetTextWorldSize()

 Get world space size of text Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void K2_SetText ( const FText& Value
)

 Change the text value and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"
  • Meta=(DisplayName="Set Text", ScriptName="SetText")

void SetFont ( UFont* Value
)

 Change the font and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetHorizontalAlignment ( EHorizTextAligment Value
)

 Change the horizontal alignment and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetHorizSpacingAdjust ( float Value
)

 Change the text horizontal spacing adjustment and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetText ( const FText& Value
)

 Change the text value and signal the primitives to be rebuilt Components/TextRenderComponent.h  

void SetTextMaterial ( UMaterialInterface* Material
)

 Change the text material and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetTextRenderColor ( FColor Value
)

 Change the text render color and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetVerticalAlignment ( EVerticalTextAligment Value
)

 Change the vertical alignment and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetVertSpacingAdjust ( float Value
)

 Change the text vertical spacing adjustment and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetWorldSize ( float Value
)

 Change the world size of the text and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetXScale ( float Value
)

 Change the text X scale and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

void SetYScale ( float Value
)

 Change the text Y scale and signal the primitives to be rebuilt Components/TextRenderComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|TextRender"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/TextRenderComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 ElementIndex
) const

 Returns the material used by the element at the specified index Components/TextRenderComponent.h  

virtual int32 GetNumMaterials()

 Return number of material elements in this primitive Components/TextRenderComponent.h  

virtual FMatrix GetRenderMatrix ()

 Returns the matrix that should be used to render this component. Components/TextRenderComponent.h  

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

 Retrieves the materials used in this component Components/TextRenderComponent.h  

virtual void SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh. Components/TextRenderComponent.h  

virtual bool ShouldRecreateProxyOnUpdateTransform()

 Determines whether the proxy for this primitive type needs to be recreated whenever the primitive moves. Components/TextRenderComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. Components/TextRenderComponent.h  

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 Components/TextRenderComponent.h  

virtual void UpdateBounds()

 Note: this is required because GetRenderMatrix is overridden, and therefore the updated world-space bounds must be based on that (not the component transform) Components/TextRenderComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void PrecachePSOs()

 Precache all PSOs which can be used by the primitive component Components/TextRenderComponent.h  

virtual bool RequiresGameThreadEndOfFrameUpdates()

 Return true if this component requires end of frame updates to happen from the game thread. Components/TextRenderComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Components/TextRenderComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void InitializeMIDCache()

   Components/TextRenderComponent.h  

static void ShutdownMIDCache()

   Components/TextRenderComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page