XCreatePixmap(3X) XCreatePixmap(3X)NAME XCreatePixmap, XFreePixmap - create and free pixel maps SYNOPSIS Pixmap XCreatePixmap (display, d, width, height, depth) Display *display; Drawable d; unsigned int width, height; unsigned int depth; XFreePixmap (display, pixmap) Display *display; Pixmap pixmap; DESCRIPTION The XCreatePixmap function creates a pixel map of the speci- fied width, height, and depth. It also assigns an ID to the new pixel map. 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 pixel map. The pixel map 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 pixel map are undefined. The XFreePixmap function first deletes the association between the pixel map ID and the pixel map. Then the X server frees the pixel map storage when no other resources reference it. The pixel map should never be referenced again. Arguments These functions accept the following arguments: d Specifies the screen on which the pixel map is created. depth Specifies the depth of the pixel map. display Specifies the connection to the X server. pixmap Specifies the pixel map. width, height Specify the width and height. November, 1990 1
XCreatePixmap(3X) XCreatePixmap(3X)ERRORS BadAlloc The server failed to allocate the requested resource or server memory. BadDrawable A value for a Drawable argument does not name a de- fined window or pixel map. BadPixmap A value for a Pixmap argument does not name a de- fined pixel map. BadValue A numeric value falls outside the range of values accepted by the request. Unless a range is speci- fied 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. XCreatePixmap can generate BadAlloc, BadDrawable, and Bad- Value errors. XFreePixmap can generate a BadPixmap error. SEE ALSO Xlib - C Language Interface 2 November, 1990