SlateFontRenderer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Fonts/SlateFontInfo.h"
#include "Fonts/FontCacheFreeType.h"
 
class FCompositeFontCache;
 
struct FFreeTypeFaceGlyphData
{
    TSharedPtr<FFreeTypeFace> FaceAndMemory;
 
    uint32 GlyphIndex;
 
    uint32 GlyphFlags;
 
    EFontFallback CharFallbackLevel;
 
    FFreeTypeFaceGlyphData()
        : FaceAndMemory()
        , GlyphIndex(0)
        , GlyphFlags(0)
        , CharFallbackLevel(EFontFallback::FF_NoFallback)
    {
    }
};
 
namespace SlateFontRendererUtils
{
 
inline const TCHAR InvalidSubChar = TEXT('\uFFFD');
 
#if WITH_FREETYPE
 
void AppendGlyphFlags(const FFreeTypeFace& InFace, const FFontData& InFontData, uint32& InOutGlyphFlags);
 
#endif // WITH_FREETYPE
 
} // namespace SlateFontRendererUtils
 
 
class FSlateFontRenderer
{
public:
    FSlateFontRenderer(const FFreeTypeLibrary* InFTLibrary, FFreeTypeCacheDirectory* InFTCacheDirectory, FCompositeFontCache* InCompositeFontCache);
 
    uint16 GetMaxHeight(const FSlateFontInfo& InFontInfo, const float InScale) const;
 
    int16 GetBaseline(const FSlateFontInfo& InFontInfo, const float InScale) const;
 
    void GetUnderlineMetrics(const FSlateFontInfo& InFontInfo, const float InScale, int16& OutUnderlinePos, int16& OutUnderlineThickness) const;
 
    void GetStrikeMetrics(const FSlateFontInfo& InFontInfo, const float InScale, int16& OutStrikeLinePos, int16& OutStrikeLineThickness) const;
 
    bool HasKerning(const FFontData& InFontData) const;
 
    int8 GetKerning(const FFontData& InFontData, const float InSize, TCHAR First, TCHAR Second, const float InScale) const;
 
    TSharedPtr<FFreeTypeKerningCache> GetKerningCache(const FFontData& InFontData, const uint32 InFontRenderSize) const;
 
    bool CanLoadCodepoint(const FFontData& InFontData, const UTF32CHAR InCodepoint, EFontFallback MaxFallbackLevel) const;
 
#if WITH_FREETYPE
    FFreeTypeFaceGlyphData GetFontFaceForCodepoint(const FFontData& InFontData, const UTF32CHAR InCodepoint, EFontFallback MaxFallbackLevel) const;
#endif // WITH_FREETYPE
 
    bool GetRenderData(const FShapedGlyphEntry& InShapedGlyph, const FFontOutlineSettings& InOutlineSettings, FCharacterRenderData& OutRenderData) const;
 
private:
#if WITH_FREETYPE
    bool GetRenderDataInternal(const FFreeTypeFaceGlyphData& InFaceGlyphData, const float InScale, const FFontOutlineSettings& InOutlineSettings, FCharacterRenderData& OutRenderData) const;
 
    FT_Face GetFontFace(const FFontData& InFontData) const;
#endif // WITH_FREETYPE
 
    const FFreeTypeLibrary* FTLibrary;
    FFreeTypeCacheDirectory* FTCacheDirectory;
    FCompositeFontCache* CompositeFontCache;
};