【Unity】WebGLのフレームレート設定の落とし穴と解決方法

WebGLでの実行フレームレート設定は、iOS / AndroidやPCと同じ方法だと動きません。
unityroomで公開するときに重要となるので、対応方法と、フレームレート設定コンポーネントを紹介します。

※環境: Unity 2022.3.21f1

1. WebGLビルドでFPS指定が動かない
2. フレームレート指定が動かない原因
- 2.1. WebGL対応フレームレート指定コード
3. まとめ
- 3.1. FPSのお手軽確認
- 3.2. フレームレート指定コンポーネントTargetFPS.cs

WebGLビルドでFPS指定が動かない

WebGLで動かないコード

TargetFPSコンポーネント
貼り付けるとInspactorからFPS指定できるコンポーネント

using UnityEngine;
using UniRx;

public class TargetFPS : MonoBehaviour
{
    public int FrameRate = 60;

    private void Awake()
    {
        // フレームレートを設定する
        Application.targetFrameRate = FrameRate;

        // フレームレートが変更されたら、反映する
        this.ObserveEveryValueChanged(x => x.FrameRate)
            .Subscribe(_ => Application.targetFrameRate = FrameRate);
    }
}

iOS / Android / PCなどでは、こちらで問題なく動作
WebGLだと効果がなく、60fps指定が無効になってしまう
- レベルアップランのunityroom版で144fpsになり重くなっていることから発覚しました。

フレームレート指定が動かない原因

以下の書き込みで、原因と対応についても情報がありました。
targetFrameRate not working in 2021.3.1 LTS WebGL – Unity Engine – Unity Discussions

WebGLで以下のどちらかを満たす場合、強制的にモニターのリフレッシュレートが参照されてしまうようです。

QualitySettings.vSyncCount != 0
60 % Application.targetFrameRate == 0

つまり、任意のFPSを指定するには

vSyncCountが OFF
60 ÷ targetFrameRate が割り切れない
- 60fps, 30fps, 15fpsは割り切れるのでNG
- 59fps, 29fps, 14fpsならOK

WebGL対応フレームレート指定コード

using UnityEngine;
using UniRx;

public class TargetFPS : MonoBehaviour
{
    public int FrameRate = 60;

    private void Awake()
    {
        UpdateFPS();
        this.ObserveEveryValueChanged(x => x.FrameRate)
            .Subscribe(_ => UpdateFPS());
    }

    private void UpdateFPS()
    {
#if UNITY_WEBGL
        // https://discussions.unity.com/t/targetframerate-not-working-in-2021-3-1-lts-webgl/881482
        // WebGLだとvSyncCountを0にし、60fpsではなく59fpsにしないと正常に動作しない
        QualitySettings.vSyncCount = 0;
        int frameRate = FrameRate;
        if (60 % FrameRate == 0)
        {
            --frameRate; // 割り切れる場合は、-1しておく
        }
        Application.targetFrameRate = frameRate;
#else
        Application.targetFrameRate = FrameRate;
#endif
    }
}

これで、どのプラットフォームでもフレームレートを正しく指定できるようになりました。