Interface ITextInputReceiver
Interface for InputDevice classes that can receive text input events.
Namespace: UnityEngine.InputSystem.LowLevel
Assembly: Unity.InputSystem.dll
Syntax
public interface ITextInputReceiverRemarks
This interface should be implemented by devices that are meant to receive text input through TextEvent.
Methods
OnIMECompositionChanged(IMECompositionString)
Called when an IME composition is in-progress or finished.
Declaration
void OnIMECompositionChanged(IMECompositionString compositionString)Parameters
| Type | Name | Description |
|---|---|---|
| IMECompositionString | compositionString | The current composition. |
Remarks
The method will be repeatedly called with the current string while composition is in progress. Once composition finishes, the method will be called one more time with a blank composition string.
See Also
OnTextInput(char)
A single, fully-formed Unicode character has been typed on the device.
Declaration
void OnTextInput(char character)Parameters
| Type | Name | Description |
|---|---|---|
| char | character | Character that was typed. Note that in case the character is part of a surrogate pair, this method is called first with the high surrogate and then with the low surrogate character. |
Remarks
This method is called on a device when a TextEvent is received
for the device. character is the character
from the event.
Note that this method will be called twice for a single TextEvent
in case the given UTF-32 (encoding in the event) needs to be represented as UTF-16
(encoding of char in C#) surrogate.