NAME

XCreateFontCursor, XCreatePixmapCursor, XCreateGlyphCursor - create cursors

SYNTAX

#include Cursor XCreateFontCursor(Display *_d_i_s_p_l_a_y, unsigned int _s_h_a_p_e); Cursor XCreatePixmapCursor(Display *_d_i_s_p_l_a_y, Pixmap _s_o_u_r_c_e, Pixmap _m_a_s_k, XColor *_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, XColor *_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r, unsigned int _x, unsigned int _y); Cursor XCreateGlyphCursor(Display *_d_i_s_p_l_a_y, Font _s_o_u_r_c_e___f_o_n_t, Font _m_a_s_k___f_o_n_t, unsigned int _s_o_u_r_c_e___c_h_a_r, unsigned int _m_a_s_k___c_h_a_r, XColor *_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, XColor *_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r);

ARGUMENTS

_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r Specifies the RGB values for the background of the source.
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r Specifies the RGB values for the foreground of the source.
_m_a_s_k Specifies the cursor's source bits to be displayed or
_N_o_n_e.
_m_a_s_k___c_h_a_r Specifies the glyph character for the mask.
_m_a_s_k___f_o_n_t Specifies the font for the mask glyph or
_N_o_n_e.
_s_h_a_p_e Specifies the shape of the cursor.
_s_o_u_r_c_e Specifies the shape of the source cursor.
_s_o_u_r_c_e___c_h_a_r Specifies the character glyph for the source.
_s_o_u_r_c_e___f_o_n_t Specifies the font for the source glyph.
_x
_y Specify the x and y coordinates, which indicate the hotspot relative to the source's origin.

DESCRIPTION

X provides a set of standard cursor shapes in a special font named cursor. Applications are encouraged to use this interface for their cursors because the font can be customized for the individual display type. The shape argument specifies which glyph of the standard fonts to use.

The hotspot comes from the information stored in the cursor font. The initial colors of a cursor are a black foreground and a white background (see _X_R_e_c_o_l_o_r_C_u_r_s_o_r).

_X_C_r_e_a_t_e_F_o_n_t_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.

The _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r function creates a cursor and returns the cursor ID associated with it. The foreground and background RGB values must be specified using foreground_color and background_color, even if the X server only has a _S_t_a_t_i_c_G_r_a_y or _G_r_a_y_S_c_a_l_e screen. The foreground color is used for the pixels set to 1 in the source, and the background color is used for the pixels set to 0. Both source and mask, if specified, must have depth one (or a _B_a_d_M_a_t_c_h error results) but can have any root. The mask argument defines the shape of the cursor. The pixels set to 1 in the mask define which source pixels are displayed, and the pixels set to 0 define which pixels are ignored. If no mask is given, all pixels of the source are displayed. The mask, if present, must be the same size as the pixmap defined by the source argument, or a _B_a_d_M_a_t_c_h error results. The hotspot must be a point within the source, or a _B_a_d_M_a_t_c_h error results.

The components of the cursor can be transformed arbitrarily to meet display limitations. The pixmaps can be freed immediately if no further explicit references to them are to be made. Subsequent drawing in the source or mask pixmap has an undefined effect on the cursor. The X server might or might not make a copy of the pixmap.

_X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_P_i_x_m_a_p errors.

The _X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r function is similar to _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r except that the source and mask bitmaps are obtained from the specified font glyphs. The source_char must be a defined glyph in source_font, or a _B_a_d_V_a_l_u_e error results. If mask_font is given, mask_char must be a defined glyph in mask_font, or a _B_a_d_V_a_l_u_e error results. The mask_font and character are optional. The origins of the source_char and mask_char (if defined) glyphs are positioned coincidently and define the hotspot. The source_char and mask_char need not have the same bounding box metrics, and there is no restriction on the placement of the hotspot relative to the bounding boxes. If no mask_char is given, all pixels of the source are displayed. You can free the fonts immediately by calling _X_F_r_e_e_F_o_n_t if no further explicit references to them are to be made.

For 2-byte matrix fonts, the 16-bit value should be formed with the byte1 member in the most significant byte and the byte2 member in the least significant byte.

_X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c, _B_a_d_F_o_n_t, and _B_a_d_V_a_l_u_e errors.

DIAGNOSTICS

_B_a_d_A_l_l_o_c
The server failed to allocate the requested resource or server memory.
_B_a_d_F_o_n_t
A value for a Font or GContext argument does not name a defined Font.
_B_a_d_M_a_t_c_h
Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
_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

XDefineCursor(3X11), XLoadFont(3X11), XRecolorCursor(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e