Add documentation about pressure to VirtualTouchEvent

The underlying input devices are configured with a pressure range of
0-255. MotionEvent uses a normalized range of 0.0-1.0, which has caused
some confusion. This change adds documentation about the expected range.

Test: Documentation only change
Bug: 259554911
Change-Id: Iddb6cd5b5cd23bb15f75620041d7d3cbf49959db
This commit is contained in:
Sandro Meier
2022-11-14 14:05:00 +00:00
parent 7119c3e5d6
commit 1fb38b7b23

View File

@@ -262,6 +262,16 @@ public final class VirtualTouchEvent implements Parcelable {
/**
* Sets the pressure of the event. This field is optional and can be omitted.
*
* @param pressure The pressure of the touch.
* Note: The VirtualTouchscreen, consuming VirtualTouchEvents, is
* configured with a pressure axis range from 0.0 to 255.0. Only the
* lower end of the range is enforced. You can pass values larger than
* 255.0. With physical input devices this could happen if the
* calibration is off. Values larger than 255.0 will not be trimmed and
* passed on as is.
*
* @throws IllegalArgumentException if the pressure is smaller than 0.
*
* @return this builder, to allow for chaining of calls
*/
public @NonNull Builder setPressure(@FloatRange(from = 0f) float pressure) {