Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Application.targetFrameRate

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static var targetFrameRate: int;
public static int targetFrameRate;

Description

Instructs game to try to render at a specified frame rate.

The default targetFrameRate is a special value -1, which indicates that the game should render at the platform's default frame rate. This default rate depends on the platform:

- On standalone platforms the default frame rate is maximum achievable frame rate.

- On mobile platforms the default frame rate is less than the maximum achievable frame rate due to need to conserve battery power. Typically on mobile platforms the default frame rate is 30 frames per second.

- On WebGL the default value lets the browser choose the frame rate to match its render loop timing which generally produces the smoothest results. Non-default values are only recommended if you want to throttle CPU usage on WebGL.

- When using VR Unity will use the target frame rate specified by the SDK and ignore values specified by the game.

Setting targetFrameRate does not guarantee that frame rate will be achieved. There can be fluctuations due to platform specifics, or the game might not achieve the frame rate because the computer is too slow.

Additionally if the QualitySettings.vSyncCount property is set, the targetFrameRate will be ignored and instead the game will use the vSyncCount and the platform's default render rate to determine the target frame rate. For example, if the platform's default render rate is 60 frames per second and vSyncCount is set to 2, the game will target 30 frames per second.

In the editor, targetFrameRate affects only the Game window. It has no effect on other editor windows.

    function Awake () {
        // Make the game run as fast as possible
        Application.targetFrameRate = 300;
    }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Awake() { Application.targetFrameRate = 300; } }