Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

OverlayCanvasSettingsAttribute

class in UnityEditor.Overlays

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

Description

Attribute that defines the default settings to use in an Editor Window that supports overlays.

See also ISupportOverlays and OverlayCanvas.

using UnityEditor;
using UnityEditor.Overlays;

[OverlayCanvasSettings(defaultColor = new float[] {1, 0, 0, 0.8f}, defaultColorDark = new float[] { 1, 0, 0, 0.8f }, defaultColorLight = new float[] { 0, 0, 1, 0.8f })]
public class OverlayCanvasSettingsExample : EditorWindow, ISupportsOverlays
{
    [MenuItem("Test/Open Canvas Window")]
    static void OpenWindow()
    {
        GetWindow<OverlayCanvasSettingsExample>();
    }
}

Properties

Property Description
allowDynamicPanelBehaviorChangesDefines if the Displace Window behavior of dynamic panels can be modified for that window type.
defaultColorDefines the default background color of the Overlay for this window.
defaultColorDarkDefines the default background color of the Overlay for this window when the editor uses the dark theme.
defaultColorLightDefines the default background color of the Overlay for this window when the editor uses the Dark theme.
dynamicPanelBehaviorDefines the default DynamicPanelBehavior of the OverlayCanvas.

Constructors

Constructor Description
OverlayCanvasSettingsAttributeThe attribute that defines the default settings for an Editor Window that supports overlays.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961