XSetDeviceValuators.txt revision 4940c694 
1c27c18e8SmrgXSETDEVICEVALUATORS(libmansuffix)
2c27c18e8Smrg=================================
3c27c18e8Smrg
4c27c18e8SmrgNAME
5c27c18e8Smrg----
6c27c18e8Smrg
7c27c18e8Smrg   XSetDeviceValuators - initialize the valuators on an extension input device
8c27c18e8Smrg
9c27c18e8SmrgSYNOPSIS
10c27c18e8Smrg--------
11c27c18e8Smrg
12c27c18e8Smrg   #include <X11/extensions/XInput.h>
13c27c18e8Smrg
14c27c18e8Smrg   XSetDeviceValuators( Display *display,
15c27c18e8Smrg                        XDevice *device,
16c27c18e8Smrg                        int *valuators,
17c27c18e8Smrg                        int first_valuator,
18c27c18e8Smrg                        int num_valuators);
19c27c18e8Smrg
20c27c18e8Smrg   display
21c27c18e8Smrg          Specifies the connection to the X server.
22c27c18e8Smrg
23c27c18e8Smrg   device
24c27c18e8Smrg          Specifies the device whose valuators are to be
25c27c18e8Smrg          initialized.
26c27c18e8Smrg
27c27c18e8Smrg   valuators
28c27c18e8Smrg          Specifies a pointer to an array of integer values to be
294940c694Smrg          used to initialize the device valuators.
30c27c18e8Smrg
31c27c18e8Smrg   first_valuator
32c27c18e8Smrg          Specifies the first valuator to be set. Valuators are
334940c694Smrg          numbered beginning with zero.
34c27c18e8Smrg
35c27c18e8Smrg   num_valuators
36c27c18e8Smrg          Specifies the number of valuators to be set.
37c27c18e8Smrg
38c27c18e8SmrgDESCRIPTION
39c27c18e8Smrg-----------
40c27c18e8Smrg
41c27c18e8Smrg   The XSetDeviceValuators request sets the current values of the
42c27c18e8Smrg   valuators of an input device. The valuators in the range
43c27c18e8Smrg   first_valuator to (first_valuator + num_valuators) are set to
44c27c18e8Smrg   the specified values. Valuators are numbered beginning with 0.
45c27c18e8Smrg   Not all input devices support initialization of valuator
46c27c18e8Smrg   values. If this request is made to a device that does not
47c27c18e8Smrg   support valuators initialization, a BadMatch error will occur.
48c27c18e8Smrg
49c27c18e8Smrg   If the request succeeds, a status of Success is returned. If
50c27c18e8Smrg   another client has the device grabbed, a status of
51c27c18e8Smrg   AlreadyGrabbed is returned.
52c27c18e8Smrg
53c27c18e8Smrg   XSetDeviceValuators can generate a BadLength, BadDevice,
54c27c18e8Smrg   BadMatch, or BadValue error.
55c27c18e8Smrg
56c27c18e8SmrgDIAGNOSTICS
57c27c18e8Smrg-----------
58c27c18e8Smrg
59c27c18e8Smrg   BadDevice
60c27c18e8Smrg          An invalid device was specified. The specified device
61c27c18e8Smrg          does not exist or has not been opened by this client via
62c27c18e8Smrg          XOpenInputDevice.
63c27c18e8Smrg
64c27c18e8Smrg   BadMatch
65c27c18e8Smrg          This error may occur if an XSetDeviceValuators request
66c27c18e8Smrg          is made specifying a device that has no valuators and
67c27c18e8Smrg          reports no axes of motion, or if such a request is made
68c27c18e8Smrg          specifying a device that does not support valuator
69c27c18e8Smrg          initialization.
70c27c18e8Smrg
71c27c18e8Smrg   BadValue
72c27c18e8Smrg          An invalid first_valuator or num_valuators values was
73c27c18e8Smrg          specified.
74c27c18e8Smrg
75