Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Commit

Permalink
Corrected names in README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
philippwiesemann committed Apr 29, 2013
1 parent 9f5cf2a commit c127487
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.touch
Expand Up @@ -28,14 +28,14 @@ event.tfinger.pressure - the pressure of the touch (0..1)
SDL_FINGERMOTION:
Sent when a finger (or stylus) is moved on the touch device.
Fields:
Same as FINGERDOWN but with additional:
Same as SDL_FINGERDOWN but with additional:
event.tfinger.dx - change in x coordinate during this motion event.
event.tfinger.dy - change in y coordinate during this motion event.

SDL_FINGERUP:
Sent when a finger (or stylus) is lifted from the touch device.
Fields:
Same as FINGERDOWN.
Same as SDL_FINGERDOWN.


===========================================================================
Expand All @@ -52,7 +52,7 @@ IMPORTANT: If the touch has been removed, or there is no touch with the given ID

The number of touch devices can be queried with SDL_GetNumTouchDevices().

A SDL_Touch may be used to get pointers to SDL_Finger.
A SDL_TouchID may be used to get pointers to SDL_Finger.

SDL_GetNumTouchFingers(touchID) may be used to get the number of fingers currently down on the device.

Expand All @@ -65,7 +65,7 @@ The most common reason to access SDL_Finger is to query the fingers outside the

To get a SDL_Finger, call SDL_GetTouchFinger(touchID,index), where touchID is a SDL_TouchID, and index is the requested finger.
This returns a SDL_Finger*, or NULL if the finger does not exist, or has been removed.
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 FINGERUP event is polled.
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.
As a result, be very careful to check for NULL return values.

A SDL_Finger has the following fields:
Expand Down

0 comments on commit c127487

Please sign in to comment.