Version: 2021.3
LanguageEnglish
  • C#

QualitySettings.vSyncCount

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

Switch to Manual
public static int vSyncCount;

Description

The number of vertical syncs that should pass between each frame.

An integer.

The default value of QualitySettings.vSyncCount is 0. In the default case, Unity doesn't wait for vertical sync.

Otherwise, the value of vSyncCount must be 1, 2, 3, or 4.

In the Unity Editor, this corresponds to the VSync Count property under Project Settings > Quality > Other.

QualitySettings.vSyncCount specifies the number of screen refreshes your game allows to pass between frames. Depending on your target platform, use either vSyncCount or Application.targetFrameRate to set your application frame rate.

Mobile platforms ignore QualitySettings.vSyncCount. On mobile devices, when a frame is ready, it displays the next time the screen refreshes. You can use Application.targetFrameRate to control the frame rate on mobile platforms.

VR platforms ignore QualitySettings.vSyncCount. Instead, the VR SDK controls the frame rate.

See Also: Application.targetFrameRate

using UnityEngine;

public class Example : MonoBehaviour { void Start() { // Sync the frame rate to the screen's refresh rate QualitySettings.vSyncCount = 1; } }

See Also: Quality Settings.