@@ -61,9 +61,11 @@ public struct Touch : IEquatable<Touch>
6161 /// Whether this touch record holds valid data.
6262 /// </summary>
6363 /// <remarks>
64+ /// <para>
6465 /// Touch data is stored in unmanaged memory as a circular input buffer. This means that when
6566 /// the buffer runs out of capacity, older touch entries will get reused. When this happens,
6667 /// existing <c>Touch</c> instances referring to the record become invalid.
68+ /// </para>
6769 /// <para>
6870 /// This property can be used to determine whether the record held on to by the <c>Touch</c>
6971 /// instance is still valid.
@@ -82,7 +84,9 @@ public struct Touch : IEquatable<Touch>
8284 /// The finger used for the touch contact.
8385 /// </summary>
8486 /// <remarks>
87+ /// <para>
8588 /// Note that this is only <c>null</c> for default-initialized instances of the struct.
89+ /// </para>
8690 /// <para>
8791 /// See <see cref="activeFingers"/> for how to access all active fingers.
8892 /// </para>
@@ -109,9 +113,7 @@ public struct Touch : IEquatable<Touch>
109113 /// Whether the touch has begun this frame, i.e. whether <see cref="phase"/> is <see cref="TouchPhase.Began"/>.
110114 /// </summary>
111115 /// <remarks>
112- /// <para>
113116 /// Use <see cref="isInProgress"/> to more conveniently evaluate whether this touch is currently active or not.
114- /// </para>
115117 /// </remarks>
116118 public bool began => phase == TouchPhase . Began ;
117119
@@ -134,8 +136,10 @@ public struct Touch : IEquatable<Touch>
134136 /// Unique ID of the touch as (usually) assigned by the platform.
135137 /// </summary>
136138 /// <remarks>
139+ /// <para>
137140 /// Each touch contact that is made with the screen receives its own unique, non-zero ID which is
138141 /// normally assigned by the underlying platform via <see cref="TouchControl.touchId"/>.
142+ /// </para>
139143 /// <para>
140144 /// Note a platform may reuse touch IDs after their respective touches have finished.
141145 /// This means that the guarantee of uniqueness is only made with respect to <see cref="activeTouches"/>.
@@ -152,8 +156,10 @@ public struct Touch : IEquatable<Touch>
152156 /// Normalized pressure of the touch against the touch surface.
153157 /// </summary>
154158 /// <remarks>
159+ /// <para>
155160 /// Not all touchscreens are pressure-sensitive. If unsupported, this property will
156161 /// always return 0.
162+ /// </para>
157163 /// <para>
158164 /// In general, touch pressure is supported on mobile platforms only.
159165 /// </para>
@@ -171,8 +177,10 @@ public struct Touch : IEquatable<Touch>
171177 /// Screen-space radius of the touch which define its horizontal and vertical extents.
172178 /// </summary>
173179 /// <remarks>
180+ /// <para>
174181 /// If supported by the underlying device, this reports the size of the touch contact based on its
175182 /// <see cref="screenPosition"/> center point. If not supported, this will be <c>default(Vector2)</c>.
183+ /// </para>
176184 /// <para>
177185 /// Touch radius may also be retrieved directly from the device control via <see cref="TouchControl.radius"/>.
178186 /// </para>
@@ -221,8 +229,10 @@ public struct Touch : IEquatable<Touch>
221229 /// Screen-space motion delta of the touch.
222230 /// </summary>
223231 /// <remarks>
232+ /// <para>
224233 /// Note that deltas have behaviors attached to them different from most other
225234 /// controls. See <see cref="Pointer.delta"/> for details.
235+ /// </para>
226236 /// <para>
227237 /// Also see <see cref="TouchControl.delta"/> for retrieving delta directly from a device control.
228238 /// </para>
@@ -234,10 +244,12 @@ public struct Touch : IEquatable<Touch>
234244 /// </summary>
235245 /// <value>Indicates how many taps have been performed one after the other.</value>
236246 /// <remarks>
247+ /// <para>
237248 /// Successive taps have to come within <see cref="InputSettings.multiTapDelayTime"/> for them
238249 /// to increase the tap count. I.e. if a new tap finishes within that time after <see cref="startTime"/>
239250 /// of the previous touch, the tap count is increased by one. If more than <see cref="InputSettings.multiTapDelayTime"/>
240251 /// passes after a tap with no successive tap, the tap count is reset to zero.
252+ /// </para>
241253 /// <para>
242254 /// Also see <see cref="TouchControl.tapCount"/> for retrieving tap count directly from a device control.
243255 /// </para>
0 commit comments