XCreatePixmap

Syntax

Pixmap XCreatePixmap(display, d, width, height, depth)
      Display *display;
      Drawable d;
      unsigned int width, height;
      unsigned int depth;

Arguments

display Specifies the connection to the X server.
d Specifies which screen the pixmap is created on.
width
height 		Specify the width and height, which define the dimensions of the pixmap.
depth Specifies the depth of the pixmap.

Description

The XCreatePixmap() function creates a pixmap of the width, height, and depth you specified and returns a pixmap ID that identifies it. It is valid to pass an InputOnly window to the drawable argument. The width and height arguments must be nonzero, or a BadValue error results. The depth argument must be one of the depths supported by the screen of the specified drawable, or a BadValue error results.

The server uses the specified drawable to determine on which screen to create the pixmap. The pixmap can be used only on this screen and only with other drawables of the same depth (see XCopyPlane() for an exception to this rule). The initial contents of the pixmap are undefined.

XCreatePixmap() can generate BadAlloc , BadDrawable , and BadValue errors.

Diagnostics

BadAlloc The server failed to allocate the requested source or server memory.
BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap.
BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error.

See also

XCopyArea(), XFreePixmap(), "Creating and Freeing Pixmaps".
Christophe Tronche, ch@tronche.com