【Unity】Text Mesh Pro で数字を表示する時に GC Allocの発生を防ぐことができる拡張メソッド作りました

2020年12月12日2021年4月1日C#.NET, Unity, 開発

Text Mesh Pro で数字を表示する時に GC Allocの発生を防ぐことができる拡張メソッド作りました。

Text Mesh Proで数字を表示される場合、GC Allocが発生します。
詳細は、いろんな方が記事に書いて頂いているのでそちらを参照してください。

テラシュールブログ様のリンク

【Unity】TextMeshProで「数字」をテキストで表現する時にGC Allocを発生させない2つ

今回はTextMeshProを使用する際に、UIに文章を表示する際のGCを抑えるアプローチについてです。数字を ...

http://tsubakit1.hateblo.jp/entry/2019/02/04/024231

また、TextMeshProでGC Allocを発生させない方法としてSetText関数が準備されていますが、float型の引数になっているため、
大きな整数値の場合は誤差が発生してしまいます。
こちらの詳細も他の方が既に記事にして頂いているので、そちらを参照してください。

まさかみブログ様のリンク

まさかみブログ | 【Unity】TextMeshPro.SetTextで表現できる整数値の限界

TextMeshProでGC Allocを発生させない方法としてSetTextはとても重宝します。しかしこの関数の引数はな ...

https://masakami.com/archives/2019/04/07/234/

上記２つの問題を解決した上で、メソッドにパラメータを渡すだけのシンプルな方法で数字を表示することができないか考えた結果、
関数内でSetCharArrayを呼び出す、Text Mesh Proの拡張メソッドを作成することにしました。
↓のリンクからリポジトリに飛べるようになっています。

TMProExtensions.cs

GitHub - honobonoK/TMProExtensions: TMProの拡張用クラスです。現在は数字をGCAlloc

TMProの拡張用クラスです。現在は数字をGCAlloc無しで表示できる機能が準備されています。. Contribute ...

https://github.com/honobonoK/TMProExtensions

以下に、ソースを記載しています。

// ----------------------------------------------------------------
// Copyright (c) 2020 ほのぼのきっし
//
// This software is released under the MIT License, see LICENSE.
// https://github.com/honobonoK/TMProExtensions/blob/main/LICENSE
// 
// TMProExtensions.cs
// Author honobonoK
// Version 1.0.0
// ----------------------------------------------------------------

using UnityEngine;
using UnityEngine.UI;
using TMPro;

namespace Honobono.Unity.Utils
{
    #region Extensions
    /// <summary>
    ///  TMPro 拡張用 クラス
    /// </summary>
    public static class TMProExtensions
    {
        /// <summary>
        ///  TextMeshProに数字を表示時、GC発生無しでテキスト更新する。
        /// （SetTextメソッドを利用した場合、UnityEditor上でGCが観測されるため）
        ///  ※ 常用対数利用のため、負の値は未サポートです。
        /// </summary>
        /// <param name="num">表示させたい数字</param>
        /// <param name="maxDigit">表示させたい数字のMax桁数の配列</param>
        public static void SetTextNonAlloc(this TextMeshProUGUI tmPro, int num, int[] maxDigit)
        {
            var digit = (num == 0) ? 1 : ((int)Mathf.Log10(num) + 1);
            for (int i = digit - 1; i >= 0; i--)
            {
                maxDigit[i] = (num % 10) + 48;
                num /= 10;
            }
            tmPro.SetCharArray(maxDigit, 0, digit);
        }
    }
    #endregion
}

// ----------------------------------------------------------------

// This software is released under the MIT License, see LICENSE.

// https://github.com/honobonoK/TMProExtensions/blob/main/LICENSE

// TMProExtensions.cs

// Author honobonoK

// Version 1.0.0

// ----------------------------------------------------------------

using UnityEngine;

using UnityEngine.UI;

using TMPro;

namespace Honobono.Unity.Utils

{

#region Extensions

/// <summary>

/// TMPro 拡張用クラス

/// </summary>

public static class TMProExtensions

{

/// <summary>

/// TextMeshProに数字を表示時、GC発生無しでテキスト更新する。

/// （SetTextメソッドを利用した場合、UnityEditor上でGCが観測されるため）

/// ※ 常用対数利用のため、負の値は未サポートです。

/// </summary>

/// <param name="num">表示させたい数字</param>

/// <param name="maxDigit">表示させたい数字のMax桁数の配列</param>

public static void SetTextNonAlloc(this TextMeshProUGUI tmPro, int num, int[] maxDigit)

{

var digit = (num == 0) ? 1 : ((int)Mathf.Log10(num) + 1);

for (int i = digit - 1; i >= 0; i--)

{

maxDigit[i] = (num % 10) + 48;

num /= 10;

}

tmPro.SetCharArray(maxDigit, 0, digit);

}

#endregion

}

使い方サンプルは以下になります。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using TMPro;
using Honobono.Unity.Utils;

public class TMProExtensionsSample : MonoBehaviour
{
    [SerializeField]
    TextMeshProUGUI TextMeshPro;
    int[] output = new int[3];

    void Start() { ShowText(999); }

    void ShowText(int num)
    {
        TextMeshPro.SetTextNonAlloc(num, output);
    }
}