class in UnityEditor.Overlays
Implements interfaces:ISerializationCallbackReceiver
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.
CloseOverlayCanvas is a container for collections of Overlays.
Every EditorWindow has an OverlayCanvas, but only windows that opt-in to Overlay support will display Overlays. See ISupportsOverlays for more information.
overlays | The Overlays in this canvas. |
overlaysEnabled | Returns true if overlays display in the window, or false if overlays are hidden. |
Add | Add an Overlay to this canvas. Added Overlays will be displayed in the associated EditorWindow until they are removed. |
OnAfterDeserialize | Invoked after OverlayCanvas is deserialized. |
OnBeforeSerialize | Invoked before OverlayCanvas will be serialized. This is used to store Overlay layout data. |
Remove | Remove an Overlay from this canvas. Removed Overlays are disassociated from OverlayCanvas and the related EditorWindow, but not destroyed. This means you are able to move a single Overlay between multiple windows. |
ResetOverlay | Resets the overlay to its default state. |
RestoreOverlay | Restores Overlay state according to the data parameter. |
ShowPopup | Displays an overlay as a pop-up in a EditorWindow. |
ShowPopupAtMouse | Displays an overlay as a pop-up in a EditorWindow at the mouse position. |
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.