Version: 2021.2
LanguageEnglish
  • C#

KeyboardEventBase<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

Declaration

public static T GetPooled(char c, KeyCode keyCode, EventModifiers modifiers);

Parameters

c The character for this event.
keyCode The key code for this event.
modifiers Event modifier keys that are active for this event.

Returns

T An initialized event.

Description

Gets a keyboard 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.


Declaration

public static T GetPooled(Event systemEvent);

Parameters

systemEvent A keyboard IMGUI event.

Returns

T An initialized event.

Description

Gets a keyboard 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.