XIBarrierReleasePointer.txt revision f1ee322d 
1XIBARRIERRELEASEPOINTER(libmansuffix)
2=====================================
3
4NAME
5----
6
7   XIBarrierReleasePointer, XIBarrierReleasePointers - allow pointer movement across a pointer barrier
8
9SYNOPSIS
10--------
11
12   #include <X11/extensions/XInput2.h>
13
14   int XIBarrierReleasePointer( Display *display,
15                                int deviceid,
16                                PointerBarrier barrier,
17                                BarrierEventID eventid);
18
19   int XIBarrierReleasePointers( Display *display,
20                                 XIBarrierReleasePointerInfo *barriers,
21                                 int num_barriers);
22
23   display
24          Specifies the connection to the X server.
25
26   deviceid
27          Specifies the device allowed to move across the barrier.
28
29   barrier
30          Specifies the barrier.
31
32   eventid
33          Specifies the unique event ID for this barrier event sequence.
34
35   barriers
36          List of deviceid, barrier, eventid triplets.
37
38   num_barriers
39          Number of elements in barriers.
40
41DESCRIPTION
42-----------
43
44   If a pointer is constrained by a pointer barrier, release the pointer
45   from the barrier and allow it to cross the barrier with the next motion.
46   If the pointer moves away from the barrier, this request does nothing.
47
48   This request only releases the pointer for the given barrier event
49   sequence. If the pointer moves away from or through the barrier, a
50   XI_BarrierLeave event is generated. Future pointer movement constrained
51   by this barrier will assign a new eventid and require a new
52   XIBarrierReleasePointer request.
53
54   If the pointer is not currently blocked by the barrier or the barrier
55   event sequence has ended, this request does nothing.
56
57   XIBarrierReleasePointer and XIBarrierReleasePointers can generate a
58   BadDevice or BadValue error.
59
60DIAGNOSTICS
61-----------
62
63   BadDevice
64          An invalid device was specified. The device does not
65          exist or is not a master pointer device.
66
67   BadValue
68          A value for a PointerBarrier argument does not name a defined
69          pointer barrier.
70
71See also
72--------
73
74   XFixesCreatePointerBarrier(libmansuffix)
75
76
77