include/SDL_touch.h
author Ethan Lee <flibitijibibo@flibitijibibo.com>
Wed, 17 Jul 2019 23:20:57 -0400
changeset 12950 05dddfb66b85
parent 12688 cc45bcb16ef2
permissions -rw-r--r--
Copypaste SDL_NSLog to UIKit backend, document it as such
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 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 extern "C" {
    39 #endif
    40 
    41 typedef Sint64 SDL_TouchID;
    42 typedef Sint64 SDL_FingerID;
    43 
    44 typedef enum
    45 {
    46     SDL_TOUCH_DEVICE_INVALID = -1,
    47     SDL_TOUCH_DEVICE_DIRECT,            /* touch screen with window-relative coordinates */
    48     SDL_TOUCH_DEVICE_INDIRECT_ABSOLUTE, /* trackpad with absolute device coordinates */
    49     SDL_TOUCH_DEVICE_INDIRECT_RELATIVE  /* trackpad with screen cursor-relative coordinates */
    50 } SDL_TouchDeviceType;
    51 
    52 typedef struct SDL_Finger
    53 {
    54     SDL_FingerID id;
    55     float x;
    56     float y;
    57     float pressure;
    58 } SDL_Finger;
    59 
    60 /* Used as the device ID for mouse events simulated with touch input */
    61 #define SDL_TOUCH_MOUSEID ((Uint32)-1)
    62 
    63 /* Used as the SDL_TouchID for touch events simulated with mouse input */
    64 #define SDL_MOUSE_TOUCHID ((Sint64)-1)
    65 
    66 
    67 /* Function prototypes */
    68 
    69 /**
    70  *  \brief Get the number of registered touch devices.
    71  */
    72 extern DECLSPEC int SDLCALL SDL_GetNumTouchDevices(void);
    73 
    74 /**
    75  *  \brief Get the touch ID with the given index, or 0 if the index is invalid.
    76  */
    77 extern DECLSPEC SDL_TouchID SDLCALL SDL_GetTouchDevice(int index);
    78 
    79 /**
    80  * \brief Get the type of the given touch device.
    81  */
    82 extern DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID touchID);
    83 
    84 /**
    85  *  \brief Get the number of active fingers for a given touch device.
    86  */
    87 extern DECLSPEC int SDLCALL SDL_GetNumTouchFingers(SDL_TouchID touchID);
    88 
    89 /**
    90  *  \brief Get the finger object of the given touch, with the given index.
    91  */
    92 extern DECLSPEC SDL_Finger * SDLCALL SDL_GetTouchFinger(SDL_TouchID touchID, int index);
    93 
    94 /* Ends C function definitions when using C++ */
    95 #ifdef __cplusplus
    96 }
    97 #endif
    98 #include "close_code.h"
    99 
   100 #endif /* SDL_touch_h_ */
   101 
   102 /* vi: set ts=4 sw=4 expandtab: */