summaryrefslogtreecommitdiff
path: root/man/XGetDeviceMotionEvents.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-05-15 14:16:31 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-05-18 10:53:35 +1000
commit615545f9cba36ab7732d2325970a7c84b2fa6e8c (patch)
tree925b1d6ee89ae892c1f5ccc3d73cd86c39dd64ed /man/XGetDeviceMotionEvents.txt
parent9966ab40b850c780e439f86e165188919f884b64 (diff)
Switch man pages to asciidoc.
The docbook xml is unreadable and unwritable. Switch everything to asciidoc, at least thay we we can write man pages without losing sanity. asciidoc seems to have some issues with __libmansuffix__, so instead we just use libmansuffix (without underscores). The current asciidoc version is buggy for multiple man targets (more than one man page in a single file), so stick a big warning into configure that a patch is required to the the right asciidoc->docbook conversion. Many thanks to Dan Nicholson for the Makefile.am. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'man/XGetDeviceMotionEvents.txt')
-rw-r--r--man/XGetDeviceMotionEvents.txt109
1 files changed, 109 insertions, 0 deletions
diff --git a/man/XGetDeviceMotionEvents.txt b/man/XGetDeviceMotionEvents.txt
new file mode 100644
index 0000000..9dfcfed
--- /dev/null
+++ b/man/XGetDeviceMotionEvents.txt
@@ -0,0 +1,109 @@
+XGETDEVICEMOTIONEVENTS(libmansuffix)
+====================================
+
+NAME
+----
+
+ XGetDeviceMotionEvents, XDeviceTimeCoord - get device motion
+ history
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput.h>
+
+ XDeviceTimeCoord *XGetDeviceMotionEvents( Display *display,
+ XDevice *device,
+ Time start,
+ Time stop,
+ int *nevents_return,
+ int *mode_return,
+ int *axis_count_return);
+
+ display
+ Specifies the connection to the X server.
+
+ device
+ Specifies the device whose motion history is to be
+ queried.
+
+ start, stop
+ Specify the time interval in which the events are
+ returned from the motionhistory buffer.You can pass a
+ timestamp or CurrentTime.
+
+ nevents_return
+ Returns the number of events from the motion history
+ buffer.
+
+ mode_return
+ Returns the mode of the device (Absolute or Relative).
+
+ axis_count_return
+ Returns the count of axes being reported.
+
+DESCRIPTION
+-----------
+
+ The server may retain the recent history of the device motion
+ and do so to a finer granularity than is reported by
+ DeviceMotionNotify events. The XGetDeviceMotionEvents request
+ makes this history available.
+
+ The XGetDeviceMotionEvents request returns all events in the
+ motion history buffer that fall between the specified start and
+ stop times, inclusive. If the start time is later than the stop
+ time or if the start time is in the future, no events are
+ returned. If the stop time is in the future, it is equivalent
+ to specifying CurrentTime.
+
+ The mode indicates whether the device is reporting absolute
+ positional data (mode = Absolute ) or relative motion data
+ (mode = Relative ). Some devices allow their mode to be changed
+ via the XSetDeviceMode request. These constants are defined in
+ the file XI.h. The axis_count returns the number of axes or
+ valuators being reported by the device.
+
+ XGetDeviceMotionEvents can generate a BadDevice, or BadMatch
+ error.
+
+Structures
+
+ The XDeviceTimeCoord structure contains:
+
+ typedef struct {
+ Time time;
+ int *data;
+ } XDeviceTimeCoord;
+
+ The time member is set to the time, in milliseconds. The data
+ member is a pointer to an array of integers. These integers are
+ set to the values of each valuator or axis reported by the
+ device. There is one element in the array per axis of motion
+ reported by the device. The value of the array elements depends
+ on the mode of the device. If the mode is Absolute, the values
+ are the raw values generated by the device. These may be scaled
+ by client programs using the maximum values that the device can
+ generate. The maximum value for each axis of the device is
+ reported in the max_val field of the XAxisInfo returned by the
+ XListInputDevices request. If the mode is Relative, the data
+ values are the relative values generated by the device.
+
+ You should use XFreeDeviceMotionEvents to free the data
+ returned by this request.
+
+ Errors returned by this request: BadDevice, BadMatch.
+
+DIAGNOSTICS
+-----------
+
+ BadDevice
+ An invalid device was specified. The specified device
+ does not exist or has not been opened by this client via
+ XOpenInputDevice. This error may also occur if the
+ specified device is the X keyboard or X pointer device.
+
+ BadMatch
+ This error may occur if an XGetDeviceMotionEvents
+ request is made specifying a device that has no
+ valuators and reports no axes of motion.