FSlateFontMeasure::FindCharacterIndexAtOffset

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

Choose your operating system:

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