include/SDL_touch.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 03 Mar 2013 01:01:33 -0800
changeset 6951 7833f01322b3
parent 6950 1ddb72193079
child 7170 d5f5a491fe49
permissions -rw-r--r--
Updated touch API
* Normalized touch coordinates as floats in the 0...1 range
* Removed unused touchpad concepts from the API
* Added API functions to get active touch devices and current finger state
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_touch.h
    24  *  
    25  *  Include file for SDL touch event handling.
    26  */
    27 
    28 #ifndef _SDL_touch_h
    29 #define _SDL_touch_h
    30 
    31 #include "SDL_stdinc.h"
    32 #include "SDL_error.h"
    33 #include "SDL_video.h"
    34 
    35 #include "begin_code.h"
    36 /* Set up for C function definitions, even when using C++ */
    37 #ifdef __cplusplus
    38 /* *INDENT-OFF* */
    39 extern "C" {
    40 /* *INDENT-ON* */
    41 #endif
    42 
    43 typedef Sint64 SDL_TouchID;
    44 typedef Sint64 SDL_FingerID;
    45 
    46 typedef struct SDL_Finger
    47 {
    48     SDL_FingerID id;
    49     float x;
    50     float y;
    51     float pressure;
    52 } SDL_Finger;
    53 
    54 /* Used as the device ID for mouse events simulated with touch input */
    55 #define SDL_TOUCH_MOUSEID ((Uint32)-1)
    56 
    57 
    58 /* Function prototypes */
    59 
    60 /**
    61  *  \brief Get the number of registered touch devices.
    62  */
    63 extern DECLSPEC int SDLCALL SDL_GetNumTouchDevices();
    64 
    65 /**
    66  *  \brief Get the touch ID with the given index, or 0 if the index is invalid.
    67  */
    68 extern DECLSPEC SDL_TouchID SDLCALL SDL_GetTouchDevice(int index);
    69 
    70 /**
    71  *  \brief Get the number of active fingers for a given touch device.
    72  */
    73 extern DECLSPEC int SDLCALL SDL_GetNumTouchFingers(SDL_TouchID touchID);
    74 
    75 /**
    76  *  \brief Get the finger object of the given touch, with the given index.
    77  */
    78 extern DECLSPEC SDL_Finger * SDLCALL SDL_GetTouchFinger(SDL_TouchID touchID, int index);
    79 
    80 /* Ends C function definitions when using C++ */
    81 #ifdef __cplusplus
    82 /* *INDENT-OFF* */
    83 }
    84 /* *INDENT-ON* */
    85 #endif
    86 #include "close_code.h"
    87 
    88 #endif /* _SDL_touch_h */
    89 
    90 /* vi: set ts=4 sw=4 expandtab: */