2 .\" Title: xgetdevicemotionevents
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: [FIXME: manual]
7 .\" Source: [FIXME: source]
10 .TH "XGETDEVICEMOTIONEVEN" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 XGetDeviceMotionEvents, XDeviceTimeCoord \- get device motion history
35 #include <X11/extensions/XInput\&.h>
39 XDeviceTimeCoord *XGetDeviceMotionEvents( Display *display,
45 int *axis_count_return);
50 Specifies the connection to the X server\&.
55 Specifies the device whose motion history is to be
61 Specify the time interval in which the events are
62 returned from the motionhistory buffer\&.You can pass a
63 timestamp or CurrentTime\&.
68 Returns the number of events from the motion history
74 Returns the mode of the device (Absolute or Relative)\&.
79 Returns the count of axes being reported\&.
87 The server may retain the recent history of the device motion
88 and do so to a finer granularity than is reported by
89 DeviceMotionNotify events\&. The XGetDeviceMotionEvents request
90 makes this history available\&.
100 The XGetDeviceMotionEvents request returns all events in the
101 motion history buffer that fall between the specified start and
102 stop times, inclusive\&. If the start time is later than the stop
103 time or if the start time is in the future, no events are
104 returned\&. If the stop time is in the future, it is equivalent
105 to specifying CurrentTime\&.
115 The mode indicates whether the device is reporting absolute
116 positional data (mode = Absolute ) or relative motion data
117 (mode = Relative )\&. Some devices allow their mode to be changed
118 via the XSetDeviceMode request\&. These constants are defined in
119 the file XI\&.h\&. The axis_count returns the number of axes or
120 valuators being reported by the device\&.
130 XGetDeviceMotionEvents can generate a BadDevice, or BadMatch
143 The XDeviceTimeCoord structure contains:
166 The time member is set to the time, in milliseconds\&. The data
167 member is a pointer to an array of integers\&. These integers are
168 set to the values of each valuator or axis reported by the
169 device\&. There is one element in the array per axis of motion
170 reported by the device\&. The value of the array elements depends
171 on the mode of the device\&. If the mode is Absolute, the values
172 are the raw values generated by the device\&. These may be scaled
173 by client programs using the maximum values that the device can
174 generate\&. The maximum value for each axis of the device is
175 reported in the max_val field of the XAxisInfo returned by the
176 XListInputDevices request\&. If the mode is Relative, the data
177 values are the relative values generated by the device\&.
187 You should use XFreeDeviceMotionEvents to free the data
188 returned by this request\&.
198 Errors returned by this request: BadDevice, BadMatch\&.
210 An invalid device was specified\&. The specified device
211 does not exist or has not been opened by this client via
212 XOpenInputDevice\&. This error may also occur if the
213 specified device is the X keyboard or X pointer device\&.
224 This error may occur if an XGetDeviceMotionEvents
225 request is made specifying a device that has no
226 valuators and reports no axes of motion\&.