docs/README-gesture.md
changeset 9066 c2af3ff967cc
parent 9025 d09d4b578e77
child 9464 ae7a6c8cc189
     1.1 --- a/docs/README-gesture.md	Fri Aug 15 23:18:57 2014 +0200
     1.2 +++ b/docs/README-gesture.md	Fri Aug 15 23:39:14 2014 +0200
     1.3 @@ -14,18 +14,18 @@
     1.4  Recording terminates as soon as a finger comes up. Recording is acknowledged by an SDL_DOLLARRECORD event.
     1.5  A SDL_DOLLARRECORD event is a dgesture with the following fields:
     1.6  
     1.7 -event.dgesture.touchId   - the Id of the touch used to record the gesture.
     1.8 -event.dgesture.gestureId - the unique id of the recorded gesture.
     1.9 +* event.dgesture.touchId   - the Id of the touch used to record the gesture.
    1.10 +* event.dgesture.gestureId - the unique id of the recorded gesture.
    1.11  
    1.12  
    1.13  Performing:
    1.14  -----------
    1.15  As long as there is a dollar gesture assigned to a touch, every finger-up event will also cause an SDL_DOLLARGESTURE event with the following fields:
    1.16  
    1.17 -event.dgesture.touchId    - the Id of the touch which performed the gesture.
    1.18 -event.dgesture.gestureId  - the unique id of the closest gesture to the performed stroke.
    1.19 -event.dgesture.error      - the difference between the gesture template and the actual performed gesture. Lower error is a better match.
    1.20 -event.dgesture.numFingers - the number of fingers used to draw the stroke.
    1.21 +* event.dgesture.touchId    - the Id of the touch which performed the gesture.
    1.22 +* event.dgesture.gestureId  - the unique id of the closest gesture to the performed stroke.
    1.23 +* event.dgesture.error      - the difference between the gesture template and the actual performed gesture. Lower error is a better match.
    1.24 +* event.dgesture.numFingers - the number of fingers used to draw the stroke.
    1.25  
    1.26  Most programs will want to define an appropriate error threshold and check to be sure that the error of a gesture is not abnormally high (an indicator that no gesture was performed).
    1.27  
    1.28 @@ -54,12 +54,12 @@
    1.29  SDL provides simple support for pinch/rotate/swipe gestures. 
    1.30  Every time a finger is moved an SDL_MULTIGESTURE event is sent with the following fields:
    1.31  
    1.32 -event.mgesture.touchId - the Id of the touch on which the gesture was performed.
    1.33 -event.mgesture.x       - the normalized x coordinate of the gesture. (0..1)
    1.34 -event.mgesture.y       - the normalized y coordinate of the gesture. (0..1)
    1.35 -event.mgesture.dTheta  - the amount that the fingers rotated during this motion.
    1.36 -event.mgesture.dDist   - the amount that the fingers pinched during this motion.
    1.37 -event.mgesture.numFingers - the number of fingers used in the gesture.
    1.38 +* event.mgesture.touchId - the Id of the touch on which the gesture was performed.
    1.39 +* event.mgesture.x       - the normalized x coordinate of the gesture. (0..1)
    1.40 +* event.mgesture.y       - the normalized y coordinate of the gesture. (0..1)
    1.41 +* event.mgesture.dTheta  - the amount that the fingers rotated during this motion.
    1.42 +* event.mgesture.dDist   - the amount that the fingers pinched during this motion.
    1.43 +* event.mgesture.numFingers - the number of fingers used in the gesture.
    1.44  
    1.45  
    1.46  ===========================================================================