xcb_create_glyph_cursor_checked(3)

1xcb_create_glyph_cursor(3)       XCB Requests       xcb_create_glyph_cursor(3)
2
3
4

NAME

6       xcb_create_glyph_cursor - create cursor
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_void_cookie_t xcb_create_glyph_cursor(xcb_connection_t *conn,
13              xcb_cursor_t cid, xcb_font_t source_font, xcb_font_t mask_font,
14              uint16_t source_char, uint16_t mask_char, uint16_t fore_red,
15              uint16_t fore_green, uint16_t fore_blue, uint16_t back_red,
16              uint16_t back_green, uint16_t back_blue);
17

REQUEST ARGUMENTS

19       conn      The XCB connection to X11.
20
21       cid       The ID with which you will refer to the cursor, created by
22                 xcb_generate_id.
23
24       source_font
25                 In which font to look for the cursor glyph.
26
27       mask_font In which font to look for the mask glyph.
28
29       source_char
30                 The glyph of source_font to use.
31
32       mask_char The glyph of mask_font to use as a mask: Pixels which are set
33                 to 1 define which source pixels are displayed. All pixels
34                 which are set to 0 are not displayed.
35
36       fore_red  The red value of the foreground color.
37
38       fore_green
39                 The green value of the foreground color.
40
41       fore_blue The blue value of the foreground color.
42
43       back_red  The red value of the background color.
44
45       back_green
46                 The green value of the background color.
47
48       back_blue The blue value of the background color.
49

DESCRIPTION

51       Creates a cursor from a font glyph. X provides a set of standard cursor
52       shapes in a special font named cursor. Applications are encouraged to
53       use this interface for their cursors because the font can be customized
54       for the individual display type.
55
56       All pixels which are set to 1 in the source will use the foreground
57       color (as specified by fore_red, fore_green and fore_blue). All pixels
58       set to 0 will use the background color (as specified by back_red,
59       back_green and back_blue).
60

RETURN VALUE

62       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
63       event loop.
64
65       If you want to handle errors directly with xcb_request_check instead,
66       use xcb_create_glyph_cursor_checked. See xcb-requests(3) for details.
67

ERRORS

69       xcb_alloc_error_t
70                 The X server could not allocate the requested resources (no
71                 memory?).
72
73       xcb_font_error_t
74                 The specified source_font or mask_font does not exist.
75
76       xcb_value_error_t
77                 Either source_char or mask_char are not defined in
78                 source_font or mask_font, respectively.
79

AUTHOR

84       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
85       rections and improvements.
86
87
88
89X Version 11                      libxcb 1.13       xcb_create_glyph_cursor(3)