1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /** 18 * @addtogroup Input 19 * @{ 20 */ 21 22 /** 23 * @file input.h 24 */ 25 26 #ifndef _ANDROID_INPUT_H 27 #define _ANDROID_INPUT_H 28 29 #include <sys/cdefs.h> 30 31 /****************************************************************** 32 * 33 * IMPORTANT NOTICE: 34 * 35 * This file is part of Android's set of stable system headers 36 * exposed by the Android NDK (Native Development Kit). 37 * 38 * Third-party source AND binary code relies on the definitions 39 * here to be FROZEN ON ALL UPCOMING PLATFORM RELEASES. 40 * 41 * - DO NOT MODIFY ENUMS (EXCEPT IF YOU ADD NEW 32-BIT VALUES) 42 * - DO NOT MODIFY CONSTANTS OR FUNCTIONAL MACROS 43 * - DO NOT CHANGE THE SIGNATURE OF FUNCTIONS IN ANY WAY 44 * - DO NOT CHANGE THE LAYOUT OR SIZE OF STRUCTURES 45 */ 46 47 /* 48 * Structures and functions to receive and process input events in 49 * native code. 50 * 51 * NOTE: These functions MUST be implemented by /system/lib/libui.so 52 */ 53 54 #include <stdint.h> 55 #include <sys/types.h> 56 #include <android/keycodes.h> 57 #include <android/looper.h> 58 #include <jni.h> 59 60 #if !defined(__INTRODUCED_IN) 61 #define __INTRODUCED_IN(__api_level) /* nothing */ 62 #endif 63 64 #ifdef __cplusplus 65 extern "C" { 66 #endif 67 68 /** 69 * Key states (may be returned by queries about the current state of a 70 * particular key code, scan code or switch). 71 */ 72 enum { 73 /** The key state is unknown or the requested key itself is not supported. */ 74 AKEY_STATE_UNKNOWN = -1, 75 76 /** The key is up. */ 77 AKEY_STATE_UP = 0, 78 79 /** The key is down. */ 80 AKEY_STATE_DOWN = 1, 81 82 /** The key is down but is a virtual key press that is being emulated by the system. */ 83 AKEY_STATE_VIRTUAL = 2 84 }; 85 86 /** 87 * Meta key / modifier state. 88 */ 89 enum { 90 /** No meta keys are pressed. */ 91 AMETA_NONE = 0, 92 93 /** This mask is used to check whether one of the ALT meta keys is pressed. */ 94 AMETA_ALT_ON = 0x02, 95 96 /** This mask is used to check whether the left ALT meta key is pressed. */ 97 AMETA_ALT_LEFT_ON = 0x10, 98 99 /** This mask is used to check whether the right ALT meta key is pressed. */ 100 AMETA_ALT_RIGHT_ON = 0x20, 101 102 /** This mask is used to check whether one of the SHIFT meta keys is pressed. */ 103 AMETA_SHIFT_ON = 0x01, 104 105 /** This mask is used to check whether the left SHIFT meta key is pressed. */ 106 AMETA_SHIFT_LEFT_ON = 0x40, 107 108 /** This mask is used to check whether the right SHIFT meta key is pressed. */ 109 AMETA_SHIFT_RIGHT_ON = 0x80, 110 111 /** This mask is used to check whether the SYM meta key is pressed. */ 112 AMETA_SYM_ON = 0x04, 113 114 /** This mask is used to check whether the FUNCTION meta key is pressed. */ 115 AMETA_FUNCTION_ON = 0x08, 116 117 /** This mask is used to check whether one of the CTRL meta keys is pressed. */ 118 AMETA_CTRL_ON = 0x1000, 119 120 /** This mask is used to check whether the left CTRL meta key is pressed. */ 121 AMETA_CTRL_LEFT_ON = 0x2000, 122 123 /** This mask is used to check whether the right CTRL meta key is pressed. */ 124 AMETA_CTRL_RIGHT_ON = 0x4000, 125 126 /** This mask is used to check whether one of the META meta keys is pressed. */ 127 AMETA_META_ON = 0x10000, 128 129 /** This mask is used to check whether the left META meta key is pressed. */ 130 AMETA_META_LEFT_ON = 0x20000, 131 132 /** This mask is used to check whether the right META meta key is pressed. */ 133 AMETA_META_RIGHT_ON = 0x40000, 134 135 /** This mask is used to check whether the CAPS LOCK meta key is on. */ 136 AMETA_CAPS_LOCK_ON = 0x100000, 137 138 /** This mask is used to check whether the NUM LOCK meta key is on. */ 139 AMETA_NUM_LOCK_ON = 0x200000, 140 141 /** This mask is used to check whether the SCROLL LOCK meta key is on. */ 142 AMETA_SCROLL_LOCK_ON = 0x400000, 143 }; 144 145 struct AInputEvent; 146 /** 147 * Input events. 148 * 149 * Input events are opaque structures. Use the provided accessors functions to 150 * read their properties. 151 */ 152 typedef struct AInputEvent AInputEvent; 153 154 /** 155 * Input event types. 156 */ 157 enum { 158 /** Indicates that the input event is a key event. */ 159 AINPUT_EVENT_TYPE_KEY = 1, 160 161 /** Indicates that the input event is a motion event. */ 162 AINPUT_EVENT_TYPE_MOTION = 2, 163 164 /** Focus event */ 165 AINPUT_EVENT_TYPE_FOCUS = 3, 166 167 /** Capture event */ 168 AINPUT_EVENT_TYPE_CAPTURE = 4, 169 170 /** Drag event */ 171 AINPUT_EVENT_TYPE_DRAG = 5, 172 }; 173 174 /** 175 * Key event actions. 176 */ 177 enum { 178 /** The key has been pressed down. */ 179 AKEY_EVENT_ACTION_DOWN = 0, 180 181 /** The key has been released. */ 182 AKEY_EVENT_ACTION_UP = 1, 183 184 /** 185 * Multiple duplicate key events have occurred in a row, or a 186 * complex string is being delivered. The repeat_count property 187 * of the key event contains the number of times the given key 188 * code should be executed. 189 */ 190 AKEY_EVENT_ACTION_MULTIPLE = 2 191 }; 192 193 /** 194 * Key event flags. 195 */ 196 enum { 197 /** This mask is set if the device woke because of this key event. */ 198 AKEY_EVENT_FLAG_WOKE_HERE = 0x1, 199 200 /** This mask is set if the key event was generated by a software keyboard. */ 201 AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2, 202 203 /** This mask is set if we don't want the key event to cause us to leave touch mode. */ 204 AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4, 205 206 /** 207 * This mask is set if an event was known to come from a trusted 208 * part of the system. That is, the event is known to come from 209 * the user, and could not have been spoofed by a third party 210 * component. 211 */ 212 AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8, 213 214 /** 215 * This mask is used for compatibility, to identify enter keys that are 216 * coming from an IME whose enter key has been auto-labelled "next" or 217 * "done". This allows TextView to dispatch these as normal enter keys 218 * for old applications, but still do the appropriate action when 219 * receiving them. 220 */ 221 AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10, 222 223 /** 224 * When associated with up key events, this indicates that the key press 225 * has been canceled. Typically this is used with virtual touch screen 226 * keys, where the user can slide from the virtual key area on to the 227 * display: in that case, the application will receive a canceled up 228 * event and should not perform the action normally associated with the 229 * key. Note that for this to work, the application can not perform an 230 * action for a key until it receives an up or the long press timeout has 231 * expired. 232 */ 233 AKEY_EVENT_FLAG_CANCELED = 0x20, 234 235 /** 236 * This key event was generated by a virtual (on-screen) hard key area. 237 * Typically this is an area of the touchscreen, outside of the regular 238 * display, dedicated to "hardware" buttons. 239 */ 240 AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40, 241 242 /** 243 * This flag is set for the first key repeat that occurs after the 244 * long press timeout. 245 */ 246 AKEY_EVENT_FLAG_LONG_PRESS = 0x80, 247 248 /** 249 * Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long 250 * press action was executed while it was down. 251 */ 252 AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100, 253 254 /** 255 * Set for AKEY_EVENT_ACTION_UP when this event's key code is still being 256 * tracked from its initial down. That is, somebody requested that tracking 257 * started on the key down and a long press has not caused 258 * the tracking to be canceled. 259 */ 260 AKEY_EVENT_FLAG_TRACKING = 0x200, 261 262 /** 263 * Set when a key event has been synthesized to implement default behavior 264 * for an event that the application did not handle. 265 * Fallback key events are generated by unhandled trackball motions 266 * (to emulate a directional keypad) and by certain unhandled key presses 267 * that are declared in the key map (such as special function numeric keypad 268 * keys when numlock is off). 269 */ 270 AKEY_EVENT_FLAG_FALLBACK = 0x400, 271 }; 272 273 /** 274 * Bit shift for the action bits holding the pointer index as 275 * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK. 276 */ 277 #define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8 278 279 /** Motion event actions */ 280 enum { 281 /** Bit mask of the parts of the action code that are the action itself. */ 282 AMOTION_EVENT_ACTION_MASK = 0xff, 283 284 /** 285 * Bits in the action code that represent a pointer index, used with 286 * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP. Shifting 287 * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer 288 * index where the data for the pointer going up or down can be found. 289 */ 290 AMOTION_EVENT_ACTION_POINTER_INDEX_MASK = 0xff00, 291 292 /** A pressed gesture has started, the motion contains the initial starting location. */ 293 AMOTION_EVENT_ACTION_DOWN = 0, 294 295 /** 296 * A pressed gesture has finished, the motion contains the final release location 297 * as well as any intermediate points since the last down or move event. 298 */ 299 AMOTION_EVENT_ACTION_UP = 1, 300 301 /** 302 * A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and 303 * AMOTION_EVENT_ACTION_UP). The motion contains the most recent point, as well as 304 * any intermediate points since the last down or move event. 305 */ 306 AMOTION_EVENT_ACTION_MOVE = 2, 307 308 /** 309 * The current gesture has been aborted. 310 * You will not receive any more points in it. You should treat this as 311 * an up event, but not perform any action that you normally would. 312 */ 313 AMOTION_EVENT_ACTION_CANCEL = 3, 314 315 /** 316 * A movement has happened outside of the normal bounds of the UI element. 317 * This does not provide a full gesture, but only the initial location of the movement/touch. 318 */ 319 AMOTION_EVENT_ACTION_OUTSIDE = 4, 320 321 /** 322 * A non-primary pointer has gone down. 323 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed. 324 */ 325 AMOTION_EVENT_ACTION_POINTER_DOWN = 5, 326 327 /** 328 * A non-primary pointer has gone up. 329 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed. 330 */ 331 AMOTION_EVENT_ACTION_POINTER_UP = 6, 332 333 /** 334 * A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE). 335 * The motion contains the most recent point, as well as any intermediate points since 336 * the last hover move event. 337 */ 338 AMOTION_EVENT_ACTION_HOVER_MOVE = 7, 339 340 /** 341 * The motion event contains relative vertical and/or horizontal scroll offsets. 342 * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL 343 * and AMOTION_EVENT_AXIS_HSCROLL. 344 * The pointer may or may not be down when this event is dispatched. 345 * This action is always delivered to the winder under the pointer, which 346 * may not be the window currently touched. 347 */ 348 AMOTION_EVENT_ACTION_SCROLL = 8, 349 350 /** The pointer is not down but has entered the boundaries of a window or view. */ 351 AMOTION_EVENT_ACTION_HOVER_ENTER = 9, 352 353 /** The pointer is not down but has exited the boundaries of a window or view. */ 354 AMOTION_EVENT_ACTION_HOVER_EXIT = 10, 355 356 /* One or more buttons have been pressed. */ 357 AMOTION_EVENT_ACTION_BUTTON_PRESS = 11, 358 359 /* One or more buttons have been released. */ 360 AMOTION_EVENT_ACTION_BUTTON_RELEASE = 12, 361 }; 362 363 /** 364 * Motion event flags. 365 */ 366 enum { 367 /** 368 * This flag indicates that the window that received this motion event is partly 369 * or wholly obscured by another visible window above it. This flag is set to true 370 * even if the event did not directly pass through the obscured area. 371 * A security sensitive application can check this flag to identify situations in which 372 * a malicious application may have covered up part of its content for the purpose 373 * of misleading the user or hijacking touches. An appropriate response might be 374 * to drop the suspect touches or to take additional precautions to confirm the user's 375 * actual intent. 376 */ 377 AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1, 378 }; 379 380 /** 381 * Motion event edge touch flags. 382 */ 383 enum { 384 /** No edges intersected. */ 385 AMOTION_EVENT_EDGE_FLAG_NONE = 0, 386 387 /** Flag indicating the motion event intersected the top edge of the screen. */ 388 AMOTION_EVENT_EDGE_FLAG_TOP = 0x01, 389 390 /** Flag indicating the motion event intersected the bottom edge of the screen. */ 391 AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02, 392 393 /** Flag indicating the motion event intersected the left edge of the screen. */ 394 AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04, 395 396 /** Flag indicating the motion event intersected the right edge of the screen. */ 397 AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08 398 }; 399 400 /** 401 * Constants that identify each individual axis of a motion event. 402 * @anchor AMOTION_EVENT_AXIS 403 */ 404 enum { 405 /** 406 * Axis constant: X axis of a motion event. 407 * 408 * - For a touch screen, reports the absolute X screen position of the center of 409 * the touch contact area. The units are display pixels. 410 * - For a touch pad, reports the absolute X surface position of the center of the touch 411 * contact area. The units are device-dependent. 412 * - For a mouse, reports the absolute X screen position of the mouse pointer. 413 * The units are display pixels. 414 * - For a trackball, reports the relative horizontal displacement of the trackball. 415 * The value is normalized to a range from -1.0 (left) to 1.0 (right). 416 * - For a joystick, reports the absolute X position of the joystick. 417 * The value is normalized to a range from -1.0 (left) to 1.0 (right). 418 */ 419 AMOTION_EVENT_AXIS_X = 0, 420 /** 421 * Axis constant: Y axis of a motion event. 422 * 423 * - For a touch screen, reports the absolute Y screen position of the center of 424 * the touch contact area. The units are display pixels. 425 * - For a touch pad, reports the absolute Y surface position of the center of the touch 426 * contact area. The units are device-dependent. 427 * - For a mouse, reports the absolute Y screen position of the mouse pointer. 428 * The units are display pixels. 429 * - For a trackball, reports the relative vertical displacement of the trackball. 430 * The value is normalized to a range from -1.0 (up) to 1.0 (down). 431 * - For a joystick, reports the absolute Y position of the joystick. 432 * The value is normalized to a range from -1.0 (up or far) to 1.0 (down or near). 433 */ 434 AMOTION_EVENT_AXIS_Y = 1, 435 /** 436 * Axis constant: Pressure axis of a motion event. 437 * 438 * - For a touch screen or touch pad, reports the approximate pressure applied to the surface 439 * by a finger or other tool. The value is normalized to a range from 440 * 0 (no pressure at all) to 1 (normal pressure), although values higher than 1 441 * may be generated depending on the calibration of the input device. 442 * - For a trackball, the value is set to 1 if the trackball button is pressed 443 * or 0 otherwise. 444 * - For a mouse, the value is set to 1 if the primary mouse button is pressed 445 * or 0 otherwise. 446 */ 447 AMOTION_EVENT_AXIS_PRESSURE = 2, 448 /** 449 * Axis constant: Size axis of a motion event. 450 * 451 * - For a touch screen or touch pad, reports the approximate size of the contact area in 452 * relation to the maximum detectable size for the device. The value is normalized 453 * to a range from 0 (smallest detectable size) to 1 (largest detectable size), 454 * although it is not a linear scale. This value is of limited use. 455 * To obtain calibrated size information, see 456 * {@link AMOTION_EVENT_AXIS_TOUCH_MAJOR} or {@link AMOTION_EVENT_AXIS_TOOL_MAJOR}. 457 */ 458 AMOTION_EVENT_AXIS_SIZE = 3, 459 /** 460 * Axis constant: TouchMajor axis of a motion event. 461 * 462 * - For a touch screen, reports the length of the major axis of an ellipse that 463 * represents the touch area at the point of contact. 464 * The units are display pixels. 465 * - For a touch pad, reports the length of the major axis of an ellipse that 466 * represents the touch area at the point of contact. 467 * The units are device-dependent. 468 */ 469 AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4, 470 /** 471 * Axis constant: TouchMinor axis of a motion event. 472 * 473 * - For a touch screen, reports the length of the minor axis of an ellipse that 474 * represents the touch area at the point of contact. 475 * The units are display pixels. 476 * - For a touch pad, reports the length of the minor axis of an ellipse that 477 * represents the touch area at the point of contact. 478 * The units are device-dependent. 479 * 480 * When the touch is circular, the major and minor axis lengths will be equal to one another. 481 */ 482 AMOTION_EVENT_AXIS_TOUCH_MINOR = 5, 483 /** 484 * Axis constant: ToolMajor axis of a motion event. 485 * 486 * - For a touch screen, reports the length of the major axis of an ellipse that 487 * represents the size of the approaching finger or tool used to make contact. 488 * - For a touch pad, reports the length of the major axis of an ellipse that 489 * represents the size of the approaching finger or tool used to make contact. 490 * The units are device-dependent. 491 * 492 * When the touch is circular, the major and minor axis lengths will be equal to one another. 493 * 494 * The tool size may be larger than the touch size since the tool may not be fully 495 * in contact with the touch sensor. 496 */ 497 AMOTION_EVENT_AXIS_TOOL_MAJOR = 6, 498 /** 499 * Axis constant: ToolMinor axis of a motion event. 500 * 501 * - For a touch screen, reports the length of the minor axis of an ellipse that 502 * represents the size of the approaching finger or tool used to make contact. 503 * - For a touch pad, reports the length of the minor axis of an ellipse that 504 * represents the size of the approaching finger or tool used to make contact. 505 * The units are device-dependent. 506 * 507 * When the touch is circular, the major and minor axis lengths will be equal to one another. 508 * 509 * The tool size may be larger than the touch size since the tool may not be fully 510 * in contact with the touch sensor. 511 */ 512 AMOTION_EVENT_AXIS_TOOL_MINOR = 7, 513 /** 514 * Axis constant: Orientation axis of a motion event. 515 * 516 * - For a touch screen or touch pad, reports the orientation of the finger 517 * or tool in radians relative to the vertical plane of the device. 518 * An angle of 0 radians indicates that the major axis of contact is oriented 519 * upwards, is perfectly circular or is of unknown orientation. A positive angle 520 * indicates that the major axis of contact is oriented to the right. A negative angle 521 * indicates that the major axis of contact is oriented to the left. 522 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians 523 * (finger pointing fully right). 524 * - For a stylus, the orientation indicates the direction in which the stylus 525 * is pointing in relation to the vertical axis of the current orientation of the screen. 526 * The range is from -PI radians to PI radians, where 0 is pointing up, 527 * -PI/2 radians is pointing left, -PI or PI radians is pointing down, and PI/2 radians 528 * is pointing right. See also {@link AMOTION_EVENT_AXIS_TILT}. 529 */ 530 AMOTION_EVENT_AXIS_ORIENTATION = 8, 531 /** 532 * Axis constant: Vertical Scroll axis of a motion event. 533 * 534 * - For a mouse, reports the relative movement of the vertical scroll wheel. 535 * The value is normalized to a range from -1.0 (down) to 1.0 (up). 536 * 537 * This axis should be used to scroll views vertically. 538 */ 539 AMOTION_EVENT_AXIS_VSCROLL = 9, 540 /** 541 * Axis constant: Horizontal Scroll axis of a motion event. 542 * 543 * - For a mouse, reports the relative movement of the horizontal scroll wheel. 544 * The value is normalized to a range from -1.0 (left) to 1.0 (right). 545 * 546 * This axis should be used to scroll views horizontally. 547 */ 548 AMOTION_EVENT_AXIS_HSCROLL = 10, 549 /** 550 * Axis constant: Z axis of a motion event. 551 * 552 * - For a joystick, reports the absolute Z position of the joystick. 553 * The value is normalized to a range from -1.0 (high) to 1.0 (low). 554 * <em>On game pads with two analog joysticks, this axis is often reinterpreted 555 * to report the absolute X position of the second joystick instead.</em> 556 */ 557 AMOTION_EVENT_AXIS_Z = 11, 558 /** 559 * Axis constant: X Rotation axis of a motion event. 560 * 561 * - For a joystick, reports the absolute rotation angle about the X axis. 562 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise). 563 */ 564 AMOTION_EVENT_AXIS_RX = 12, 565 /** 566 * Axis constant: Y Rotation axis of a motion event. 567 * 568 * - For a joystick, reports the absolute rotation angle about the Y axis. 569 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise). 570 */ 571 AMOTION_EVENT_AXIS_RY = 13, 572 /** 573 * Axis constant: Z Rotation axis of a motion event. 574 * 575 * - For a joystick, reports the absolute rotation angle about the Z axis. 576 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise). 577 * On game pads with two analog joysticks, this axis is often reinterpreted 578 * to report the absolute Y position of the second joystick instead. 579 */ 580 AMOTION_EVENT_AXIS_RZ = 14, 581 /** 582 * Axis constant: Hat X axis of a motion event. 583 * 584 * - For a joystick, reports the absolute X position of the directional hat control. 585 * The value is normalized to a range from -1.0 (left) to 1.0 (right). 586 */ 587 AMOTION_EVENT_AXIS_HAT_X = 15, 588 /** 589 * Axis constant: Hat Y axis of a motion event. 590 * 591 * - For a joystick, reports the absolute Y position of the directional hat control. 592 * The value is normalized to a range from -1.0 (up) to 1.0 (down). 593 */ 594 AMOTION_EVENT_AXIS_HAT_Y = 16, 595 /** 596 * Axis constant: Left Trigger axis of a motion event. 597 * 598 * - For a joystick, reports the absolute position of the left trigger control. 599 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed). 600 */ 601 AMOTION_EVENT_AXIS_LTRIGGER = 17, 602 /** 603 * Axis constant: Right Trigger axis of a motion event. 604 * 605 * - For a joystick, reports the absolute position of the right trigger control. 606 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed). 607 */ 608 AMOTION_EVENT_AXIS_RTRIGGER = 18, 609 /** 610 * Axis constant: Throttle axis of a motion event. 611 * 612 * - For a joystick, reports the absolute position of the throttle control. 613 * The value is normalized to a range from 0.0 (fully open) to 1.0 (fully closed). 614 */ 615 AMOTION_EVENT_AXIS_THROTTLE = 19, 616 /** 617 * Axis constant: Rudder axis of a motion event. 618 * 619 * - For a joystick, reports the absolute position of the rudder control. 620 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right). 621 */ 622 AMOTION_EVENT_AXIS_RUDDER = 20, 623 /** 624 * Axis constant: Wheel axis of a motion event. 625 * 626 * - For a joystick, reports the absolute position of the steering wheel control. 627 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right). 628 */ 629 AMOTION_EVENT_AXIS_WHEEL = 21, 630 /** 631 * Axis constant: Gas axis of a motion event. 632 * 633 * - For a joystick, reports the absolute position of the gas (accelerator) control. 634 * The value is normalized to a range from 0.0 (no acceleration) 635 * to 1.0 (maximum acceleration). 636 */ 637 AMOTION_EVENT_AXIS_GAS = 22, 638 /** 639 * Axis constant: Brake axis of a motion event. 640 * 641 * - For a joystick, reports the absolute position of the brake control. 642 * The value is normalized to a range from 0.0 (no braking) to 1.0 (maximum braking). 643 */ 644 AMOTION_EVENT_AXIS_BRAKE = 23, 645 /** 646 * Axis constant: Distance axis of a motion event. 647 * 648 * - For a stylus, reports the distance of the stylus from the screen. 649 * A value of 0.0 indicates direct contact and larger values indicate increasing 650 * distance from the surface. 651 */ 652 AMOTION_EVENT_AXIS_DISTANCE = 24, 653 /** 654 * Axis constant: Tilt axis of a motion event. 655 * 656 * - For a stylus, reports the tilt angle of the stylus in radians where 657 * 0 radians indicates that the stylus is being held perpendicular to the 658 * surface, and PI/2 radians indicates that the stylus is being held flat 659 * against the surface. 660 */ 661 AMOTION_EVENT_AXIS_TILT = 25, 662 /** 663 * Axis constant: Generic scroll axis of a motion event. 664 * 665 * - This is used for scroll axis motion events that can't be classified as strictly 666 * vertical or horizontal. The movement of a rotating scroller is an example of this. 667 */ 668 AMOTION_EVENT_AXIS_SCROLL = 26, 669 /** 670 * Axis constant: The movement of x position of a motion event. 671 * 672 * - For a mouse, reports a difference of x position between the previous position. 673 * This is useful when pointer is captured, in that case the mouse pointer doesn't 674 * change the location but this axis reports the difference which allows the app 675 * to see how the mouse is moved. 676 */ 677 AMOTION_EVENT_AXIS_RELATIVE_X = 27, 678 /** 679 * Axis constant: The movement of y position of a motion event. 680 * 681 * Same as {@link AMOTION_EVENT_AXIS_RELATIVE_X}, but for y position. 682 */ 683 AMOTION_EVENT_AXIS_RELATIVE_Y = 28, 684 /** 685 * Axis constant: Generic 1 axis of a motion event. 686 * The interpretation of a generic axis is device-specific. 687 */ 688 AMOTION_EVENT_AXIS_GENERIC_1 = 32, 689 /** 690 * Axis constant: Generic 2 axis of a motion event. 691 * The interpretation of a generic axis is device-specific. 692 */ 693 AMOTION_EVENT_AXIS_GENERIC_2 = 33, 694 /** 695 * Axis constant: Generic 3 axis of a motion event. 696 * The interpretation of a generic axis is device-specific. 697 */ 698 AMOTION_EVENT_AXIS_GENERIC_3 = 34, 699 /** 700 * Axis constant: Generic 4 axis of a motion event. 701 * The interpretation of a generic axis is device-specific. 702 */ 703 AMOTION_EVENT_AXIS_GENERIC_4 = 35, 704 /** 705 * Axis constant: Generic 5 axis of a motion event. 706 * The interpretation of a generic axis is device-specific. 707 */ 708 AMOTION_EVENT_AXIS_GENERIC_5 = 36, 709 /** 710 * Axis constant: Generic 6 axis of a motion event. 711 * The interpretation of a generic axis is device-specific. 712 */ 713 AMOTION_EVENT_AXIS_GENERIC_6 = 37, 714 /** 715 * Axis constant: Generic 7 axis of a motion event. 716 * The interpretation of a generic axis is device-specific. 717 */ 718 AMOTION_EVENT_AXIS_GENERIC_7 = 38, 719 /** 720 * Axis constant: Generic 8 axis of a motion event. 721 * The interpretation of a generic axis is device-specific. 722 */ 723 AMOTION_EVENT_AXIS_GENERIC_8 = 39, 724 /** 725 * Axis constant: Generic 9 axis of a motion event. 726 * The interpretation of a generic axis is device-specific. 727 */ 728 AMOTION_EVENT_AXIS_GENERIC_9 = 40, 729 /** 730 * Axis constant: Generic 10 axis of a motion event. 731 * The interpretation of a generic axis is device-specific. 732 */ 733 AMOTION_EVENT_AXIS_GENERIC_10 = 41, 734 /** 735 * Axis constant: Generic 11 axis of a motion event. 736 * The interpretation of a generic axis is device-specific. 737 */ 738 AMOTION_EVENT_AXIS_GENERIC_11 = 42, 739 /** 740 * Axis constant: Generic 12 axis of a motion event. 741 * The interpretation of a generic axis is device-specific. 742 */ 743 AMOTION_EVENT_AXIS_GENERIC_12 = 43, 744 /** 745 * Axis constant: Generic 13 axis of a motion event. 746 * The interpretation of a generic axis is device-specific. 747 */ 748 AMOTION_EVENT_AXIS_GENERIC_13 = 44, 749 /** 750 * Axis constant: Generic 14 axis of a motion event. 751 * The interpretation of a generic axis is device-specific. 752 */ 753 AMOTION_EVENT_AXIS_GENERIC_14 = 45, 754 /** 755 * Axis constant: Generic 15 axis of a motion event. 756 * The interpretation of a generic axis is device-specific. 757 */ 758 AMOTION_EVENT_AXIS_GENERIC_15 = 46, 759 /** 760 * Axis constant: Generic 16 axis of a motion event. 761 * The interpretation of a generic axis is device-specific. 762 */ 763 AMOTION_EVENT_AXIS_GENERIC_16 = 47, 764 765 // NOTE: If you add a new axis here you must also add it to several other files. 766 // Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list. 767 }; 768 769 /** 770 * Constants that identify buttons that are associated with motion events. 771 * Refer to the documentation on the MotionEvent class for descriptions of each button. 772 */ 773 enum { 774 /** primary */ 775 AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0, 776 /** secondary */ 777 AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1, 778 /** tertiary */ 779 AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2, 780 /** back */ 781 AMOTION_EVENT_BUTTON_BACK = 1 << 3, 782 /** forward */ 783 AMOTION_EVENT_BUTTON_FORWARD = 1 << 4, 784 AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5, 785 AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6, 786 }; 787 788 /** 789 * Constants that identify tool types. 790 * Refer to the documentation on the MotionEvent class for descriptions of each tool type. 791 */ 792 enum { 793 /** unknown */ 794 AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0, 795 /** finger */ 796 AMOTION_EVENT_TOOL_TYPE_FINGER = 1, 797 /** stylus */ 798 AMOTION_EVENT_TOOL_TYPE_STYLUS = 2, 799 /** mouse */ 800 AMOTION_EVENT_TOOL_TYPE_MOUSE = 3, 801 /** eraser */ 802 AMOTION_EVENT_TOOL_TYPE_ERASER = 4, 803 /** palm */ 804 AMOTION_EVENT_TOOL_TYPE_PALM = 5, 805 }; 806 807 /** 808 * Input source masks. 809 * 810 * Refer to the documentation on android.view.InputDevice for more details about input sources 811 * and their correct interpretation. 812 */ 813 enum { 814 /** mask */ 815 AINPUT_SOURCE_CLASS_MASK = 0x000000ff, 816 817 /** none */ 818 AINPUT_SOURCE_CLASS_NONE = 0x00000000, 819 /** button */ 820 AINPUT_SOURCE_CLASS_BUTTON = 0x00000001, 821 /** pointer */ 822 AINPUT_SOURCE_CLASS_POINTER = 0x00000002, 823 /** navigation */ 824 AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004, 825 /** position */ 826 AINPUT_SOURCE_CLASS_POSITION = 0x00000008, 827 /** joystick */ 828 AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010, 829 }; 830 831 /** 832 * Input sources. 833 */ 834 enum { 835 /** unknown */ 836 AINPUT_SOURCE_UNKNOWN = 0x00000000, 837 838 /** keyboard */ 839 AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON, 840 /** dpad */ 841 AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON, 842 /** gamepad */ 843 AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON, 844 /** touchscreen */ 845 AINPUT_SOURCE_TOUCHSCREEN = 0x00001000 | AINPUT_SOURCE_CLASS_POINTER, 846 /** mouse */ 847 AINPUT_SOURCE_MOUSE = 0x00002000 | AINPUT_SOURCE_CLASS_POINTER, 848 /** stylus */ 849 AINPUT_SOURCE_STYLUS = 0x00004000 | AINPUT_SOURCE_CLASS_POINTER, 850 /** bluetooth stylus */ 851 AINPUT_SOURCE_BLUETOOTH_STYLUS = 0x00008000 | AINPUT_SOURCE_STYLUS, 852 /** trackball */ 853 AINPUT_SOURCE_TRACKBALL = 0x00010000 | AINPUT_SOURCE_CLASS_NAVIGATION, 854 /** mouse relative */ 855 AINPUT_SOURCE_MOUSE_RELATIVE = 0x00020000 | AINPUT_SOURCE_CLASS_NAVIGATION, 856 /** touchpad */ 857 AINPUT_SOURCE_TOUCHPAD = 0x00100000 | AINPUT_SOURCE_CLASS_POSITION, 858 /** navigation */ 859 AINPUT_SOURCE_TOUCH_NAVIGATION = 0x00200000 | AINPUT_SOURCE_CLASS_NONE, 860 /** joystick */ 861 AINPUT_SOURCE_JOYSTICK = 0x01000000 | AINPUT_SOURCE_CLASS_JOYSTICK, 862 /** HDMI */ 863 AINPUT_SOURCE_HDMI = 0x02000000 | AINPUT_SOURCE_CLASS_BUTTON, 864 /** sensor */ 865 AINPUT_SOURCE_SENSOR = 0x04000000 | AINPUT_SOURCE_CLASS_NONE, 866 /** rotary encoder */ 867 AINPUT_SOURCE_ROTARY_ENCODER = 0x00400000 | AINPUT_SOURCE_CLASS_NONE, 868 869 /** any */ 870 AINPUT_SOURCE_ANY = 0xffffff00, 871 }; 872 873 /** 874 * Keyboard types. 875 * 876 * Refer to the documentation on android.view.InputDevice for more details. 877 */ 878 enum { 879 /** none */ 880 AINPUT_KEYBOARD_TYPE_NONE = 0, 881 /** non alphabetic */ 882 AINPUT_KEYBOARD_TYPE_NON_ALPHABETIC = 1, 883 /** alphabetic */ 884 AINPUT_KEYBOARD_TYPE_ALPHABETIC = 2, 885 }; 886 887 /** 888 * Constants used to retrieve information about the range of motion for a particular 889 * coordinate of a motion event. 890 * 891 * Refer to the documentation on android.view.InputDevice for more details about input sources 892 * and their correct interpretation. 893 * 894 * @deprecated These constants are deprecated. Use {@link AMOTION_EVENT_AXIS AMOTION_EVENT_AXIS_*} constants instead. 895 */ 896 enum { 897 /** x */ 898 AINPUT_MOTION_RANGE_X = AMOTION_EVENT_AXIS_X, 899 /** y */ 900 AINPUT_MOTION_RANGE_Y = AMOTION_EVENT_AXIS_Y, 901 /** pressure */ 902 AINPUT_MOTION_RANGE_PRESSURE = AMOTION_EVENT_AXIS_PRESSURE, 903 /** size */ 904 AINPUT_MOTION_RANGE_SIZE = AMOTION_EVENT_AXIS_SIZE, 905 /** touch major */ 906 AINPUT_MOTION_RANGE_TOUCH_MAJOR = AMOTION_EVENT_AXIS_TOUCH_MAJOR, 907 /** touch minor */ 908 AINPUT_MOTION_RANGE_TOUCH_MINOR = AMOTION_EVENT_AXIS_TOUCH_MINOR, 909 /** tool major */ 910 AINPUT_MOTION_RANGE_TOOL_MAJOR = AMOTION_EVENT_AXIS_TOOL_MAJOR, 911 /** tool minor */ 912 AINPUT_MOTION_RANGE_TOOL_MINOR = AMOTION_EVENT_AXIS_TOOL_MINOR, 913 /** orientation */ 914 AINPUT_MOTION_RANGE_ORIENTATION = AMOTION_EVENT_AXIS_ORIENTATION, 915 }; 916 917 918 /** 919 * Input event accessors. 920 * 921 * Note that most functions can only be used on input events that are of a given type. 922 * Calling these functions on input events of other types will yield undefined behavior. 923 */ 924 925 /*** Accessors for all input events. ***/ 926 927 /** Get the input event type. */ 928 int32_t AInputEvent_getType(const AInputEvent* event); 929 930 /** Get the id for the device that an input event came from. 931 * 932 * Input events can be generated by multiple different input devices. 933 * Use the input device id to obtain information about the input 934 * device that was responsible for generating a particular event. 935 * 936 * An input device id of 0 indicates that the event didn't come from a physical device; 937 * other numbers are arbitrary and you shouldn't depend on the values. 938 * Use the provided input device query API to obtain information about input devices. 939 */ 940 int32_t AInputEvent_getDeviceId(const AInputEvent* event); 941 942 /** Get the input event source. */ 943 int32_t AInputEvent_getSource(const AInputEvent* event); 944 945 /** 946 * Releases interface objects created by {@link AKeyEvent_fromJava()} 947 * and {@link AMotionEvent_fromJava()}. 948 * After returning, the specified AInputEvent* object becomes invalid and should no longer be used. 949 * The underlying Java object remains valid and does not change its state. 950 */ 951 952 void AInputEvent_release(const AInputEvent* event); 953 954 /*** Accessors for key events only. ***/ 955 956 /** Get the key event action. */ 957 int32_t AKeyEvent_getAction(const AInputEvent* key_event); 958 959 /** Get the key event flags. */ 960 int32_t AKeyEvent_getFlags(const AInputEvent* key_event); 961 962 /** 963 * Get the key code of the key event. 964 * This is the physical key that was pressed, not the Unicode character. 965 */ 966 int32_t AKeyEvent_getKeyCode(const AInputEvent* key_event); 967 968 /** 969 * Get the hardware key id of this key event. 970 * These values are not reliable and vary from device to device. 971 */ 972 int32_t AKeyEvent_getScanCode(const AInputEvent* key_event); 973 974 /** Get the meta key state. */ 975 int32_t AKeyEvent_getMetaState(const AInputEvent* key_event); 976 977 /** 978 * Get the repeat count of the event. 979 * For both key up an key down events, this is the number of times the key has 980 * repeated with the first down starting at 0 and counting up from there. For 981 * multiple key events, this is the number of down/up pairs that have occurred. 982 */ 983 int32_t AKeyEvent_getRepeatCount(const AInputEvent* key_event); 984 985 /** 986 * Get the time of the most recent key down event, in the 987 * java.lang.System.nanoTime() time base. If this is a down event, 988 * this will be the same as eventTime. 989 * Note that when chording keys, this value is the down time of the most recently 990 * pressed key, which may not be the same physical key of this event. 991 */ 992 int64_t AKeyEvent_getDownTime(const AInputEvent* key_event); 993 994 /** 995 * Get the time this event occurred, in the 996 * java.lang.System.nanoTime() time base. 997 */ 998 int64_t AKeyEvent_getEventTime(const AInputEvent* key_event); 999 1000 /** 1001 * Creates a native AInputEvent* object that is a copy of the specified Java android.view.KeyEvent. 1002 * The result may be used with generic and KeyEvent-specific AInputEvent_* functions. The object 1003 * returned by this function must be disposed using {@link AInputEvent_release()}. 1004 */ 1005 const AInputEvent* AKeyEvent_fromJava(JNIEnv* env, jobject keyEvent); 1006 1007 /*** Accessors for motion events only. ***/ 1008 1009 /** Get the combined motion event action code and pointer index. */ 1010 int32_t AMotionEvent_getAction(const AInputEvent* motion_event); 1011 1012 /** Get the motion event flags. */ 1013 int32_t AMotionEvent_getFlags(const AInputEvent* motion_event); 1014 1015 /** 1016 * Get the state of any meta / modifier keys that were in effect when the 1017 * event was generated. 1018 */ 1019 int32_t AMotionEvent_getMetaState(const AInputEvent* motion_event); 1020 1021 /** Get the button state of all buttons that are pressed. */ 1022 int32_t AMotionEvent_getButtonState(const AInputEvent* motion_event); 1023 1024 /** 1025 * Get a bitfield indicating which edges, if any, were touched by this motion event. 1026 * For touch events, clients can use this to determine if the user's finger was 1027 * touching the edge of the display. 1028 */ 1029 int32_t AMotionEvent_getEdgeFlags(const AInputEvent* motion_event); 1030 1031 /** 1032 * Get the time when the user originally pressed down to start a stream of 1033 * position events, in the java.lang.System.nanoTime() time base. 1034 */ 1035 int64_t AMotionEvent_getDownTime(const AInputEvent* motion_event); 1036 1037 /** 1038 * Get the time when this specific event was generated, 1039 * in the java.lang.System.nanoTime() time base. 1040 */ 1041 int64_t AMotionEvent_getEventTime(const AInputEvent* motion_event); 1042 1043 /** 1044 * Get the X coordinate offset. 1045 * For touch events on the screen, this is the delta that was added to the raw 1046 * screen coordinates to adjust for the absolute position of the containing windows 1047 * and views. 1048 */ 1049 float AMotionEvent_getXOffset(const AInputEvent* motion_event); 1050 1051 /** 1052 * Get the Y coordinate offset. 1053 * For touch events on the screen, this is the delta that was added to the raw 1054 * screen coordinates to adjust for the absolute position of the containing windows 1055 * and views. 1056 */ 1057 float AMotionEvent_getYOffset(const AInputEvent* motion_event); 1058 1059 /** 1060 * Get the precision of the X coordinates being reported. 1061 * You can multiply this number with an X coordinate sample to find the 1062 * actual hardware value of the X coordinate. 1063 */ 1064 float AMotionEvent_getXPrecision(const AInputEvent* motion_event); 1065 1066 /** 1067 * Get the precision of the Y coordinates being reported. 1068 * You can multiply this number with a Y coordinate sample to find the 1069 * actual hardware value of the Y coordinate. 1070 */ 1071 float AMotionEvent_getYPrecision(const AInputEvent* motion_event); 1072 1073 /** 1074 * Get the number of pointers of data contained in this event. 1075 * Always >= 1. 1076 */ 1077 size_t AMotionEvent_getPointerCount(const AInputEvent* motion_event); 1078 1079 /** 1080 * Get the pointer identifier associated with a particular pointer 1081 * data index in this event. The identifier tells you the actual pointer 1082 * number associated with the data, accounting for individual pointers 1083 * going up and down since the start of the current gesture. 1084 */ 1085 int32_t AMotionEvent_getPointerId(const AInputEvent* motion_event, size_t pointer_index); 1086 1087 /** 1088 * Get the tool type of a pointer for the given pointer index. 1089 * The tool type indicates the type of tool used to make contact such as a 1090 * finger or stylus, if known. 1091 */ 1092 int32_t AMotionEvent_getToolType(const AInputEvent* motion_event, size_t pointer_index); 1093 1094 /** 1095 * Get the original raw X coordinate of this event. 1096 * For touch events on the screen, this is the original location of the event 1097 * on the screen, before it had been adjusted for the containing window 1098 * and views. 1099 */ 1100 float AMotionEvent_getRawX(const AInputEvent* motion_event, size_t pointer_index); 1101 1102 /** 1103 * Get the original raw X coordinate of this event. 1104 * For touch events on the screen, this is the original location of the event 1105 * on the screen, before it had been adjusted for the containing window 1106 * and views. 1107 */ 1108 float AMotionEvent_getRawY(const AInputEvent* motion_event, size_t pointer_index); 1109 1110 /** 1111 * Get the current X coordinate of this event for the given pointer index. 1112 * Whole numbers are pixels; the value may have a fraction for input devices 1113 * that are sub-pixel precise. 1114 */ 1115 float AMotionEvent_getX(const AInputEvent* motion_event, size_t pointer_index); 1116 1117 /** 1118 * Get the current Y coordinate of this event for the given pointer index. 1119 * Whole numbers are pixels; the value may have a fraction for input devices 1120 * that are sub-pixel precise. 1121 */ 1122 float AMotionEvent_getY(const AInputEvent* motion_event, size_t pointer_index); 1123 1124 /** 1125 * Get the current pressure of this event for the given pointer index. 1126 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure), 1127 * although values higher than 1 may be generated depending on the calibration of 1128 * the input device. 1129 */ 1130 float AMotionEvent_getPressure(const AInputEvent* motion_event, size_t pointer_index); 1131 1132 /** 1133 * Get the current scaled value of the approximate size for the given pointer index. 1134 * This represents some approximation of the area of the screen being 1135 * pressed; the actual value in pixels corresponding to the 1136 * touch is normalized with the device specific range of values 1137 * and scaled to a value between 0 and 1. The value of size can be used to 1138 * determine fat touch events. 1139 */ 1140 float AMotionEvent_getSize(const AInputEvent* motion_event, size_t pointer_index); 1141 1142 /** 1143 * Get the current length of the major axis of an ellipse that describes the touch area 1144 * at the point of contact for the given pointer index. 1145 */ 1146 float AMotionEvent_getTouchMajor(const AInputEvent* motion_event, size_t pointer_index); 1147 1148 /** 1149 * Get the current length of the minor axis of an ellipse that describes the touch area 1150 * at the point of contact for the given pointer index. 1151 */ 1152 float AMotionEvent_getTouchMinor(const AInputEvent* motion_event, size_t pointer_index); 1153 1154 /** 1155 * Get the current length of the major axis of an ellipse that describes the size 1156 * of the approaching tool for the given pointer index. 1157 * The tool area represents the estimated size of the finger or pen that is 1158 * touching the device independent of its actual touch area at the point of contact. 1159 */ 1160 float AMotionEvent_getToolMajor(const AInputEvent* motion_event, size_t pointer_index); 1161 1162 /** 1163 * Get the current length of the minor axis of an ellipse that describes the size 1164 * of the approaching tool for the given pointer index. 1165 * The tool area represents the estimated size of the finger or pen that is 1166 * touching the device independent of its actual touch area at the point of contact. 1167 */ 1168 float AMotionEvent_getToolMinor(const AInputEvent* motion_event, size_t pointer_index); 1169 1170 /** 1171 * Get the current orientation of the touch area and tool area in radians clockwise from 1172 * vertical for the given pointer index. 1173 * An angle of 0 degrees indicates that the major axis of contact is oriented 1174 * upwards, is perfectly circular or is of unknown orientation. A positive angle 1175 * indicates that the major axis of contact is oriented to the right. A negative angle 1176 * indicates that the major axis of contact is oriented to the left. 1177 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians 1178 * (finger pointing fully right). 1179 */ 1180 float AMotionEvent_getOrientation(const AInputEvent* motion_event, size_t pointer_index); 1181 1182 /** Get the value of the request axis for the given pointer index. */ 1183 float AMotionEvent_getAxisValue(const AInputEvent* motion_event, 1184 int32_t axis, size_t pointer_index); 1185 1186 /** 1187 * Get the number of historical points in this event. These are movements that 1188 * have occurred between this event and the previous event. This only applies 1189 * to AMOTION_EVENT_ACTION_MOVE events -- all other actions will have a size of 0. 1190 * Historical samples are indexed from oldest to newest. 1191 */ 1192 size_t AMotionEvent_getHistorySize(const AInputEvent* motion_event); 1193 1194 /** 1195 * Get the time that a historical movement occurred between this event and 1196 * the previous event, in the java.lang.System.nanoTime() time base. 1197 */ 1198 int64_t AMotionEvent_getHistoricalEventTime(const AInputEvent* motion_event, 1199 size_t history_index); 1200 1201 /** 1202 * Get the historical raw X coordinate of this event for the given pointer index that 1203 * occurred between this event and the previous motion event. 1204 * For touch events on the screen, this is the original location of the event 1205 * on the screen, before it had been adjusted for the containing window 1206 * and views. 1207 * Whole numbers are pixels; the value may have a fraction for input devices 1208 * that are sub-pixel precise. 1209 */ 1210 float AMotionEvent_getHistoricalRawX(const AInputEvent* motion_event, size_t pointer_index, 1211 size_t history_index); 1212 1213 /** 1214 * Get the historical raw Y coordinate of this event for the given pointer index that 1215 * occurred between this event and the previous motion event. 1216 * For touch events on the screen, this is the original location of the event 1217 * on the screen, before it had been adjusted for the containing window 1218 * and views. 1219 * Whole numbers are pixels; the value may have a fraction for input devices 1220 * that are sub-pixel precise. 1221 */ 1222 float AMotionEvent_getHistoricalRawY(const AInputEvent* motion_event, size_t pointer_index, 1223 size_t history_index); 1224 1225 /** 1226 * Get the historical X coordinate of this event for the given pointer index that 1227 * occurred between this event and the previous motion event. 1228 * Whole numbers are pixels; the value may have a fraction for input devices 1229 * that are sub-pixel precise. 1230 */ 1231 float AMotionEvent_getHistoricalX(const AInputEvent* motion_event, size_t pointer_index, 1232 size_t history_index); 1233 1234 /** 1235 * Get the historical Y coordinate of this event for the given pointer index that 1236 * occurred between this event and the previous motion event. 1237 * Whole numbers are pixels; the value may have a fraction for input devices 1238 * that are sub-pixel precise. 1239 */ 1240 float AMotionEvent_getHistoricalY(const AInputEvent* motion_event, size_t pointer_index, 1241 size_t history_index); 1242 1243 /** 1244 * Get the historical pressure of this event for the given pointer index that 1245 * occurred between this event and the previous motion event. 1246 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure), 1247 * although values higher than 1 may be generated depending on the calibration of 1248 * the input device. 1249 */ 1250 float AMotionEvent_getHistoricalPressure(const AInputEvent* motion_event, size_t pointer_index, 1251 size_t history_index); 1252 1253 /** 1254 * Get the current scaled value of the approximate size for the given pointer index that 1255 * occurred between this event and the previous motion event. 1256 * This represents some approximation of the area of the screen being 1257 * pressed; the actual value in pixels corresponding to the 1258 * touch is normalized with the device specific range of values 1259 * and scaled to a value between 0 and 1. The value of size can be used to 1260 * determine fat touch events. 1261 */ 1262 float AMotionEvent_getHistoricalSize(const AInputEvent* motion_event, size_t pointer_index, 1263 size_t history_index); 1264 1265 /** 1266 * Get the historical length of the major axis of an ellipse that describes the touch area 1267 * at the point of contact for the given pointer index that 1268 * occurred between this event and the previous motion event. 1269 */ 1270 float AMotionEvent_getHistoricalTouchMajor(const AInputEvent* motion_event, size_t pointer_index, 1271 size_t history_index); 1272 1273 /** 1274 * Get the historical length of the minor axis of an ellipse that describes the touch area 1275 * at the point of contact for the given pointer index that 1276 * occurred between this event and the previous motion event. 1277 */ 1278 float AMotionEvent_getHistoricalTouchMinor(const AInputEvent* motion_event, size_t pointer_index, 1279 size_t history_index); 1280 1281 /** 1282 * Get the historical length of the major axis of an ellipse that describes the size 1283 * of the approaching tool for the given pointer index that 1284 * occurred between this event and the previous motion event. 1285 * The tool area represents the estimated size of the finger or pen that is 1286 * touching the device independent of its actual touch area at the point of contact. 1287 */ 1288 float AMotionEvent_getHistoricalToolMajor(const AInputEvent* motion_event, size_t pointer_index, 1289 size_t history_index); 1290 1291 /** 1292 * Get the historical length of the minor axis of an ellipse that describes the size 1293 * of the approaching tool for the given pointer index that 1294 * occurred between this event and the previous motion event. 1295 * The tool area represents the estimated size of the finger or pen that is 1296 * touching the device independent of its actual touch area at the point of contact. 1297 */ 1298 float AMotionEvent_getHistoricalToolMinor(const AInputEvent* motion_event, size_t pointer_index, 1299 size_t history_index); 1300 1301 /** 1302 * Get the historical orientation of the touch area and tool area in radians clockwise from 1303 * vertical for the given pointer index that 1304 * occurred between this event and the previous motion event. 1305 * An angle of 0 degrees indicates that the major axis of contact is oriented 1306 * upwards, is perfectly circular or is of unknown orientation. A positive angle 1307 * indicates that the major axis of contact is oriented to the right. A negative angle 1308 * indicates that the major axis of contact is oriented to the left. 1309 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians 1310 * (finger pointing fully right). 1311 */ 1312 float AMotionEvent_getHistoricalOrientation(const AInputEvent* motion_event, size_t pointer_index, 1313 size_t history_index); 1314 1315 /** 1316 * Get the historical value of the request axis for the given pointer index 1317 * that occurred between this event and the previous motion event. 1318 */ 1319 float AMotionEvent_getHistoricalAxisValue(const AInputEvent* motion_event, 1320 int32_t axis, size_t pointer_index, size_t history_index); 1321 1322 /** 1323 * Creates a native AInputEvent* object that is a copy of the specified Java 1324 * android.view.MotionEvent. The result may be used with generic and MotionEvent-specific 1325 * AInputEvent_* functions. The object returned by this function must be disposed using 1326 * {@link AInputEvent_release()}. 1327 */ 1328 const AInputEvent* AMotionEvent_fromJava(JNIEnv* env, jobject motionEvent); 1329 1330 struct AInputQueue; 1331 /** 1332 * Input queue 1333 * 1334 * An input queue is the facility through which you retrieve input 1335 * events. 1336 */ 1337 typedef struct AInputQueue AInputQueue; 1338 1339 /** 1340 * Add this input queue to a looper for processing. See 1341 * ALooper_addFd() for information on the ident, callback, and data params. 1342 */ 1343 void AInputQueue_attachLooper(AInputQueue* queue, ALooper* looper, 1344 int ident, ALooper_callbackFunc callback, void* data); 1345 1346 /** 1347 * Remove the input queue from the looper it is currently attached to. 1348 */ 1349 void AInputQueue_detachLooper(AInputQueue* queue); 1350 1351 /** 1352 * Returns true if there are one or more events available in the 1353 * input queue. Returns 1 if the queue has events; 0 if 1354 * it does not have events; and a negative value if there is an error. 1355 */ 1356 int32_t AInputQueue_hasEvents(AInputQueue* queue); 1357 1358 /** 1359 * Returns the next available event from the queue. Returns a negative 1360 * value if no events are available or an error has occurred. 1361 */ 1362 int32_t AInputQueue_getEvent(AInputQueue* queue, AInputEvent** outEvent); 1363 1364 /** 1365 * Sends the key for standard pre-dispatching -- that is, possibly deliver 1366 * it to the current IME to be consumed before the app. Returns 0 if it 1367 * was not pre-dispatched, meaning you can process it right now. If non-zero 1368 * is returned, you must abandon the current event processing and allow the 1369 * event to appear again in the event queue (if it does not get consumed during 1370 * pre-dispatching). 1371 */ 1372 int32_t AInputQueue_preDispatchEvent(AInputQueue* queue, AInputEvent* event); 1373 1374 /** 1375 * Report that dispatching has finished with the given event. 1376 * This must be called after receiving an event with AInputQueue_get_event(). 1377 */ 1378 void AInputQueue_finishEvent(AInputQueue* queue, AInputEvent* event, int handled); 1379 1380 #ifdef __cplusplus 1381 } 1382 #endif 1383 1384 #endif // _ANDROID_INPUT_H 1385 1386 /** @} */ 1387