1XCreatePixmap(3)                XLIB FUNCTIONS                XCreatePixmap(3)
2
3
4

NAME

6       XCreatePixmap, XFreePixmap - create or destroy pixmaps
7

SYNTAX

9       Pixmap  XCreatePixmap(Display *display, Drawable d, unsigned int width,
10              unsigned int height, unsigned int depth);
11
12       int XFreePixmap(Display *display, Pixmap pixmap);
13

ARGUMENTS

15       d         Specifies which screen the pixmap is created on.
16
17       depth     Specifies the depth of the pixmap.
18
19       display   Specifies the connection to the X server.
20
21       pixmap    Specifies the pixmap.
22
23       width
24       height    Specify the width and height, which define the dimensions  of
25                 the pixmap.
26

DESCRIPTION

28       The  XCreatePixmap  function creates a pixmap of the width, height, and
29       depth you specified and returns a pixmap ID that identifies it.  It  is
30       valid  to pass an InputOnly window to the drawable argument.  The width
31       and height arguments must be nonzero, or a BadValue error results.  The
32       depth argument must be one of the depths supported by the screen of the
33       specified drawable, or a BadValue error results.
34
35       The server uses the specified drawable to determine on which screen  to
36       create the pixmap.  The pixmap can be used only on this screen and only
37       with other drawables of the same depth (see XCopyPlane for an exception
38       to this rule).  The initial contents of the pixmap are undefined.
39
40       XCreatePixmap can generate BadAlloc, BadDrawable, and BadValue errors.
41
42       The  XFreePixmap  function  first  deletes  the association between the
43       pixmap ID and the pixmap.  Then, the X server frees the pixmap  storage
44       when  there are no references to it.  The pixmap should never be refer‐
45       enced again.
46
47       XFreePixmap can generate a BadPixmap error.
48

DIAGNOSTICS

50       BadAlloc  The server failed  to  allocate  the  requested  resource  or
51                 server memory.
52
53       BadDrawable
54                 A  value for a Drawable argument does not name a defined Win‐
55                 dow or Pixmap.
56
57       BadPixmap A value for a Pixmap argument does not name a defined Pixmap.
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

SEE ALSO

66       XCopyArea(3)
67       Xlib - C Language X Interface
68
69
70
71X Version 11                     libX11 1.7.0                 XCreatePixmap(3)
Impressum