NAME

XmbTextEscapement, XwcTextEscapement, Xutf8TextEscapement - obtain the escapement of text

SYNTAX

int XmbTextEscapement(XFontSet _f_o_n_t___s_e_t, char *_s_t_r_i_n_g, int _n_u_m___b_y_t_e_s); int XwcTextEscapement(XFontSet _f_o_n_t___s_e_t, wchar_t *_s_t_r_i_n_g, int _n_u_m___w_c_h_a_r_s); int Xutf8TextEscapement(XFontSet _f_o_n_t___s_e_t, char *_s_t_r_i_n_g, int _n_u_m___b_y_t_e_s);

ARGUMENTS

_f_o_n_t___s_e_t Specifies the font set.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argument.
_n_u_m___w_c_h_a_r_s Specifies the number of characters in the string argument.
_s_t_r_i_n_g Specifies the character string.

DESCRIPTION

The _X_m_b_T_e_x_t_E_s_c_a_p_e_m_e_n_t, _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t and _X_u_t_f_8_T_e_x_t_E_s_c_a_p_e_m_e_n_t functions return the escapement in pixels of the specified string as a value, using the fonts loaded for the specified font set. The escapement is the distance in pixels in the primary draw direction from the drawing origin to the origin of the next character to be drawn, assuming that the rendering of the next character is not dependent on the supplied string.

Regardless of the character rendering order, the escapement is always positive.

The function _X_u_t_f_8_T_e_x_t_E_s_c_a_p_e_m_e_n_t is an XFree86 extension introduced in XFree86 4.0.2. Its presence is indicated by the macro _X___H_A_V_E___U_T_F_8___S_T_R_I_N_G.

SEE ALSO

XmbTextExtents(3X11), XmbTextPerCharExtents(3X11) _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e