Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Fonts > FSlateFontMeasure > FindCharacterIndexAtOffset > FSlateFontMeasure::FindCharacterIndexAtOffset

Light Theme

Dark Theme

FSlateFontMeasure::FindCharacterIndexAtOffset

Finds the character index at the specified position in pixels along the string horizontally

Windows

MacOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Fonts/FontMeasure.h
Include	#include "Fonts/FontMeasure.h"
Source	/Engine/Source/Runtime/SlateCore/Private/Fonts/FontMeasure.cpp

Syntax

virtual int32 FindCharacterIndexAtOffset
(
    const FString & Text,
    int32 StartIndex,
    int32 EndIndex,
    const FSlateFontInfo & InFontInfo,
    const int32 HorizontalOffset,
    bool IncludeKerningWithPrecedingChar,
    float FontScale
) const

Remarks

Finds the character index at the specified position in pixels along the string horizontally

Returns

The index of the character closest to the specified horizontal offset

Parameters

Parameter	Description
Text	The string to measure
StartIndex	The inclusive index to start measuring the string at
EndIndex	The inclusive index to stop measuring the string at
FontName	The name of the font the string is drawn with
FontSize	The size of the font
HorizontalOffset	Offset horizontally into the string, in pixels
FontScale	The scale to apply to the font

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss