Navigation
API > API/Runtime > API/Runtime/SlateCore
Information for rendering one glyph in a shaped text sequence
| Name | FShapedGlyphEntry |
| Type | struct |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Fonts/FontCache.h |
| Include Path | #include "Fonts/FontCache.h" |
Syntax
struct FShapedGlyphEntry
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsVisible | bool | True if this is a visible glyph that should be drawn. | Fonts/FontCache.h | |
| FontFaceData | TSharedPtr< FShapedGlyphFaceData > | Provides access to the FreeType face for this glyph (not available publicly) | Fonts/FontCache.h | |
| GlyphIndex | uint32 | The index of this glyph in the FreeType face | Fonts/FontCache.h | |
| Kerning | int8 | The "kerning" between this glyph and the next one in the sequence | Fonts/FontCache.h | |
| NumCharactersInGlyph | uint8 | The number of source characters represented by this glyph This is typically 1, however will be greater for ligatures, or may be 0 if a single character produces multiple glyphs | Fonts/FontCache.h | |
| NumGraphemeClustersInGlyph | uint8 | The number of source grapheme clusters represented by this glyph This is typically 1, however will be greater for ligatures, or may be 0 if a single character produces multiple glyphs | Fonts/FontCache.h | |
| SourceIndex | int32 | The index of this glyph from the source text. | Fonts/FontCache.h | |
| TextDirection | TextBiDi::ETextDirection | The reading direction of the text this glyph was shaped from | Fonts/FontCache.h | |
| XAdvance | int16 | The amount to advance in X before drawing the next glyph in the sequence | Fonts/FontCache.h | |
| XOffset | int16 | The offset to apply in X when drawing this glyph | Fonts/FontCache.h | |
| YAdvance | int16 | The amount to advance in Y before drawing the next glyph in the sequence | Fonts/FontCache.h | |
| YOffset | int16 | The offset to apply in Y when drawing this glyph | Fonts/FontCache.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedAtlasData | TWeakPtr< FShapedGlyphFontAtlasData > | Pointer to the cached atlas data for this glyph entry. | Fonts/FontCache.h | |
| CachedSdfFontAtlasData | TWeakPtr< FSdfGlyphFontAtlasData > | Fonts/FontCache.h | ||
| CachedSdfMetrics | FSdfGlyphFontAtlasData::FMetrics | Fonts/FontCache.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetBitmapRenderScale() |
Get any additional scale that should be applied when rendering this glyph | Fonts/FontCache.h | |
bool HasValidGlyph() |
Check whether this entry contains a valid glyph (non-zero, and not the SlateFontRendererUtils::InvalidSubChar glyph) | Fonts/FontCache.h |