summaryrefslogtreecommitdiff
path: root/man/XIBarrierReleasePointer.txt
blob: 4fa48fe90b561d2fe2900ab629407f2ab6fca2af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
XIBARRIERRELEASEPOINTER(libmansuffix)
=====================================

NAME
----

   XIBarrierReleasePointer, XIBarrierReleasePointers - allow pointer movement across a pointer barrier

SYNOPSIS
--------

   #include <X11/extensions/XInput2.h>

   int XIBarrierReleasePointer( Display *display,
                                int deviceid,
                                PointerBarrier barrier,
                                BarrierEventID eventid);

   int XIBarrierReleasePointers( Display *display,
                                 XIBarrierReleasePointerInfo *barriers,
                                 int num_barriers);

   display
          Specifies the connection to the X server.

   deviceid
          Specifies the device allowed to move across the barrier.

   barrier
          Specifies the barrier.

   eventid
          Specifies the unique event ID for this barrier event sequence.

   barriers
          List of deviceid, barrier, eventid triplets.

   num_barriers
          Number of elements in barriers.

DESCRIPTION
-----------

   If a pointer is constrained by a pointer barrier, release the pointer
   from the barrier and allow it to cross the barrier with the next motion.
   If the pointer moves away from the barrier, this request does nothing.

   This request only releases the pointer for the given barrier event
   sequence. If the pointer moves away from or through the barrier, a
   XI_BarrierLeave event is generated. Future pointer movement constrained
   by this barrier will assign a new eventid and require a new
   XIBarrierReleasePointer request.

   If the pointer is not currently blocked by the barrier or the barrier
   event sequence has ended, this request does nothing.

   XIBarrierReleasePointer and XIBarrierReleasePointers can generate a
   BadDevice or BadValue error.

DIAGNOSTICS
-----------

   BadDevice
          An invalid device was specified. The device does not
          exist or is not a master pointer device.

   BadValue
          A value for a PointerBarrier argument does not name a defined
          pointer barrier.

See also
--------

   XFixesCreatePointerBarrier(libmansuffix)