File size: 9,238 Bytes
18a519f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | using System;
using UnityEngine.InputSystem.Utilities;
////REVIEW: nuke this and force raw pointers on all code using events?
namespace UnityEngine.InputSystem.LowLevel
{
/// <summary>
/// Pointer to an <see cref="InputEvent"/>. Makes it easier to work with InputEvents and hides
/// the unsafe operations necessary to work with them.
/// </summary>
/// <remarks>
/// Note that event pointers generally refer to event buffers that are continually reused. This means
/// that event pointers should not be held on to. Instead, to hold onto event data, manually copy
/// an event to a buffer.
/// </remarks>
public unsafe struct InputEventPtr : IEquatable<InputEventPtr>
{
// C# does not allow us to have pointers to structs that have managed data members. Since
// this can't be guaranteed for generic type parameters, they can't be used with pointers.
// This is why we cannot make InputEventPtr generic or have a generic method that returns
// a pointer to a specific type of event.
private readonly InputEvent* m_EventPtr;
/// <summary>
/// Initialize the pointer to refer to the given event.
/// </summary>
/// <param name="eventPtr">Pointer to an event. Can be <c>null</c>.</param>
public InputEventPtr(InputEvent* eventPtr)
{
m_EventPtr = eventPtr;
}
/// <summary>
/// Whether the pointer is not <c>null</c>.
/// </summary>
/// <value>True if the struct refers to an event.</value>
public bool valid => m_EventPtr != null;
/// <summary>
/// Whether the event is considered "handled" and should not be processed further.
/// </summary>
/// <remarks>
/// This is used in two ways. Setting it from inside <see cref="InputSystem.onEvent"/> will
/// cause the event to not be processed further. If it is a <see cref="StateEvent"/> or
/// <see cref="DeltaStateEvent"/>, the <see cref="InputDevice"/> targeted by the event will
/// not receive the state change.
///
/// Setting this flag from inside a state change monitor (see <see cref="InputState.AddChangeMonitor(InputControl,IInputStateChangeMonitor,long,uint)"/>)
/// will prevent other monitors on the same <see cref="IInputStateChangeMonitor"/> not receiving the state change.
/// </remarks>
/// <exception cref="InvalidOperationException">The event pointer instance is not <see cref="valid"/>.</exception>
public bool handled
{
get
{
if (!valid)
return false;
return m_EventPtr->handled;
}
set
{
if (!valid)
throw new InvalidOperationException("The InputEventPtr is not valid.");
m_EventPtr->handled = value;
}
}
public int id
{
get
{
if (!valid)
return 0;
return m_EventPtr->eventId;
}
set
{
if (!valid)
throw new InvalidOperationException("The InputEventPtr is not valid.");
m_EventPtr->eventId = value;
}
}
public FourCC type
{
get
{
if (!valid)
return new FourCC();
return m_EventPtr->type;
}
}
public uint sizeInBytes
{
get
{
if (!valid)
return 0;
return m_EventPtr->sizeInBytes;
}
}
public int deviceId
{
get
{
if (!valid)
return InputDevice.InvalidDeviceId;
return m_EventPtr->deviceId;
}
set
{
if (!valid)
throw new InvalidOperationException("The InputEventPtr is not valid.");
m_EventPtr->deviceId = value;
}
}
public double time
{
get => valid ? m_EventPtr->time : 0.0;
set
{
if (!valid)
throw new InvalidOperationException("The InputEventPtr is not valid.");
m_EventPtr->time = value;
}
}
internal double internalTime
{
get => valid ? m_EventPtr->internalTime : 0.0;
set
{
if (!valid)
throw new InvalidOperationException("The InputEventPtr is not valid.");
m_EventPtr->internalTime = value;
}
}
public InputEvent* data => m_EventPtr;
// The stateFormat, stateSizeInBytes, and stateOffset properties are very
// useful for debugging.
internal FourCC stateFormat
{
get
{
var eventType = type;
if (eventType == StateEvent.Type)
return StateEvent.FromUnchecked(this)->stateFormat;
if (eventType == DeltaStateEvent.Type)
return DeltaStateEvent.FromUnchecked(this)->stateFormat;
throw new InvalidOperationException("Event must be a StateEvent or DeltaStateEvent but is " + this);
}
}
internal uint stateSizeInBytes
{
get
{
if (IsA<StateEvent>())
return StateEvent.From(this)->stateSizeInBytes;
if (IsA<DeltaStateEvent>())
return DeltaStateEvent.From(this)->deltaStateSizeInBytes;
throw new InvalidOperationException("Event must be a StateEvent or DeltaStateEvent but is " + this);
}
}
internal uint stateOffset
{
get
{
if (IsA<DeltaStateEvent>())
return DeltaStateEvent.From(this)->stateOffset;
throw new InvalidOperationException("Event must be a DeltaStateEvent but is " + this);
}
}
public bool IsA<TOtherEvent>()
where TOtherEvent : struct, IInputEventTypeInfo
{
if (m_EventPtr == null)
return false;
// NOTE: Important to say `default` instead of `new TOtherEvent()` here. The latter will result in a call to
// `Activator.CreateInstance` on Mono and thus allocate GC memory.
TOtherEvent otherEvent = default;
return m_EventPtr->type == otherEvent.typeStatic;
}
// NOTE: It is your responsibility to know *if* there actually another event following this one in memory.
public InputEventPtr Next()
{
if (!valid)
return new InputEventPtr();
return new InputEventPtr(InputEvent.GetNextInMemory(m_EventPtr));
}
public override string ToString()
{
if (!valid)
return "null";
// il2cpp has a bug which makes builds fail if this is written as 'return m_EventPtr->ToString()'.
// Gives an error about "trying to constrain an invalid type".
// Writing it as a two-step operation like here makes it build cleanly.
var eventPtr = *m_EventPtr;
return eventPtr.ToString();
}
/// <summary>
/// Return the plain pointer wrapped around by the struct.
/// </summary>
/// <returns>A plain pointer. Can be <c>null</c>.</returns>
public InputEvent* ToPointer()
{
return this;
}
public bool Equals(InputEventPtr other)
{
return m_EventPtr == other.m_EventPtr || InputEvent.Equals(m_EventPtr, other.m_EventPtr);
}
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj))
return false;
return obj is InputEventPtr ptr && Equals(ptr);
}
public override int GetHashCode()
{
return unchecked((int)(long)m_EventPtr);
}
public static bool operator==(InputEventPtr left, InputEventPtr right)
{
return left.m_EventPtr == right.m_EventPtr;
}
public static bool operator!=(InputEventPtr left, InputEventPtr right)
{
return left.m_EventPtr != right.m_EventPtr;
}
public static implicit operator InputEventPtr(InputEvent* eventPtr)
{
return new InputEventPtr(eventPtr);
}
public static InputEventPtr From(InputEvent* eventPtr)
{
return new InputEventPtr(eventPtr);
}
public static implicit operator InputEvent*(InputEventPtr eventPtr)
{
return eventPtr.data;
}
// Make annoying Microsoft code analyzer happy.
public static InputEvent* FromInputEventPtr(InputEventPtr eventPtr)
{
return eventPtr.data;
}
}
}
|