Class Window | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class Window

    Inheritance
    System.Object
    Window
    WindowAdapter
    Namespace: Unity.UIWidgets.ui
    Syntax
    public abstract class Window

    Fields

    _antiAliasing

    Declaration
    protected int _antiAliasing
    Field Value
    Type Description
    System.Int32

    _devicePixelRatio

    Declaration
    protected float _devicePixelRatio
    Field Value
    Type Description
    System.Single

    _locales

    Declaration
    protected List<Locale> _locales
    Field Value
    Type Description
    System.Collections.Generic.List<Locale>

    _padding

    Declaration
    protected WindowPadding _padding
    Field Value
    Type Description
    WindowPadding

    _physicalSize

    Declaration
    protected Size _physicalSize
    Field Value
    Type Description
    Size

    _textScaleFactor

    Declaration
    protected float _textScaleFactor
    Field Value
    Type Description
    System.Single

    _viewInsets

    Declaration
    protected WindowPadding _viewInsets
    Field Value
    Type Description
    WindowPadding

    defaultAntiAliasing

    Declaration
    public const int defaultAntiAliasing = 4
    Field Value
    Type Description
    System.Int32

    defaultMaxTargetFrameRate

    Declaration
    public const int defaultMaxTargetFrameRate = 60
    Field Value
    Type Description
    System.Int32

    defaultMinTargetFrameRate

    Declaration
    public const int defaultMinTargetFrameRate = 25
    Field Value
    Type Description
    System.Int32

    Properties

    antiAliasing

    Declaration
    public int antiAliasing { get; }
    Property Value
    Type Description
    System.Int32

    devicePixelRatio

    Declaration
    public float devicePixelRatio { get; }
    Property Value
    Type Description
    System.Single

    hasInstance

    Declaration
    public static bool hasInstance { get; }
    Property Value
    Type Description
    System.Boolean

    instance

    Declaration
    public static Window instance { get; set; }
    Property Value
    Type Description
    Window

    locale

    Declaration
    public Locale locale { get; }
    Property Value
    Type Description
    Locale

    locales

    Declaration
    public List<Locale> locales { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<Locale>

    onBeginFrame

    Declaration
    public FrameCallback onBeginFrame { get; set; }
    Property Value
    Type Description
    FrameCallback

    onDrawFrame

    Declaration
    public VoidCallback onDrawFrame { get; set; }
    Property Value
    Type Description
    VoidCallback

    onFrameRateCoolDown

    Declaration
    public static Action onFrameRateCoolDown { get; set; }
    Property Value
    Type Description
    System.Action

    onFrameRateSpeedUp

    Declaration
    public static Action onFrameRateSpeedUp { get; set; }
    Property Value
    Type Description
    System.Action

    onLocaleChanged

    Declaration
    public VoidCallback onLocaleChanged { get; set; }
    Property Value
    Type Description
    VoidCallback

    onMetricsChanged

    Declaration
    public VoidCallback onMetricsChanged { get; set; }
    Property Value
    Type Description
    VoidCallback

    onPointerEvent

    Declaration
    public PointerDataPacketCallback onPointerEvent { get; set; }
    Property Value
    Type Description
    PointerDataPacketCallback

    onTextScaleFactorChanged

    Declaration
    public VoidCallback onTextScaleFactorChanged { get; set; }
    Property Value
    Type Description
    VoidCallback

    padding

    Declaration
    public WindowPadding padding { get; }
    Property Value
    Type Description
    WindowPadding

    physicalSize

    Declaration
    public Size physicalSize { get; }
    Property Value
    Type Description
    Size

    textScaleFactor

    Declaration
    public float textScaleFactor { get; }
    Property Value
    Type Description
    System.Single

    viewInsets

    Declaration
    public WindowPadding viewInsets { get; }
    Property Value
    Type Description
    WindowPadding

    Methods

    flushMicrotasks()

    Declaration
    public abstract void flushMicrotasks()

    getFPS()

    Declaration
    public float getFPS()
    Returns
    Type Description
    System.Single

    getScope()

    Declaration
    public abstract IDisposable getScope()
    Returns
    Type Description
    System.IDisposable

    periodic(TimeSpan, Action)

    Declaration
    public Timer periodic(TimeSpan duration, Action callback)
    Parameters
    Type Name Description
    System.TimeSpan duration
    System.Action callback
    Returns
    Type Description
    Timer

    render(Scene)

    Declaration
    public abstract void render(Scene scene)
    Parameters
    Type Name Description
    Scene scene

    run(Action)

    Declaration
    public Timer run(Action callback)
    Parameters
    Type Name Description
    System.Action callback
    Returns
    Type Description
    Timer

    run(TimeSpan, Action, Boolean)

    Declaration
    public abstract Timer run(TimeSpan duration, Action callback, bool periodic = false)
    Parameters
    Type Name Description
    System.TimeSpan duration
    System.Action callback
    System.Boolean periodic
    Returns
    Type Description
    Timer

    runInMain(Action)

    Declaration
    public abstract Timer runInMain(Action callback)
    Parameters
    Type Name Description
    System.Action callback
    Returns
    Type Description
    Timer

    scheduleFrame(Boolean)

    Declaration
    public abstract void scheduleFrame(bool regenerateLayerTree = true)
    Parameters
    Type Name Description
    System.Boolean regenerateLayerTree

    scheduleMicrotask(Action)

    Declaration
    public abstract void scheduleMicrotask(Action callback)
    Parameters
    Type Name Description
    System.Action callback

    updateFPS(Single)

    Declaration
    public void updateFPS(float unscaledDeltaTime)
    Parameters
    Type Name Description
    System.Single unscaledDeltaTime

    Extension Methods

    Coroutine.startCoroutine(Window, IEnumerator)
    Coroutine.startBackgroundCoroutine(Window, IEnumerator)
    Back to top
    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