IME Events are now completely variable sized. #1120
Conversation
Updated Tests to match
| unsafe | ||
| { | ||
| int sizeInBytes = (InputEvent.kBaseEventSize + sizeof(int) + sizeof(char)) + (sizeof(char) * str.Length); | ||
| IntPtr evtPtr = Marshal.AllocHGlobal(sizeInBytes); |
There was a problem hiding this comment.
Use Unity NativeArray (with Allocator.Temp) and Unity Memcpy instead of Marshal.
There was a problem hiding this comment.
Not used NativeArray much, did an attempt, feel I could be missing an easier way to do it, but this passes the tests.
| } | ||
|
|
||
| /// <summary> | ||
| /// Queues up an IME Composition Event.!-- This event is for unit testing and debug purposes, and is slow, due to the variable way that IME Composition events work. |
There was a problem hiding this comment.
Removed, I didn't like the AllocHGlobal and copying 1 character at a time. Had no good justification it was slow.
| /// <summary> | ||
| /// Queues up an IME Composition Event.!-- This event is for unit testing and debug purposes, and is slow, due to the variable way that IME Composition events work. | ||
| /// </summary> | ||
| /// <param name="deviceId">The Id you'd like to send the composition event at.</param> |
There was a problem hiding this comment.
ID of the device (see <see cref="InputDevice.deviceId") to which the composition event should be sent to. Should be an <see cref="ITextInputReceiver"/> device. Will trigger <see cref="ITextInputReceiver.OnIMECompositionChanged"/> call when processed.
Overall, doc comments that don't really provide information and only restate what's already obvious from the code are really aggravating.
There was a problem hiding this comment.
Took that segment and did a pass on some of the other doc elements around. Tried to add a bit of something to any of the docs, or remove the code comments entirely for things like GetEnumerator.
| public int Count => size; | ||
| int m_Length; | ||
| /// <summary> | ||
| /// The number of characters in the current IME Composition |
There was a problem hiding this comment.
Punctuation. Sentences in API docs should be properly formed.
|
|
||
|
|
||
| /// <summary> | ||
| /// An Indexer into an individual character in the IME Composition. Will throw an out of range exception if the index is greater than the length of the composition. |
There was a problem hiding this comment.
Use <exception> tags to document exceptions.
|
@renedamm should be good for re-review, moved to using Unity's unsafe & native array tools, improved the docs. Added 1 test, and was already using the existing IME event test to verify that the composition events get received properly. |
…nto Variable-Sized-IME
…nto Variable-Sized-IME
… method for getting hte NativeArray to avoid breaking API.
|
|
|
I'm recreating this work in #1628 |
IME events now have no cap. This handles a new event that comes from native Unity that has a variable sized IME event. Do not merge until new event is available.
-Updated IME test to still work.