Syntax

XSetWindowBackgroundPixmap(display, w, background_pixmap)
      Display *display;
      Window w;
      Pixmap background_pixmap;

Arguments

display Specifies the connection to the X server.
w Specifies the window.
background_pixmap Specifies the background pixmap, ParentRelative, or None.

Description

The XSetWindowBackgroundPixmap() function sets the background pixmap of the window to the specified pixmap. The background pixmap can immediately be freed if no further explicit references to it are to be made. If ParentRelative is specified, the background pixmap of the window's parent is used, or on the root window, the default background is restored. If you try to change the background of an InputOnly window, a BadMatch error results. If the background is set to None, the window has no defined background.

XSetWindowBackgroundPixmap() can generate BadMatch, BadPixmap, and BadWindow errors.

Note

XSetWindowBackground() and XSetWindowBackgroundPixmap() do not change the current contents of the window.

Diagnostics

BadMatch An InputOnly window is used as a Drawable.
BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
BadPixmap A value for a Pixmap argument does not name a defined Pixmap.
BadWindow A value for a Window argument does not name a defined Window.

See also

XChangeWindowAttributes(), XConfigureWindow(), XCreateWindow(), XDestroyWindow(), XInstallColormap(), XMapWindow(), XRaiseWindow(), XSetWindowBackground(), XSetWindowBorder(), XSetWindowBorderPixmap(), XSetWindowColormap(), XUnmapWindow(), "Changing Window Attributes"
Christophe Tronche, ch@tronche.com