NAME
XCreatePixmap, XFreePixmap - create or destroy pixmaps
SYNTAX
Pixmap XCreatePixmap(Display *_d_i_s_p_l_a_y, Drawable _d,
unsigned int _w_i_d_t_h, unsigned int _h_e_i_g_h_t, unsigned int
_d_e_p_t_h);
int XFreePixmap(Display *_d_i_s_p_l_a_y, Pixmap _p_i_x_m_a_p);
ARGUMENTS
-
_d
Specifies which screen the pixmap is created on.
-
-
_d_e_p_t_h
Specifies the depth of the pixmap.
-
-
_d_i_s_p_l_a_y
Specifies the connection to the X server.
-
-
_p_i_x_m_a_p
Specifies the pixmap.
-
-
_w_i_d_t_h
-
-
_h_e_i_g_h_t
Specify the width and height, which define the dimensions of the pixmap.
-
DESCRIPTION
The
_X_C_r_e_a_t_e_P_i_x_m_a_p
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
_I_n_p_u_t_O_n_l_y
window to the drawable argument.
The width and height arguments must be nonzero,
or a
_B_a_d_V_a_l_u_e
error results.
The depth argument must be one of the depths supported by the screen
of the specified drawable,
or a
_B_a_d_V_a_l_u_e
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
_X_C_o_p_y_P_l_a_n_e
for an exception to this rule).
The initial contents of the pixmap are undefined.
_X_C_r_e_a_t_e_P_i_x_m_a_p
can generate
_B_a_d_A_l_l_o_c,
_B_a_d_D_r_a_w_a_b_l_e,
and
_B_a_d_V_a_l_u_e
errors.
The
_X_F_r_e_e_P_i_x_m_a_p
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.
_X_F_r_e_e_P_i_x_m_a_p
can generate a
_B_a_d_P_i_x_m_a_p
error.
DIAGNOSTICS
-
_B_a_d_A_l_l_o_c
-
The server failed to allocate the requested resource or server memory.
-
_B_a_d_D_r_a_w_a_b_l_e
-
A value for a Drawable argument does not name a defined Window or Pixmap.
-
_B_a_d_P_i_x_m_a_p
-
A value for a Pixmap argument does not name a defined Pixmap.
-
_B_a_d_V_a_l_u_e
-
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(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e