1XClearArea(3)                   XLIB FUNCTIONS                   XClearArea(3)
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       x
27       y         Specify the x and y coordinates, which are  relative  to  the
28                 origin of the window and specify the upper-left corner of the
29                 rectangle.
30

DESCRIPTION

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

DIAGNOSTICS

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

SEE ALSO

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