summaryrefslogtreecommitdiff
path: root/lightpipe.h
blob: 8ea4095655a26e66596c677859ee713e81092e78 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*
 * $Id$
 *
 * Copyright © 2004 Keith Packard
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of Keith Packard not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission.  Keith Packard makes no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#include <X11/Xlib.h>
#include <X11/Xutil.h>

/*
 * This definition comes from region.h which is not installed by
 * the monolithic Xlib build system
 */
typedef struct {
    short x1, x2, y1, y2;
} Box, BOX, BoxRec, *BoxPtr;

typedef struct _XRegion {
    long size;
    long numRects;
    BOX *rects;
    BOX extents;
} REGION;

typedef struct {
    XRectangle	geometry;	/* in screen space, read-only */
    int		border_width;	/* read-only */
    XRectangle	damage;		/* in window space, client may modify */
    XImage	*image;		/* read-only */
    Region	damage_region;	/* in window space, client may modify */
} XLightPipeWindow;

/*
 * Initialize library. Must be called before first XOpenDisplay call
 */

void
XLightPipeInit (void);

/*
 * Start monitoring window, returns success boolean
 */

Bool
XLightPipeAttendWindow (Display *display, Window window, Bool provide_region);

/*
 * Start monitoring all sub windows; create/destroy handled
 * automagically
 */

Bool
XLightPipeAttendSubwindows (Display *display, Window window, Bool provide_region);

/*
 * Stop monitoring window.  Note that monitoring is automatically
 * disabled if the window is destroyed
 */

void
XLightPipeIgnoreWindow (Display *display, Window window);

/*
 * Returns XLightPipeWindow structure if there is any damage,
 * else 0.  The XLightPipeWindow structure is 'locked' on return
 * and must be 'released' before any other calls to the library
 * including XLightPipeIgnoreWindow.
 */

XLightPipeWindow *
XLightPipeCheckWindow (Display *display, Window window, Bool block);

/*
 * Returns a random window containing damage, 0 if none
 */
XLightPipeWindow *
XLightPipeCheckAny (Display *display, Bool block);

/*
 * Release the XLightPipeWindow structure so that
 * additional damage can be added.
 */

void
XLightPipeRelease (Display *display, XLightPipeWindow *lpw);