Changed hit test documentation for unconsumed events

Stage is used for receiving up/down events to the screen regardless of
actor event handling and consumption.

Instead, the stage's root layer should be used to catch unconsumed events

Change-Id: I83b55d53f50bee8cb466bb9d6d9eeb5e70df4229
Signed-off-by: David Steele <david.steele@partner.samsung.com>
Signed-off-by: Adeel Kazmi <adeel.kazmi@samsung.com>

diff --git a/dali/public-api/actors/actor.h b/dali/public-api/actors/actor.h
index ac59a4e..c96951f 100644 (file)
--- a/dali/public-api/actors/actor.h
+++ b/dali/public-api/actors/actor.h
@@ -71,6 +71,10 @@ typedef Rect<float> Padding;      ///< Padding definition
  *
  * <i>Hit Test Algorithm:</i>
  *
+ * - Stage
+ *   - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
+ *   - Stage's root layer can be used to catch unconsumed touch events.
+ *
  * - RenderTasks
  *   - Hit testing is dependent on the camera used, which is specific to each RenderTask.
  *