docs/README-touch.md
changeset 10212 af95dd343a25
parent 9066 c2af3ff967cc
child 10486 5bf595c48fd4
     1.1 --- a/docs/README-touch.md	Wed Jul 27 20:47:08 2016 +0200
     1.2 +++ b/docs/README-touch.md	Wed Jul 27 20:47:31 2016 +0200
     1.3 @@ -42,14 +42,14 @@
     1.4  ===========================================================================
     1.5  Functions
     1.6  ===========================================================================
     1.7 -SDL provides the ability to access the underlying Finger structures.
     1.8 +SDL provides the ability to access the underlying SDL_Finger structures.
     1.9  These structures should _never_ be modified.
    1.10  
    1.11  The following functions are included from SDL_touch.h
    1.12  
    1.13 -To get a SDL_TouchID call SDL_GetTouchDevice(index).
    1.14 +To get a SDL_TouchID call SDL_GetTouchDevice(int index).
    1.15  This returns a SDL_TouchID.
    1.16 -IMPORTANT: If the touch has been removed, or there is no touch with the given ID, SDL_GetTouchID will return 0. Be sure to check for this!
    1.17 +IMPORTANT: If the touch has been removed, or there is no touch with the given index, SDL_GetTouchDevice() will return 0. Be sure to check for this!
    1.18  
    1.19  The number of touch devices can be queried with SDL_GetNumTouchDevices().
    1.20  
    1.21 @@ -64,13 +64,13 @@
    1.22  
    1.23  
    1.24  
    1.25 -To get a SDL_Finger, call SDL_GetTouchFinger(touchID,index), where touchID is a SDL_TouchID, and index is the requested finger.
    1.26 -This returns a SDL_Finger*, or NULL if the finger does not exist, or has been removed.
    1.27 +To get a SDL_Finger, call SDL_GetTouchFinger(SDL_TouchID touchID, int index), where touchID is a SDL_TouchID, and index is the requested finger.
    1.28 +This returns a SDL_Finger *, or NULL if the finger does not exist, or has been removed.
    1.29  A SDL_Finger is guaranteed to be persistent for the duration of a touch, but it will be de-allocated as soon as the finger is removed. This occurs when the SDL_FINGERUP event is _added_ to the event queue, and thus _before_ the SDL_FINGERUP event is polled.
    1.30  As a result, be very careful to check for NULL return values.
    1.31  
    1.32  A SDL_Finger has the following fields:
    1.33 -* x,y,pressure:
    1.34 +* x, y:
    1.35  	The current coordinates of the touch.
    1.36  * pressure:
    1.37  	The pressure of the touch.