1XClearArea(3X11)                XLIB FUNCTIONS                XClearArea(3X11)
2
3
4

NAME

6       XClearArea, XClearWindow - clear area or window
7

SYNTAX

9       int XClearArea(Display *display, Window w, int x, int y, unsigned
10              width, unsigned height, Bool exposures);
11
12       int XClearWindow(Display *display, Window w);
13

ARGUMENTS

15       display   Specifies the connection to the X server.
16
17       exposures Specifies a Boolean value that indicates if Expose events are
18                 to be generated.
19
20       w         Specifies the window.
21
22       width
23       height    Specify the width and height, which are the dimensions of the
24                 rectangle.
25
26
27       x
28       y         Specify the x and y coordinates, which are relative to the
29                 origin of the window and specify the upper-left corner of the
30                 rectangle.
31

DESCRIPTION

33       The XClearArea function paints a rectangular area in the specified win‐
34       dow according to the specified dimensions with the window's background
35       pixel or pixmap.  The subwindow-mode effectively is ClipByChildren.  If
36       width is zero, it is replaced with the current width of the window
37       minus x.  If height is zero, it is replaced with the current height of
38       the window minus y.  If the window has a defined background tile, the
39       rectangle clipped by any children is filled with this tile.  If the
40       window has background None, the contents of the window are not changed.
41       In either case, if exposures is True, one or more Expose events are
42       generated for regions of the rectangle that are either visible or are
43       being retained in a backing store.  If you specify a window whose class
44       is InputOnly, a BadMatch error results.
45
46       XClearArea can generate BadMatch, BadValue, and BadWindow errors.
47
48       The XClearWindow function clears the entire area in the specified win‐
49       dow and is equivalent to XClearArea (display, w, 0, 0, 0, 0, False).
50       If the window has a defined background tile, the rectangle is tiled
51       with a plane-mask of all ones and GXcopy function.  If the window has
52       background None, the contents of the window are not changed.  If you
53       specify a window whose class is InputOnly, a BadMatch error results.
54
55       XClearWindow can generate BadMatch and BadWindow errors.
56

DIAGNOSTICS

58       BadMatch  An InputOnly window is used as a Drawable.
59
60       BadValue  Some numeric value falls outside the range of values accepted
61                 by the request.  Unless a specific range is specified for an
62                 argument, the full range defined by the argument's type is
63                 accepted.  Any argument defined as a set of alternatives can
64                 generate this error.
65
66       BadWindow A value for a Window argument does not name a defined Window.
67

SEE ALSO

69       XCopyArea(3X11)
70       Xlib - C Language X Interface
71
72
73
74X Version 11                     libX11 1.0.3                 XClearArea(3X11)
Impressum