Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xcreatepixa(3) [hpux man page]

XCreatePixmap() 														   XCreatePixmap()

Name
  XCreatePixmap - create a pixmap.

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

Arguments
  display   Specifies a connection to an X server; returned from XOpenDisplay().

  drawable  Specifies the drawable.  May be an InputOnly window.

  width     Specify the width and height in pixels of the pixmap.  The values must be non-zero.
  height
  depth     Specifies  the  depth of the pixmap.  The depth must be supported by the screen of the specified drawable.	(Use XListDepths() if
	    in doubt.)

Returns
  The created Pixmap.

Description
  XCreatePixmap() creates a pixmap resource and returns its pixmap ID.	The initial contents of the pixmap are undefined.

  The server uses the drawable argument to determine which screen the pixmap is stored on.  The pixmap can only be used on this screen.   The
  pixmap  can  only  be  drawn drawn into with GCs of the same depth, and can only be copied to drawables of the same depth, except in XCopy-
  Plane().

  A bitmap is a single-plane pixmap.  There is no separate bitmap type in X Version 11.

  Pixmaps should be considered a precious resource, since many servers have limits on the amount of off-screen memory available.

  If you are creating a pixmap for use in XCreatePixmapCursor(), specify depth = 1, fg = 1, and bg = 0.

  For more information, see Volume One, Chapter 6, Drawing Graphics and Text.

Errors
  BadAlloc

  BadDrawable

  BadValue  width or height is 0.
	    depth is not supported on screen.

See Also
  XCreateBitmapFromData(), XCreatePixmapFromBitmapData(), XFreePixmap(), XListDepths(),  XListPixmapFormat,  XQueryBestCursor(),  XQueryBest-
  Size(),  XQueryBestStipple(),  XQueryBestTile(),  XReadBitmapFile(),	XSetTile(),  XSetWindowBackgroundPixmap(),  XSetWindowBorderPixmap(),
  XWriteBitmapFile().

Xlib - Pixmaps and Tiles													   XCreatePixmap()

Check Out this Related Man Page

XCreatePixmap(3X11)						  XLIB FUNCTIONS					       XCreatePixmap(3X11)

NAME
XCreatePixmap, XFreePixmap - create or destroy pixmaps SYNTAX
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; ARGUMENTS
d Specifies which screen the pixmap is created on. depth Specifies the depth of the pixmap. display Specifies the connection to the X server. pixmap Specifies the pixmap. width height Specify the width and height, which define the dimensions 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 unde- fined. XCreatePixmap can generate BadAlloc, BadDrawable, and BadValue errors. The XFreePixmap function first deletes the association between the pixmap ID and the pixmap. Then, the X server frees the pixmap storage when there are no references to it. The pixmap should never be referenced again. XFreePixmap can generate a BadPixmap error. DIAGNOSTICS
BadAlloc The server failed to allocate the requested resource or server memory. BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. BadPixmap A value for a Pixmap argument does not name a defined Pixmap. BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argu- ment, 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(3X11) Xlib - C Language X Interface X Version 11 Release 6.6 XCreatePixmap(3X11)
Man Page