Version: 2020.1
LanguageEnglish
  • C#

MouseEventBase<T0>.GetPooled

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

public static T GetPooled(Event systemEvent);
public static T GetPooled(UIElements.IMouseEvent triggerEvent);
protected static T GetPooled(UIElements.IPointerEvent pointerEvent);
public static T GetPooled(Vector2 position, int button, int clickCount, Vector2 delta, EventModifiers modifiers);

Parameters

systemEvent An IMGUI mouse event.
triggerEvent The event that sent this event.
pointerEvent The pointer event that sent this event.
position The mouse position.
button The mouse button pressed.
clickCount The number of consecutive mouse clicks received.
delta The relative movement of the mouse compared to the mouse position when the last event was received.
modifiers The modifier keys held down during the event.

Returns

T An initialized event.

Description

Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use `Dispose()` to release them.

Did you find this page useful? Please give it a rating: