From f92faa3b7ef11151fa61bc45749f2bb45fa95a9c Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 22 Apr 2022 21:10:14 +0200 Subject: Housekeeping and documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man3/LIBAXL_REQUEST_GET_POINTER_CONTROL.3 | 62 +++++++++++++++++++++++++++++++ man3/libaxl_parse_display.3 | 3 +- man3/libaxl_receive_handshake.3 | 3 +- man3/libaxl_send_handshake.3 | 3 +- 4 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 man3/LIBAXL_REQUEST_GET_POINTER_CONTROL.3 (limited to 'man3') diff --git a/man3/LIBAXL_REQUEST_GET_POINTER_CONTROL.3 b/man3/LIBAXL_REQUEST_GET_POINTER_CONTROL.3 new file mode 100644 index 0000000..9cc6f37 --- /dev/null +++ b/man3/LIBAXL_REQUEST_GET_POINTER_CONTROL.3 @@ -0,0 +1,62 @@ +.TH LIBAXL_REQUEST_GET_POINTER_CONTROL 3 libaxl +.SH NAME +LIBAXL_REQUEST_GET_POINTER_CONTROL - Get current acceleration and threshold for the pointer +.SH SYNOPSIS +.nf +#include + +#define LIBAXL_REQUEST_GET_POINTER_CONTROL 106 +struct libaxl_request_get_pointer_control { + uint8_t \fIopcode\fP; + uint8_t \fI__pad\fP; + uint16_t \fI_request_length\fP; +}; +.fi +.SH DESCRIPTION +The display server shall return the current +acceleration and threshold for the pointer. +.PP +The value of the +.I opcode +field shall be +.I LIBAXL_REQUEST_GET_POINTER_CONTROL +to signify that the request is of the +request described in this document. +.PP +Other fields are filled in automatically by the +.BR libaxl_send_request (3) +function. +.SH ERRORS +None. +.SH REPLIES +.nf +struct libaxl_reply_get_pointer_control { + uint8_t \fI__one\fP; + uint8_t \fI__pad\fP; + uint16_t \fIsequence_number\fP; + uint32_t \fI_reply_length\fP; + uint16_t \fIacceleration_numerator\fP; + uint16_t \fIacceleration_denominator\fP; + uint16_t \fIthreshold\fP; + uint8_t \fI__unused\fP[18]; +}; +.fi +.PP +.PP +The display server shall, unless it returns an +error, return one +.B "struct libaxl_reply_get_pointer_control" +with the +.I acceleration_numerator +and +.I acceleration_denominator +fields set such that +.I ((double)acceleration_numerator/acceleration_denominator) +is the value of the current acceleration for the pointer, +and the +.I threshold +field set to the current threshold for the pointer. +.SH +.BR libaxl_send_request (3), +.BR libaxl_receive (3), +.BR LIBAXL_REQUEST_CHANGE_POINTER_CONTROL (3) diff --git a/man3/libaxl_parse_display.3 b/man3/libaxl_parse_display.3 index f60a7dc..82f1a67 100644 --- a/man3/libaxl_parse_display.3 +++ b/man3/libaxl_parse_display.3 @@ -104,4 +104,5 @@ are .SH SEE ALSO .BR libaxl_create (3), .BR libaxl_get_tcp_port (3), -.BR libaxl_get_decnet_object (3) +.BR libaxl_get_decnet_object (3), +.BR libaxl_connect_without_handshake (3) diff --git a/man3/libaxl_receive_handshake.3 b/man3/libaxl_receive_handshake.3 index e0e2e0a..855cdb7 100644 --- a/man3/libaxl_receive_handshake.3 +++ b/man3/libaxl_receive_handshake.3 @@ -64,4 +64,5 @@ flag is used. .SH SEE ALSO .BR libaxl_connect (3), .BR libaxl_send_handshake (3), -.BR libaxl_send (3) +.BR libaxl_send (3), +.BR libaxl_connect_without_handshake (3) diff --git a/man3/libaxl_send_handshake.3 b/man3/libaxl_send_handshake.3 index c4b91ab..71f58fd 100644 --- a/man3/libaxl_send_handshake.3 +++ b/man3/libaxl_send_handshake.3 @@ -81,4 +81,5 @@ the core X protocol. .BR libaxl_connect (3), .BR libaxl_create (3), .BR libaxl_parse_display (3), -.BR libaxl_receive_handshake (3) +.BR libaxl_receive_handshake (3), +.BR libaxl_connect_without_handshake (3) -- cgit v1.2.3-70-g09d2