ShapedTextCacheUtil::FindCharacterIndexAtOffset

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

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Text/ShapedTextCache.h

Include

#include "Framework/Text/ShapedTextCache.h"

Source

/Engine/Source/Runtime/Slate/Private/Framework/Text/ShapedTextCache.cpp

Syntax

namespace ShapedTextCacheUtil
{
    int32 ShapedTextCacheUtil::FindCharacterIndexAtOffset
    (
        const FShapedTextCacheRef & InShapedTextCache,
        const FCachedShapedTextKey & InRunKey,
        const FTextRange & InTextRange,
        const TCHAR * InText,
        const int32 InHorizontalOffset
    )
}

Remarks

Find 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

InShapedTextCache

The shaped text cache to use

InRunKey

The key identifying the cached shaped text for the run

InTextRange

The range of text that should be extracted into its own shaped glyph sequence

InText

The text to shape if we can't find the shaped text in the cache. InTextRange may specify a sub-section of the entire text

InHorizontalOffset

The horizontal offset to get the character index for

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