summaryrefslogtreecommitdiffstats
path: root/ppapi/api
diff options
context:
space:
mode:
authorjond@chromium.org <jond@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-09-25 15:47:11 +0000
committerjond@chromium.org <jond@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-09-25 15:47:11 +0000
commitaf0bb0644f726c9442d6b141ef9c126d40385348 (patch)
tree869cd1047a7185f596b77a279042168eb2598082 /ppapi/api
parent831d2d9ac6d50a0abff90d6419fe11021cdb9a3f (diff)
downloadchromium_src-af0bb0644f726c9442d6b141ef9c126d40385348.zip
chromium_src-af0bb0644f726c9442d6b141ef9c126d40385348.tar.gz
chromium_src-af0bb0644f726c9442d6b141ef9c126d40385348.tar.bz2
Updated pp_touch_point.h docs in preparation for fixing the C++ docs (which are a bit lean).
Review URL: https://codereview.chromium.org/10956037 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@158574 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/api')
-rw-r--r--ppapi/api/pp_touch_point.idl39
1 files changed, 20 insertions, 19 deletions
diff --git a/ppapi/api/pp_touch_point.idl b/ppapi/api/pp_touch_point.idl
index eba6c44..4b31320 100644
--- a/ppapi/api/pp_touch_point.idl
+++ b/ppapi/api/pp_touch_point.idl
@@ -5,48 +5,49 @@
/**
- * This file defines the API to create a touch-point.
+ * This file defines the API to create a touch point or position where fingers
+ * makes contact with touch screen device.
*/
/**
- * The <code>PP_TouchPoint</code> represents all information about a single
- * touch point, such ase position, id, rotation angle, and pressure.
+ * The <code>PP_TouchPoint</code> struct represents all information about a
+ * single touch point, such ase position, id, rotation angle, and pressure.
*/
[assert_size(28), returnByValue]
struct PP_TouchPoint {
/**
- * The identifier for this TouchPoint. This corresponds to the order
- * in which the points were pressed. For example, the first point to be
- * pressed has an id of 0, the second has an id of 1, and so on. An id can be
- * reused when a touch point is released. For example, if two fingers are
- * down, with id 0 and 1, and finger 0 releases, the next finger to be
- * pressed can be assigned to id 0.
+ * This value represents the identifier for this TouchPoint. The id
+ * corresponds to the order in which the points were pressed. For example,
+ * the first point to be pressed has an id of 0, the second has an id of 1,
+ * and so on. An id can be reused when a touch point is released. For
+ * example, if two fingers are down, with id 0 and 1, and finger 0 releases,
+ * the next finger to be pressed can be assigned to id 0.
*/
uint32_t id;
/**
- * The x-y pixel position of this TouchPoint, relative to the upper-left of
- * the instance receiving the event.
+ * This value represents the x and y pixel position of this TouchPoint
+ * relative to the upper-left of the module instance receiving the event.
*/
PP_FloatPoint position;
/**
- * The elliptical radii, in screen pixels, in the x and y direction of this
- * TouchPoint.
+ * This value represents the elliptical radii, in screen pixels, in the x
+ * and y direction of this TouchPoint.
*/
PP_FloatPoint radius;
/**
- * The angle of rotation in degrees of the elliptical model of this TouchPoint
- * clockwise from "up."
+ * This value represents the angle of rotation in degrees of the elliptical
+ * model of this TouchPoint clockwise from "up."
*/
float_t rotation_angle;
/**
- * The pressure applied to this TouchPoint. This is typically a
- * value between 0 and 1, with 0 indicating no pressure and 1 indicating
- * some maximum pressure, but scaling differs depending on the hardware and
- * the value is not guaranteed to stay within that range.
+ * This value represents the pressure applied to this TouchPoint. This value
+ * is typically between 0 and 1, with 0 indicating no pressure and 1
+ * indicating some maximum pressure. Scaling differs depending on the
+ * hardware and the value is not guaranteed to stay within that range.
*/
float_t pressure;
};