README.touch
changeset 4690 baf8195aeb92
parent 4689 f9ab8df6d45a
child 4693 2ede56a19f2f
equal deleted inserted replaced
4689:f9ab8df6d45a 4690:baf8195aeb92
       
     1 ===========================================================================
       
     2 System Specific Notes
       
     3 ===========================================================================
       
     4 Linux:
       
     5 The linux touch system is currently based off event streams, and proc/bus/devices. The active user must be given permissions to read /dev/input/TOUCHDEVICE, where TOUCHDEVICE is the event stream for your device. Currently only Wacom tablets are supported. If you have an unsupported tablet contact me at jim.tla+sdl_touch@gmail.com and I will help you get support for it.
       
     6 
       
     7 Mac: 
       
     8 The Mac and Iphone API's are pretty. If your touch device supports them then you'll be fine. If it doesn't, then there isn't much we can do.
       
     9 
       
    10 iPhone: 
       
    11 Works out of box.
       
    12 
       
    13 Winows:
       
    14 Unfortunately there is no windows support as of yet. Support for Windows 7 is planned, but we currently have no way to test. If you have a Windows 7 WM_TOUCH supported device, and are willing to help test please contact me at jim.tla+sdl_touch@gmail.com
       
    15 
     1 ===========================================================================
    16 ===========================================================================
     2 Events
    17 Events
     3 ===========================================================================
    18 ===========================================================================
     4 SDL_FINGERDOWN:
    19 SDL_FINGERDOWN:
     5 Sent when a finger (or stylus) is placed on a touch device.
    20 Sent when a finger (or stylus) is placed on a touch device.
    12 
    27 
    13 SDL_FINGERMOTION:
    28 SDL_FINGERMOTION:
    14 Sent when a finger (or stylus) is moved on the touch device.
    29 Sent when a finger (or stylus) is moved on the touch device.
    15 Fields:
    30 Fields:
    16 Same as FINGERDOWN but with additional:
    31 Same as FINGERDOWN but with additional:
    17 event.tfginer.dx       - chagne in x coordinate during this motion event.
    32 event.tfginer.dx       - change in x coordinate during this motion event.
    18 event.tfginer.dy       - chagne in y coordinate during this motion event.
    33 event.tfginer.dy       - change in y coordinate during this motion event.
    19 
    34 
    20 SDL_FINGERMOTION:
    35 SDL_FINGERMOTION:
    21 Sent when a finger (or stylus) is lifted from the touch device.
    36 Sent when a finger (or stylus) is lifted from the touch device.
    22 Fields:
    37 Fields:
    23 Same as FINGERDOWN.
    38 Same as FINGERDOWN.
    34 To get a SDL_Touch device call SDL_GetTouch(touchId). 
    49 To get a SDL_Touch device call SDL_GetTouch(touchId). 
    35 This returns an SDL_Touch*. 
    50 This returns an SDL_Touch*. 
    36 IMPORTANT: If the touch has been removed, or there is no touch with the given ID, SDL_GetTouch will return null. Be sure to check for this!
    51 IMPORTANT: If the touch has been removed, or there is no touch with the given ID, SDL_GetTouch will return null. Be sure to check for this!
    37 
    52 
    38 An SDL_Touch has the following fields:
    53 An SDL_Touch has the following fields:
       
    54 >xres,yres,pressures:
       
    55 	The resolution at which x,y, and pressure values are reported. Currently these will always be equal to 2^15, but this may not always be the case. 
       
    56 
    39 >pressure_max, pressure_min, x_max, x_min, y_max, y_min
    57 >pressure_max, pressure_min, x_max, x_min, y_max, y_min
    40 	Which give, respectively, the maximum and minumum values that the touch digitizer can return for pressure, x coordiniate, and y coordinate AS REPORTED BY THE OPERATING SYSTEM.
    58 	Which give, respectively, the maximum and minumum values that the touch digitizer can return for pressure, x coordiniate, and y coordinate AS REPORTED BY THE OPERATING SYSTEM.
    41 On Mac/iPhone systems _max will always be 0, and _min will always be 1. 
    59 On Mac/iPhone systems _max will always be 0, and _min will always be 1. 
    42 
       
    43 >xres,yres,pressures:
       
    44 	The resolution at which x,y, and pressure values are reported. Currently these will always be equal to 2^15, but this may not always be the case. 
       
    45 
    60 
    46 >native_xres,native_yres,native_pressureres:
    61 >native_xres,native_yres,native_pressureres:
    47 	The native resolution of the touch device AS REPORTED BY THE OPERATING SYSTEM.
    62 	The native resolution of the touch device AS REPORTED BY THE OPERATING SYSTEM.
    48 On Mac/iPhone systems these will always be 1.
    63 On Mac/iPhone systems these will always be 1.
    49 
    64 
    52 
    67 
    53 >fingers:
    68 >fingers:
    54 	An array of pointers to the fingers which are on the device.
    69 	An array of pointers to the fingers which are on the device.
    55 
    70 
    56 
    71 
    57 The most common reason to get a touch device is to normalize inputs. This would look something like:
    72 The most common reason to access a touch device is to normalize inputs. This would be accomplished by code like the following:
    58 
    73 
    59       SDL_Touch* inTouch = SDL_GetTouch(event.tfinger.touchId);
    74       SDL_Touch* inTouch = SDL_GetTouch(event.tfinger.touchId);
    60       if(inTouch == NULL) continue;
    75       if(inTouch == NULL) continue; //The touch has been removed
    61 
    76 
    62       float x = ((float)event.tfinger.x)/inTouch->xres;
    77       float x = ((float)event.tfinger.x)/inTouch->xres;
    63       float y = ((float)event.tfinger.y)/inTouch->yres;      
    78       float y = ((float)event.tfinger.y)/inTouch->yres;
       
    79 
    64 
    80 
    65 
    81 
    66 To get an SDL_Finger, call SDL_GetFinger(touch,fingerId), where touch is a pointer to an SDL_Touch device, and fingerId is the id of the requested finger.
    82 To get an SDL_Finger, call SDL_GetFinger(touch,fingerId), where touch is a pointer to an SDL_Touch device, and fingerId is the id of the requested finger.
    67 This returns an SDL_Finger*, or null if the finger does not exist, or has been removed.
    83 This returns an SDL_Finger*, or null if the finger does not exist, or has been removed.
    68 An 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 seen. 
    84 An 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. 
    69 As a result, be very careful to check for null return values.
    85 As a result, be very careful to check for null return values.
    70 
    86 
    71 An SDL_Finger has the following fields:
    87 An SDL_Finger has the following fields:
    72 >x,y,pressure:
    88 >x,y,pressure:
    73 	The current coordinates of the touch.
    89 	The current coordinates of the touch.
    74 >xdelta,ydelta: 
    90 >xdelta,ydelta: 
    75 	The change in position resulting from the last finger motion.
    91 	The change in position resulting from the last finger motion.
    76 >last_x, last_y, last_pressure:
    92 >last_x, last_y, last_pressure:
    77 	 The previous coordinates of the touch.
    93 	 The previous coordinates of the touch.
       
    94 
       
    95 ===========================================================================
       
    96 Notes
       
    97 ===========================================================================
       
    98 For a complete example see test/testgesture.c
       
    99 
       
   100 Please direct questions/comments to:
       
   101    jim.tla+sdl_touch@gmail.com