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.
CloseFor 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.
CloseRepresents the number of vertical syncs that should pass between each frame.
An integer in the range of 0-4. By default, it is set to 1.
Desktop and WebvSyncCount
specifies the number of screen refreshes your game allows to pass between frames. In the Unity Editor, this corresponds to the VSync Count property under Project Settings > Quality > Other.
- If vSyncCount > 0
, then the field Application.targetFrameRate is ignored, and the effective frame rate is the native refresh rate of the display divided by vSyncCount
. If vSyncCount == 1
, rendering is synchronized to the vertical refresh rate of the display.
- If vSyncCount
is set to 0, Unity does not synchronize rendering to vertical sync, and the field Application.targetFrameRate is instead used to pace the rendered frames.
For example, if you're running the Editor on a 60 Hz display and vSyncCount == 2
, then the target frame rate is 30 frames per second.
Android and iOS: The vSyncCount
field is always ignored because mobile devices do not allow unsynchronized rendering. Use the Application.targetFrameRate field instead to control the frame rate.
VR platforms: Both vSyncCount
and Application.targetFrameRate are ignored. Instead, the VR SDK controls the frame rate.
Note: You can use Resolution.refreshRateRatio in the Screen.currentResolution property to query the screen's refresh rate for most platforms.
Varying display native refresh rate
While historically the native refresh rate for displays often stayed fixed, the new generation mobile devices, laptops, and desktop devices today can influence the native refresh rate of the display to change dynamically at runtime. For example:
Therefore, it is recommended to not hardcode anywhere in the game logic with an assumption that the display refresh rate that is seen at the game startup will persist throughout the lifetime of the application.
Additional resources: Application.targetFrameRate
using UnityEngine;
public class Example : MonoBehaviour { void Start() { // Render at half the refresh rate of the display (Desktop and Web platforms) QualitySettings.vSyncCount = 2; } }
Additional resources: Quality Settings.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.