docs.unity3d.com
    Show / Hide Table of Contents

    Interface IVariableRefreshRate

    Interface of the Samsung Variable Refresh Rate API.

    Namespace: UnityEngine.AdaptivePerformance.Samsung.Android
    Syntax
    public interface IVariableRefreshRate

    Properties

    CurrentRefreshRate

    The current display refresh rate.

    Declaration
    int CurrentRefreshRate { get; }
    Property Value
    Type Description
    Int32

    SupportedRefreshRates

    List of supported display refresh rates.

    Declaration
    int[] SupportedRefreshRates { get; }
    Property Value
    Type Description
    Int32[]

    Methods

    SetRefreshRateByIndex(Int32)

    Change the current display refresh rate to the value referenced by the given index from the list of supported refresh rates.

    Declaration
    bool SetRefreshRateByIndex(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    Boolean

    True if the display refresh rate was updated successfully, false otherwise. Returns false if the requested refresh rate is larger than the Application.targetFrameRate. Note: There is a delay before the actual refresh rate and the value of Screen.currentResolution.refreshRate are updated.

    Events

    RefreshRateChanged

    Event that is called if the current display refresh rate or the list of supported refresh rate is changed externally, for example by changing display settings.

    Declaration
    event VariableRefreshRateEventHandler RefreshRateChanged
    Event Type
    Type Description
    VariableRefreshRateEventHandler
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023