xcb_image_text_16_checked(3)

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

NAME

6       xcb_image_text_16 - Draws text
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_void_cookie_t xcb_image_text_16(xcb_connection_t *conn,
13              uint8_t string_len, xcb_drawable_t drawable, xcb_gcontext_t gc,
14              int16_t x, int16_t y, const xcb_char2b_t *string);
15

REQUEST ARGUMENTS

17       conn      The XCB connection to X11.
18
19       string_len
20                 The length of the string in characters. Note that this param‐
21                 eter limited by 255 due to using 8 bits!
22
23       drawable  The drawable (Window or Pixmap) to draw text on.
24
25       gc        The graphics context to use.
26
27                 The following graphics context components are used: plane-
28                 mask, foreground, background, font, subwindow-mode, clip-x-
29                 origin, clip-y-origin, and clip-mask.
30
31       x         The x coordinate of the first character, relative to the ori‐
32                 gin of drawable.
33
34       y         The y coordinate of the first character, relative to the ori‐
35                 gin of drawable.
36
37       string    The string to draw. Only the first 255 characters are rele‐
38                 vant due to the data type of string_len. Every character uses
39                 2 bytes (hence the 16 in this request's name).
40

DESCRIPTION

42       Fills the destination rectangle with the background pixel from gc, then
43       paints the text with the foreground pixel from gc. The upper-left cor‐
44       ner of the filled rectangle is at [x, y - font-ascent]. The width is
45       overall-width, the height is font-ascent + font-descent. The overall-
46       width, font-ascent and font-descent are as returned by
47       xcb_query_text_extents (TODO).
48
49       Note that using X core fonts is deprecated (but still supported) in fa‐
50       vor of client-side rendering using Xft.
51

RETURN VALUE

53       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
54       event loop.
55
56       If you want to handle errors directly with xcb_request_check instead,
57       use xcb_image_text_16_checked. See xcb-requests(3) for details.
58

ERRORS

60       xcb_drawable_error_t
61                 The specified drawable (Window or Pixmap) does not exist.
62
63       xcb_g_context_error_t
64                 The specified graphics context does not exist.
65
66       xcb_match_error_t
67                 TODO: reasons?
68

AUTHOR

73       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
74       rections and improvements.
75
76
77
78X Version 11                      libxcb 1.12             xcb_image_text_16(3)