Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Touch

struct in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Structure describing the status of a finger touching the screen.

Devices can track a number of different pieces of data about a touch on a touchscreen, including its phase (ie, whether it has just started, ended or moved), its position and whether the touch was a single contact or several taps. Furthermore, the continuity of a touch between frame updates can be detected by the device, so a consistent ID number can be reported across frames and used to determine how a particular finger is moving.

The Touch struct is used by Unity to store data relating to a single touch instance and is returned by the Input.GetTouch function. Fresh calls to GetTouch will be required on each frame update to obtain the latest touch information from the device but the fingerId property can be used to identify the same touch between frames.

See Also: Input.GetTouch, TouchPhase enum.

Variables

altitudeAngleValue of 0 radians indicates that the stylus is parallel to the surface, pi/2 indicates that it is perpendicular.
azimuthAngleValue of 0 radians indicates that the stylus is pointed along the x-axis of the device.
deltaPositionThe position delta since last change.
deltaTimeAmount of time that has passed since the last recorded change in Touch values.
fingerIdThe unique index for the touch.
maximumPossiblePressureThe maximum possible pressure value for a platform. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f.
phaseDescribes the phase of the touch.
positionThe position of the touch in pixel coordinates.
pressureThe current amount of pressure being applied to a touch. 1.0f is considered to be the pressure of an average touch. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f.
radiusAn estimated value of the radius of a touch. Add radiusVariance to get the maximum touch size, subtract it to get the minimum touch size.
radiusVarianceThe amount that the radius varies by for a touch.
rawPositionThe raw position used for the touch.
tapCountNumber of taps.
typeA value that indicates whether a touch was of Direct, Indirect (or remote), or Stylus type.