#unity TextMeshPro内の低レイヤ処理クラスFontEngineの隠しメソッドにリフレクションでアクセスする（TextMeshPro Deep Dive #3）

　この記事はUnityアドベントカレンダー2024（シリーズ３）１２日目の記事です。空いてたので埋めさせていただきました。

　今回の記事はこちらのエントリの内容をベースにした物になります。

TextMeshProの内部処理

　TextMeshPro（以下TMP）は、Unityの標準文字描画ライブラリです。以前は独立したパッケージでしたが、Unity2023.2からuguiパッケージの一部になりました。また将来的にはUnity本体のTextCoreに取り込まれる予定のようです。詳しくは下記を参照。

コラム：TextMeshProの落とし穴

madnesslabo.net

　さて、TMPは大きくわけて以下の２つの機能から構成されています。

Ａ：フォントファイル（.ttf）を元にTMP_FontAssetファイルを生成する
Ｂ：TMP_FontAssetファイルを読み込んで任意の文字を画面に描画する

　基本的に、Ａは開発時、Ｂはゲーム実行時の処理になります*1。

　今回はＡについての話です。

FontEngineクラス

　TMP_FontAssetは、収録した文字についての情報と、その文字を描画したテクスチャを保持するアセットです。このアセットを作成するには当然フォントファイル（.ttf）を解析する必要があり、その処理はFontEngineというUnityネイティブクラスで行われています。

docs.unity3d.com

　FontEngineはUnityEngine.TextCore.LowLevel名前空間に配置されている、文字通り低レベル層での文字処理機能を提供するstaticクラスです。フォント情報（FontFace）や個々の文字情報（Glyph）の取得だけでなく、文字をテクスチャ（Texture2D）に描画する機能もあります。TMPはFontEngineを介してフォントの情報を抽出し、TMP_FontAssetを作成しています。

　FontEngineクラスは公式ドキュメント上は12個のメソッドが提供されています。しかし、それらのメソッドだけではTMP_FontAssetの生成に必要な機能が足りません。ではTMPがどうしているかというと、ドキュメントに記載されていない複数のメソッドにアクセスしているのです。これらを便宜上「隠しメソッド」と呼ぶ事にします。

　これらの隠しメソッドはinternal指定で実装されています。TMPが含まれるアセンブリはFontEngineへのinteralメソッドへの参照が許可されています*2。しかし、そうでない外部アセンブリからは隠しメソッドに直接アクセス出来ないため、リフレクションを使う必要があります。

　今回、TMP_FontAssetCreatorWindowクラスの機能を独自実装しようとしてこの問題にひっかかりまして、冒頭の記事のおかげで必要なプロクシクラスを実装して解決できました（ありがとうございます）。

FontEngineProxyクラス

ソースコード

　今回土屋が作成したプロクシクラスはこちらになります。

FontEngineProxy.cs · GitHub

解説

　ベタ書きで解説も無く恐縮ですが、コードサンプルとしてお使いください。なお、作業に必要な分のみ実装していて、FontEngineの隠しメソッドを網羅しているわけではありません。

　試しにFontEngine.RenderGlyphToTexture()にアクセスするコードは以下になります。

    //↓このintenrnal隠しメソッドにアクセスする。
    //internal static FontEngineError RenderGlyphToTexture(Glyph glyph, int padding, GlyphRenderMode renderMode, Texture2D texture)

    //隠しメソッドへの参照を格納するデリゲートを宣言
    private static Func<Glyph, int, GlyphRenderMode, Texture2D, FontEngineError> dRenderGlyphToTexture;

    //プロクシメソッド本体。引数は隠しメソッドと統一
    public static FontEngineError RenderGlyphToTexture(
        Glyph glyph,
        int padding,
        GlyphRenderMode renderMode,
        Texture2D texture)
    {
        //初アクセスの場合はデリゲートを初期化する。
        if (dRenderGlyphToTexture == null)
        {
            //メソッドへの参照を取得
            var method =
                typeof(FontEngine).GetMethod("RenderGlyphToTexture", BindingFlags.Static | BindingFlags.NonPublic);
            //デリゲートを初期化
            dRenderGlyphToTexture =
                (Func<Glyph, int, GlyphRenderMode, Texture2D, FontEngineError>)Delegate.CreateDelegate(
                    typeof(Func<List<Glyph>, int, GlyphRenderMode, Texture2D, FontEngineError>),
                    null, method);
        }
        //隠しメソッドを呼び出す
        return dRenderGlyphToTexture.Invoke(glyph, padding, renderMode, texture);
    }

　使い方は簡単でFontEngine.RenderGlyphsToTexture()にアクセスしたい場合にFontEngineProxy.RenderGlyphsToTexture()を呼ぶだけです。

　コメントアウトしてある３箇所について簡単に説明します。

　RenderGlyphsToTexture()は引数４個版と６個版が多重定義されてまして、結果的に４個版が土屋が必要なコードフローを通らず検証出来なかったのでコメントアウトしました（多分動きません）。多重定義されたメソッドをリフレクションで呼び出す場合には引数の型指定が余分に必要でして、コメントアウトしてない方のRenderGlyphsToTexture()でその指定が入っています。

　GetLigatureSubstitutionRecords()とGetMarkToBaseAdjustmentRecords()については、メソッドだけでなく戻り値もFontEngine内のinternalな構造体だったため、実装方法がわからず諦めました。これって、構造体のメンバ１つずつを愚直にリフレクションで取得するしか無いのでは？（そんな面倒なことやりたくない）。まあこの辺はいいかな……。