Capture events inform you of the changes in the mouse capture state. UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit has two types of capture events:
When an element captures the mouse or pointer, it’s the only element that receives events from the pointing device until the device releases or loses the capture.
For example, if you click in a text box, the text box captures the mouse. The mouse can still move around the screen, but it won’t trigger events outside of the text box. As long as the text box has your mouse captured, it won’t trigger other events. When the user presses a button on the mouse outside of the text box, the box releases its mouse capture.
Event | Description | Trickles down | Bubbles up | Cancellable |
---|---|---|---|---|
MouseCaptureEvent | Sent when an element takes the mouse capture. | ✔ | ✔ | |
MouseCaptureOutEvent | Sent when an element releases or otherwise loses the mouse capture. | ✔ | ✔ | |
PointerCaptureEvent | Sent when an element captures a pointer. | ✔ | ✔ | |
PointerCaptureOutEvent | Sent when an element releases a pointer. | ✔ | ✔ |
Mouse capture events refer to events on a physical mouse, or a virtual mouse emulating a physical mouse. Capturing a mouse will also result in a PointerCaptureEvent
for the mouse pointer.
When an element releases a mouse capture, the corresponding MouseCaptureOutEvent
triggers, with the target being the element that requested the release of the capture.
There can never be two elements that capture the mouse at the same time. If another visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary triggers a MouseCaptureEvent
, the element that sent the original MouseCaptureEvent
loses the capture. This also triggers a MouseCaptureOutEvent
on the original element.
Pointer events precede mouse events in UI Toolkit. If the pointer type is a mouse, capturing it will also trigger the corresponding mouse capture events. Capturing the pointer will also capture the mouse.
A MouseCaptureEvent
event is sent when an element takes the mouse capture.
target
: The element that takes the capture.
A MouseCaptureOutEvent
event is sent when an element releases, or loses the mouse capture.
target
: The element that loses the capture.
A PointerCaptureEvent
event is sent when an element takes the pointer capture.
target
: The element that takes the capture.
A PointerCaptureOutEvent
event is sent when an element releases, or loses the pointer capture.
target
: The element that loses the capture.
The following example demonstrates the behavior of the capture events, and capturing and releasing pointers.
To see the example in action, do the following:
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
public class CaptureEventsTestWindow : EditorWindow
{
[MenuItem("Window/UI Toolkit/Capture Events Test Window")]
public static void ShowExample()
{
var wnd = GetWindow<CaptureEventsTestWindow>();
wnd.titleContent = new GUIContent("Capture Events Test Window");
}
private bool m_IsCapturing = false;
public void CreateGUI()
{
// Add a few clickable labels that print a message to the console when clicked
for (int i = 0; i < 4; i++)
{
Label clickableLabel = new Label($"Label {i} - Click Me!");
clickableLabel.RegisterCallback<MouseDownEvent>((evt) => { Debug.Log($"Clicked on label '{(evt.target as Label).text}'"); });
rootVisualElement.Add(clickableLabel);
}
// Now add a label that captures the pointer
Label capturingLabel = new Label("Click here to capture mouse");
capturingLabel.RegisterCallback<MouseDownEvent>((evt) =>
{
if (!m_IsCapturing)
{
capturingLabel.text = "Click here to release mouse";
MouseCaptureController.CaptureMouse(capturingLabel);
m_IsCapturing = true;
}
else
{
capturingLabel.text = "Click here to capture mouse";
MouseCaptureController.ReleaseMouse(capturingLabel);
m_IsCapturing = false;
}
});
rootVisualElement.Add(capturingLabel);
// Register callbacks to print a message when the mouse is captured or released
rootVisualElement.RegisterCallback<MouseCaptureEvent>((evt) =>
{
Debug.Log("Mouse captured");
});
rootVisualElement.RegisterCallback<MouseCaptureOutEvent>((evt) =>
{
Debug.Log("Mouse captured released");
});
}
}
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.