1. Epic GamesDeveloper
  3. FShapedGlyphSequence

FShapedGlyphSequence

Information for rendering a shaped text sequence

API > API/Runtime > API/Runtime/SlateCore

Information for rendering a shaped text sequence

   
Name FShapedGlyphSequence
Type class
Header File /Engine/Source/Runtime/SlateCore/Public/Fonts/FontCache.h
Include Path #include "Fonts/FontCache.h"

Syntax

class FShapedGlyphSequence

Constructors

Name Remarks Include Path Unreal Specifiers

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

   Fonts/FontCache.h  
Non-copyable Fonts/FontCache.h  
  Fonts/FontCache.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FShapedGlyphSequence()

   Fonts/FontCache.h  

Structs

Name Remarks
FGlyphOffsetResult Return data used by GetGlyphAtOffset
FSourceIndexToGlyphData Contains the information needed when performing a reverse look-up from a source index to the corresponding shaped glyph
FSourceIndicesToGlyphData A map of source indices to their shaped glyph data indices.
FSourceTextRange  

Typedefs

Name Type Remarks Include Path
FForEachShapedGlyphEntryCallback TFunctionRef< bool(const FShapedGlyphEntry &, int32)>   Fonts/FontCache.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bMaterialIsStencil bool Toggles between stenciling text onto material output (false) or filling entire quads with material (true) Fonts/FontCache.h  
CachedFontSkew float The Font Skew parameter of the FontInfo applied to the this Shaped glype sequence Fonts/FontCache.h  
DebugFontMaterialName FName   Fonts/FontCache.h  
DebugOutlineMaterialName FName   Fonts/FontCache.h  
DebugSdfFontMaterialOverrideName FName   Fonts/FontCache.h  
FontMaterial TObjectPtr< const UObject > The material to use when rendering these glyphs Fonts/FontCache.h  
FontMaterialWeakPtr TWeakObjectPtr< const UObject > Used to guard against crashes when the material object is deleted. This is expensive so we do not do it in shipping. Fonts/FontCache.h  
GlyphFontFaces TArray< TWeakPtr< FFreeTypeFace > > The set of fonts being used by the glyphs within this sequence Fonts/FontCache.h  
GlyphsToRender TArray< FShapedGlyphEntry > Array of glyphs in this sequence. Fonts/FontCache.h  
MaxTextHeight uint16 The maximum height of any glyph in the font we're using Fonts/FontCache.h  
OutlineMaterialWeakPtr TWeakObjectPtr< const UObject >   Fonts/FontCache.h  
OutlineSettings FFontOutlineSettings Outline settings to use when rendering these glyphs Fonts/FontCache.h  
SdfFontMaterialOverrideWeakPtr TWeakObjectPtr< const UObject >   Fonts/FontCache.h  
SequenceWidth int32 The cached width of the entire sequence Fonts/FontCache.h  
SourceIndicesToGlyphData FSourceIndicesToGlyphData A map of source indices to their shaped glyph data indices - used to perform efficient reverse look-up Fonts/FontCache.h  
TextBaseline int16 The baseline to use when drawing the glyphs in this sequence Fonts/FontCache.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

   Fonts/FontCache.h  

SIZE_T GetAllocatedSize()

 Get the amount of memory allocated to this sequence Fonts/FontCache.h  

const UObject * GetFontMaterial()

 Get the material to use when rendering these glyphs Fonts/FontCache.h  

const FFontOutlineSettings & GetFontOutlineSettings()

 Get the font outline settings to use when rendering these glyphs Fonts/FontCache.h  

float GetFontSkew()

 Get the font skew applied when this glyph sequence was shaped Fonts/FontCache.h  

TOptional< FGlyphOffsetResult > GetGlyphAtOffset ( FSlateFontCache& InFontCache,
const int32 InStartIndex,
const int32 InEndIndex,
const int32 InHorizontalOffset,
const int32 InStartOffset,
const bool InIncludeKerningWithPrecedingGlyph
) const

 Get the information for the glyph at the specified position in pixels along the string horizontally Fonts/FontCache.h  

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

 Get the information for the glyph at the specified position in pixels along the string horizontally Fonts/FontCache.h  
Get the array of glyphs in this sequence. Fonts/FontCache.h  

TOptional< int8 > GetKerning ( const int32 InIndex
) const

 Get the kerning value between the given entry and the next entry in the sequence Fonts/FontCache.h  

uint16 GetMaxTextHeight()

 Get the maximum height of any glyph in the font we're using Fonts/FontCache.h  

TOptional< int32 > GetMeasuredWidth ( const int32 InStartIndex,
const int32 InEndIndex,
const bool InIncludeKerningWithPrecedingGlyph
) const

 Get the measured width of the specified range of this shaped text Fonts/FontCache.h  

int32 GetMeasuredWidth ()

 Get the measured width of the entire shaped text Fonts/FontCache.h  

FShapedGlyphSequencePtr GetSubSequence ( const int32 InStartIndex,
const int32 InEndIndex
) const

 Get a sub-sequence of the specified range Fonts/FontCache.h  

int16 GetTextBaseline()

 Get the baseline to use when drawing the glyphs in this sequence Fonts/FontCache.h  

bool IsDirty()

 Check to see whether this glyph sequence is dirty (ie, contains glyphs with invalid font pointers) Fonts/FontCache.h  

bool IsMaterialStencil()

 Get "Material is stencil" flag Fonts/FontCache.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Fonts/FontCache.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page