FpsToText :: Free FPS / Framerate calculator with options

Scripting
1

I was curious about options related to framerate reporting and interested in making a script with a tiny footprint and lots of options so I whipped one up.

Features

  • Target UI.Text components
  • Sample lots of frames
  • Sample the current frame
  • Alternate between smoothDeltaTime and deltaTime
  • Apply thresholds to change text color if values fall below them
  • Specify the max number of characters in the resulting string.
  • Specify the update frequency (frames)

Note: This reports fps for the current environment, so the build is accurate, but in the editor it includes time spent rendering the entire editor. You will see lower fps in the Editor but the stats window will show a higher framerate since it supposedly does not include time spent on Editor stuff.

The Sample Size is how many frames to average across. You won’t see a value until this many frames has pass to populate valid data. If you just want the last frame’s data, turn off Group Sampling.

3013391--224875--fps.png
3013391--224875--fps.png702×52 4.61 KB

3013391--224878--fps2.png

using System.Globalization;
using UnityEngine;
using UnityEngine.UI;

namespace Performance
{
    /// <summary>
    /// <para>Pushes the Framerate value to a Text component.</para>
    /// </summary>
    public class FpsToText : MonoBehaviour
    {
        [Header("// Sample Groups of Data ")]
        public bool GroupSampling = true;
        public int SampleSize = 20;

        [Header("// Config ")]
        public Text TargetText;
        public int UpdateTextEvery = 1;
        public int MaxTextLength = 5;
        public bool Smoothed = true;
        public bool ForceIntResult = true;

        [Header("// System FPS (updates once/sec)")]
        public bool UseSystemTick = false;

        [Header("// Color Config ")]
        public bool UseColors = true;
        public Color Good = Color.green;
        public Color Okay = Color.yellow;
        public Color Bad = Color.red;
        public int OkayBelow = 60;
        public int BadBelow = 30;

        public float Framerate { get { return _fps; } }

        protected float[] FpsSamples;
        protected int SampleIndex;
        protected int TextUpdateIndex;
        private float _fps;

        private int _sysLastSysTick;
        private int _sysLastFrameRate;
        private int _sysFrameRate;

        protected virtual void Reset()
        {
            SampleSize = 20;
            UpdateTextEvery = 1;
            MaxTextLength = 5;
            Smoothed = true;
            UseColors = true;
            Good = Color.green;
            Okay = Color.yellow;
            Bad = Color.red;
            OkayBelow = 60;
            BadBelow = 30;
            UseSystemTick = false;
            ForceIntResult = true;
        }

        protected virtual void Start()
        {
            FpsSamples = new float[SampleSize];
            for (int i = 0; i < FpsSamples.Length; i++) FpsSamples[i] = 0.001f;
            if (!TargetText) enabled = false;
        }

        protected virtual void Update()
        {
            if (GroupSampling) Group();
            else SingleFrame();

            string fps = _fps.ToString(CultureInfo.CurrentCulture);

            SampleIndex = SampleIndex < SampleSize-1 ? SampleIndex + 1 : 0;
            TextUpdateIndex = TextUpdateIndex > UpdateTextEvery ? 0 : TextUpdateIndex + 1;
            if (TextUpdateIndex == UpdateTextEvery) TargetText.text = fps.Substring(0, fps.Length < 5 ? fps.Length : 5);

            if (!UseColors) return;
            if (_fps < BadBelow)
            {
                TargetText.color = Bad;
                return;
            }
            TargetText.color = _fps < OkayBelow ? Okay : Good;
        }

        protected virtual void SingleFrame()
        {
            _fps = UseSystemTick
                ? GetSystemFramerate()
                : Smoothed ? 1 / Time.smoothDeltaTime : 1 / Time.deltaTime;
            if (ForceIntResult) _fps = (int) _fps;
        }

        protected virtual void Group()
        {
            FpsSamples[SampleIndex] = UseSystemTick
                ? GetSystemFramerate()
                : Smoothed ? 1 / Time.smoothDeltaTime : 1 / Time.deltaTime;

            _fps = 0;
            bool loop = true;
            int i = 0;
            while (loop)
            {
                if (i == SampleSize - 1) loop = false;
                _fps += FpsSamples[i];
                i++;
            }
            _fps /= FpsSamples.Length;
            if (ForceIntResult) _fps = (int)_fps;
        }

        protected virtual int GetSystemFramerate()
        {
            if (System.Environment.TickCount - _sysLastSysTick >= 1000)
            {
                _sysLastFrameRate = _sysFrameRate;
                _sysFrameRate = 0;
                _sysLastSysTick = System.Environment.TickCount;
            }
            _sysFrameRate++;
            return _sysLastFrameRate;
        }
    }
}

With Optional Zero Alloc toggle

using System.Globalization;
using UnityEngine;
using UnityEngine.UI;

namespace Performance
{
    /// <summary>
    /// <para>Pushes the Framerate value to a Text component.</para>
    /// </summary>
    public class FpsToText : MonoBehaviour
    {
        [Header("// Sample Groups of Data ")]
        public bool GroupSampling = true;
        public int SampleSize = 20;

        [Header("// Config ")]
        public Text TargetText;
        public int UpdateTextEvery = 1;
        public int MaxTextLength = 5;
        public bool Smoothed = true;
        public bool ForceIntResult = true;
        public bool ZeroAllocOnly = false;

        [Header("// System FPS (updates once/sec)")]
        public bool UseSystemTick = false;

        [Header("// Color Config ")]
        public bool UseColors = true;
        public Color Good = Color.green;
        public Color Okay = Color.yellow;
        public Color Bad = Color.red;
        public int OkayBelow = 60;
        public int BadBelow = 30;

        public float Framerate { get { return _fps; } }

        protected float[] FpsSamples;
        protected int SampleIndex;
        protected int TextUpdateIndex;
        private float _fps;

        private int _sysLastSysTick;
        private int _sysLastFrameRate;
        private int _sysFrameRate;
        private string _localfps;

        private static readonly string[] FpsStringMap = {
            "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
            "10", "11", "12", "13", "14", "15", "16", "17", "18", "19",
            "20", "21", "22", "23", "24", "25", "26", "27", "28", "29",
            "30", "31", "32", "33", "34", "35", "36", "37", "38", "39",
            "40", "41", "42", "43", "44", "45", "46", "47", "48", "49",
            "50", "51", "52", "53", "54", "55", "56", "57", "58", "59",
            "60", "61", "62", "63", "64", "65", "66", "67", "68", "69",
            "70", "71", "72", "73", "74", "75", "76", "77", "78", "79",
            "80", "81", "82", "83", "84", "85", "86", "87", "88", "89",
            "90", "91", "92", "93", "94", "95", "96", "97", "98", "99",
            "100", "101", "102", "103", "104", "105", "106", "107", "108", "109",
            "110", "111", "122", "113", "114", "115", "116", "117", "118", "119",
            "120", "121", "132", "123", "124", "125", "126", "127", "128", "129",
            "130", "131", "142", "133", "134", "135", "136", "137", "138", "139",
            "140", "141", "152", "143", "144", "145", "146", "147", "148", "149",
            "150", "151", "162", "153", "154", "155", "156", "157", "158", "159",
            "160", "161", "172", "163", "164", "165", "166", "167", "168", "169",
            "170", "171", "182", "173", "174", "175", "176", "177", "178", "179",
            "180", "181", "192", "183", "184", "185", "186", "187", "188", "189",
            "190", "191", "192", "193", "194", "195", "196", "197", "198", "199",
            "200", "201", "202", "203", "204", "205", "206", "207", "208", "209",
            "210", "211", "222", "213", "214", "215", "216", "217", "218", "219",
            "220", "221", "222", "223", "224", "225", "226", "227", "228", "229",
            "230", "231", "232", "233", "234", "235", "236", "237", "238", "239",
            "240", "241", "242", "243", "244", "245", "246", "247", "248", "249",
            "250", "251", "252", "253", "254", "255", "256", "257", "258", "259",
            "260", "261", "262", "263", "264", "265", "266", "267", "268", "269",
            "270", "271", "272", "273", "274", "275", "276", "277", "278", "279",
            "280", "281", "282", "283", "284", "285", "286", "287", "288", "289",
            "290", "291", "292", "293", "294", "295", "296", "297", "298", "299+"
        };

        protected virtual void Reset()
        {
            SampleSize = 20;
            UpdateTextEvery = 1;
            MaxTextLength = 5;
            Smoothed = true;
            UseColors = true;
            Good = Color.green;
            Okay = Color.yellow;
            Bad = Color.red;
            OkayBelow = 60;
            BadBelow = 30;
            UseSystemTick = false;
            ForceIntResult = true;
        }

        protected virtual void Start()
        {
            FpsSamples = new float[SampleSize];
            for (int i = 0; i < FpsSamples.Length; i++) FpsSamples[i] = 0.001f;
            if (!TargetText) enabled = false;
        }

        protected virtual void Update()
        {
            if (GroupSampling) Group();
            else SingleFrame();

            _localfps = ZeroAllocOnly ? FpsStringMap[Mathf.Clamp((int)_fps, 0, 299)] : _fps.ToString(CultureInfo.CurrentCulture);

            SampleIndex = SampleIndex < SampleSize-1 ? SampleIndex + 1 : 0;
            TextUpdateIndex = TextUpdateIndex > UpdateTextEvery ? 0 : TextUpdateIndex + 1;
            if (TextUpdateIndex == UpdateTextEvery) TargetText.text = _localfps.Substring(0, _localfps.Length < 5 ? _localfps.Length : 5);

            if (!UseColors) return;
            if (_fps < BadBelow)
            {
                TargetText.color = Bad;
                return;
            }
            TargetText.color = _fps < OkayBelow ? Okay : Good;
        }

        protected virtual void SingleFrame()
        {
            _fps = UseSystemTick
                ? GetSystemFramerate()
                : Smoothed ? 1 / Time.smoothDeltaTime : 1 / Time.deltaTime;
            if (ForceIntResult) _fps = (int) _fps;
        }

        protected virtual void Group()
        {
            FpsSamples[SampleIndex] = UseSystemTick
                ? GetSystemFramerate()
                : Smoothed ? 1 / Time.smoothDeltaTime : 1 / Time.deltaTime;

            _fps = 0;
            bool loop = true;
            int i = 0;
            while (loop)
            {
                if (i == SampleSize - 1) loop = false;
                _fps += FpsSamples[i];
                i++;
            }
            _fps /= FpsSamples.Length;
            if (ForceIntResult) _fps = (int)_fps;
        }

        protected virtual int GetSystemFramerate()
        {
            if (System.Environment.TickCount - _sysLastSysTick >= 1000)
            {
                _sysLastFrameRate = _sysFrameRate;
                _sysFrameRate = 0;
                _sysLastSysTick = System.Environment.TickCount;
            }
            _sysFrameRate++;
            return _sysLastFrameRate;
        }
    }
}

Have fun!

4 Likes
Most efficient and up-to-date FPS counter?
Finding EXACT FPS through script
2

This looks like a really cool script and want to try it out but it gives me 2 errors:

3013462--224884--Untitled.png
3013462--224884--Untitled.png870×262 12.7 KB

1 Like
3

I’ll definitely be wanting this.
As for the errors, the first one is simple enough (If I understand what is being done, which I think I do)

for (int i = 0; i < FpsSamples.Length; i++) FpsSamples[i] = 0.001f;

I’m assuming we’re resetting the values in the array.
I -think- it’s something similar on line 93 (94 in the provided script)

_fps += FpsSamples[i];

But I’m not sure about that one.

1 Like
4

Ahhh I know what happened, I edited the post and screwed the code brackets up, so the {i} registered as a UBB italic box and disappeared.

Anyway, I fixed the OP - thanks for pointing it out.

5

Added a toggle to read the System Ticks instead of the Time class. Seems basically identical, but I was curious.

6

Added a version with zero runtime alloc by using a string map containing numbers and pointing the fps to that as an index, thus bypassing the .ToString() method.

I might have a problem…

2 Likes
7

Some time after this post, but wanted to thank you. Specially the zero runtime alloc, genius haha

1 Like
8

Here’s a small update to this. Removed some unused things and made zero-alloc the default. Instead of looking to a pre-built string array it just creates the string array at startup based on how many values you want to allocate, then clamps the results inside those values.

using UnityEngine;
using UnityEngine.UI;

namespace Cleverous.Shared
{
    /// <summary>
    /// <para>Pushes the Framerate value to a Text component.</para>
    /// </summary>
    public class FpsToText : MonoBehaviour
    {
        [Header("// Sample Groups of Data ")]
        [Tooltip("Instead of reporting a specific framerate, this will sample many frames and report the average.")]
        public bool GroupSampling;

        [Tooltip("If Group Sampling is on, how many frames would you want to sample to report an average on?")]
        [Range(0, 20)]
        public int SampleSize;

        [Header("// Config ")]
        [Tooltip("The Text Component you want the result pushed to. If you're using TMP then you need to change this in the code to a TMP_Text component instead.")]
        public Text TargetText;

        [Tooltip("How often (in frames) do you want to update the Text component?")]
        [Range(1, 20)]
        public int UpdateTextEvery;

        [Tooltip("This will smooth out the results so they blend together between updates and are easier to read.")]
        public bool Smoothed;

        [Tooltip("This sets how many numbers are buffered into memory as strings in order to obtain zero allocations at runtime.\n\nAlthough this is trivial in memory usage, realistically, there's no reason to be over 1000.")]
        [Range(0, 1000)]
        public int NumberBufferSize;

        [Header("// System FPS (updates once/sec)")]
        [Tooltip("Would you like to read the System Tick instead of calculating it in this script?\n\nTests show that differences are negligible, but the option remains available to you.")]
        public bool UseSystemTick;

        [Header("// Color Config ")]
        [Tooltip("Optionally change the color of the TargetText based on FPS performance.")]
        public bool UseColors;
        [Tooltip("If the framerate is above 'OkayBelow' it will be the 'Good' color.")]
        public Color Good;
        [Tooltip("If the framerate is below 'OkayBelow' it will be the 'Okay' color.")]
        public Color Okay;
        [Tooltip("If the framerate is below 'BadBelow' it will be the 'Bad' color.")]
        public Color Bad;
        [Tooltip("Threshold for defining an 'okay' framerate. Below this value is considered okay, but not high enough to be good, and not low enough to be bad.")]
        public int OkayBelow;
        [Tooltip("Threshold for defining an 'bad' framerate. Below this value is considered bad.")]
        public int BadBelow;

        public int Framerate { get; private set; }

        protected int[] FpsSamples;
        protected int SampleIndex;
        protected int TextUpdateIndex;

        private int m_sysLastSysTick;
        private int m_sysLastFrameRate;
        private int m_sysFrameRate;
        private string m_localfps;

        private static string[] m_numbers;

        protected virtual void Reset()
        {
            GroupSampling = true;
            SampleSize = 20;
            UpdateTextEvery = 1;
            Smoothed = true;
            UseColors = true;

            Good = Color.green;
            Okay = Color.yellow;
            Bad = Color.red;

            OkayBelow = 60;
            BadBelow = 30;

            UseSystemTick = false;
            NumberBufferSize = 1000;
        }

        protected virtual void Start()
        {
            m_numbers = new string[NumberBufferSize];
            for (int i = 0; i < NumberBufferSize; i++) m_numbers[i] = i.ToString();

            FpsSamples = new int[SampleSize];
            for (int i = 0; i < FpsSamples.Length; i++) FpsSamples[i] = 1;
            if (!TargetText) enabled = false;
        }

        protected virtual void Update()
        {
            if (GroupSampling) Group();
            else SingleFrame();

            m_localfps = m_numbers[Framerate];

            SampleIndex = SampleIndex < SampleSize-1 ? SampleIndex + 1 : 0;
            TextUpdateIndex = TextUpdateIndex > UpdateTextEvery ? 0 : TextUpdateIndex + 1;
            if (TextUpdateIndex == UpdateTextEvery) TargetText.text = m_localfps;

            if (!UseColors) return;
            if (Framerate < BadBelow)
            {
                TargetText.color = Bad;
                return;
            }
            TargetText.color = Framerate < OkayBelow ? Okay : Good;
        }

        protected virtual void SingleFrame()
        {
            Framerate = Mathf.Clamp(UseSystemTick
                ? GetSystemFramerate()
                : (int)(Smoothed
                    ? 1 / Time.smoothDeltaTime
                    : 1 / Time.deltaTime),
                0,
                m_numbers.Length-1);
        }

        protected virtual void Group()
        {
            FpsSamples[SampleIndex] = Mathf.Clamp(UseSystemTick
                ? GetSystemFramerate()
                : (int)(Smoothed
                    ? 1 / Time.smoothDeltaTime
                    : 1 / Time.deltaTime),
                0,
                m_numbers.Length-1);

            Framerate = 0;
            bool loop = true;
            int i = 0;
            while (loop)
            {
                if (i == SampleSize - 1) loop = false;
                Framerate += FpsSamples[i];
                i++;
            }
            Framerate /= FpsSamples.Length;
        }

        protected virtual int GetSystemFramerate()
        {
            if (System.Environment.TickCount - m_sysLastSysTick >= 1000)
            {
                m_sysLastFrameRate = m_sysFrameRate;
                m_sysFrameRate = 0;
                m_sysLastSysTick = System.Environment.TickCount;
            }
            m_sysFrameRate++;
            return m_sysLastFrameRate;
        }
    }
}
2 Likes
9

Moved to a gist

2 Likes