Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

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

public static method GetPooled(c: char, keyCode: KeyCode, modifiers: EventModifiers): T;
public static T GetPooled(char c, KeyCode keyCode, EventModifiers modifiers);
public static method GetPooled(systemEvent: Event): T;
public static T GetPooled(Event systemEvent);

Parameters

cThe character for this event.
keyCodeThe keyCode for this event.
modifiersEvent modifier keys that are active for this event.
systemEventA keyboard IMGUI event.

Returns

T A keyboard event.

Description

Get an event from the event pool and initialize it with the given values. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent().