1. Epic GamesDeveloper
  3. FShapedGlyphSequence

FShapedGlyphSequence

Information for rendering a shaped text sequence

Unreal Engine C++ API Reference > Runtime > SlateCore > Fonts

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Fonts/FontCache.h
Include #include "Fonts/FontCache.h"

Syntax

class FShapedGlyphSequence

Remarks

Information for rendering a shaped text sequence

Constructors

  Type Name Description
Public function    
Public function  

FShapedGlyphSequence ( TArray< FShapedGlyphEntry > InGlyphsToRender,
const int16 InTextBaseline,
const uint16 InMaxTextHeight,
const UObject* InFontMaterial,
const FFontOutlineSettings& InOutlineSettings,
const FSourceTextRange& InSourceTextRange
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const SIZE_T Get the amount of memory allocated to this sequence
Public function Const const UObject * Get the material to use when rendering these glyphs
Public function Const const FFontOutlineSettings & Get the font outline settings to use when rendering these glyphs
Public function Const float Get the font skew applied when this glyph sequence was shaped
Public function Const TOptional< FGlyphOffsetResult >

GetGlyphAtOffset ( FSlateFontCache& InFontCache,
const int32 InStartIndex,
const int32 InEndIndex,
const int32 InHorizontalOffset,
const int32 InStartOffset,
const bool InIncludeKerningWithPrecedingGlyph
)

 Get the information for the glyph at the specified position in pixels along the string horizontally
Public function Const FGlyphOffsetResult

GetGlyphAtOffset ( FSlateFontCache& InFontCache,
const int32 InHorizontalOffset,
const int32 InStartOffset
)

 Get the information for the glyph at the specified position in pixels along the string horizontally
Public function Const const TArray< FShapedGlyphEntry > & Get the array of glyphs in this sequence.
Public function Const TOptional< int8 >

GetKerning ( const int32 InIndex
)

 Get the kerning value between the given entry and the next entry in the sequence
Public function Const uint16 Get the maximum height of any glyph in the font we're using
Public function Const int32 Get the measured width of the entire shaped text
Public function Const TOptional< int32 >

GetMeasuredWidth ( const int32 InStartIndex,
const int32 InEndIndex,
const bool InIncludeKerningWithPrecedingGlyph
)

 Get the measured width of the specified range of this shaped text
Public function Const FShapedGlyphSequencePtr

GetSubSequence ( const int32 InStartIndex,
const int32 InEndIndex
)

 Get a sub-sequence of the specified range
Public function Const int16 Get the baseline to use when drawing the glyphs in this sequence
Public function Const bool

IsDirty ()

 Check to see whether this glyph sequence is dirty (ie, contains glyphs with invalid font pointers)

Classes

  Type Name Description
Public struct FGlyphOffsetResult Return data used by GetGlyphAtOffset  
Public struct FSourceTextRange    

Enums

  Type Name Description
Private enum EEnumerateGlyphsResult Enumerate all of the glyphs within the given source index range (enumerates either visually or logically)  

Typedefs

Name Description
FForEachShapedGlyphEntryCallback  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page