xcbquerytextextents(3) XCB Requests xcbquerytextextents(3)

NAME
       xcbquerytextextents - get text extents

SYNOPSIS
       #include 

   Request function
       xcbquerytextextentscookiet
              xcbquerytextextents(xcbconnectiont *conn,
              xcbfontablet font, uint32t stringlen, const
              xcbchar2bt *string);

   Reply datastructure
       typedef struct xcbquerytextextentsreplyt {
           uint8t  responsetype;
           uint8t  drawdirection;
           uint16t sequence;
           uint32t length;
           int16t  fontascent;
           int16t  fontdescent;
           int16t  overallascent;
           int16t  overalldescent;
           int32t  overallwidth;
           int32t  overallleft;
           int32t  overallright;
       } xcbquerytextextentsreplyt;

   Reply function
       xcbquerytextextentsreplyt
              *xcbquerytextextentsreply(xcbconnectiont *conn,
              xcbquerytextextentscookiet cookie,
              xcbgenericerrort **e);

REQUEST ARGUMENTS
       conn      The XCB connection to X11.

       font      The font to calculate text extents in. You can also pass a
                 graphics context.

       stringlen
                 The number of characters in string.

       string    The text to get text extents for.

REPLY FIELDS
       responsetype
                 The type of this reply, in this case XCBQUERYTEXTEXTENTS.
                 This field is also present in the xcbgenericreplyt and can
                 be used to tell replies apart from each other.

       sequence  The sequence number of the last request processed by the X11
                 server.

       length    The length of the reply, in words (a word is 4 bytes).

       drawdirection
                 One of the following values:

                 XCBFONTDRAWLEFTTORIGHT
                           TODO: NOT YET DOCUMENTED.

                 XCBFONTDRAWRIGHTTOLEFT
                           TODO: NOT YET DOCUMENTED.
                 TODO: NOT YET DOCUMENTED.

       fontascent
                 TODO: NOT YET DOCUMENTED.

       fontdescent
                 TODO: NOT YET DOCUMENTED.

       overallascent
                 TODO: NOT YET DOCUMENTED.

       overalldescent
                 TODO: NOT YET DOCUMENTED.

       overallwidth
                 TODO: NOT YET DOCUMENTED.

       overallleft
                 TODO: NOT YET DOCUMENTED.

       overallright
                 TODO: NOT YET DOCUMENTED.

DESCRIPTION
       Query text extents from the X11 server. This request returns the bound‐
       ing box of the specified 16-bit character string in the specified font
       or the font contained in the specified graphics context.

       fontascent is set to the maximum of the ascent metrics of all charac‐
       ters in the string. fontdescent is set to the maximum of the descent
       metrics.  overallwidth is set to the sum of the character-width met‐
       rics of all characters in the string. For each character in the string,
       let W be the sum of the character-width metrics of all characters pre‐
       ceding it in the string. Let L be the left-side-bearing metric of the
       character plus W. Let R be the right-side-bearing metric of the charac‐
       ter plus W. The lbearing member is set to the minimum L of all charac‐
       ters in the string. The rbearing member is set to the maximum R.

       For fonts defined with linear indexing rather than 2-byte matrix index‐
       ing, each xcbchar2bt structure is interpreted as a 16-bit number with
       byte1 as the most significant byte. If the font has no defined default
       character, undefined characters in the string are taken to have all ze‐
       ro metrics.

       Characters with all zero metrics are ignored. If the font has no de‐
       fined defaultchar, the undefined characters in the string are also ig‐
       nored.

RETURN VALUE
       Returns an xcbquerytextextentscookiet. Errors have to be handled
       when calling the reply function xcbquerytextextentsreply.

       If you want to handle errors in the event loop instead, use
       xcbquerytextextentsunchecked. See xcb-requests(3) for details.

ERRORS
       xcbfonterrort
                 The specified font does not exist.

       xcbgcontexterrort
                 The specified graphics context does not exist.

SEE ALSO
       xcb-requests(3)

AUTHOR
       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
       rections and improvements.



X Version 11                      libxcb 1.13        xcbquerytextextents(3)