diff options
author | Thomas E. Dickey <dickey@invisible-island.net> | 2022-06-02 18:28:07 -0400 |
---|---|---|
committer | Thomas E. Dickey <dickey@invisible-island.net> | 2022-06-11 11:09:06 -0400 |
commit | 4591cdd1c0f0c8afb8eac9cc908aa7c7d141dc6d (patch) | |
tree | 05c821ab5135b93f5671b7fe6d8bc0c4046ff894 | |
parent | 06a3c0ab6520e368ac936cb1ef172f19957db0fa (diff) | |
download | xorg-lib-libXft-4591cdd1c0f0c8afb8eac9cc908aa7c7d141dc6d.tar.gz |
reuse macros from Xcursor.man to fix ragged layout of typedefs and prototypes
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
-rw-r--r-- | man/Xft.man | 433 |
1 files changed, 240 insertions, 193 deletions
diff --git a/man/Xft.man b/man/Xft.man index 205d2c3..4e4bc82 100644 --- a/man/Xft.man +++ b/man/Xft.man @@ -19,7 +19,55 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.TH Xft __libmansuffix__ __vendorversion__ +.de TA +.ie n .ta 0.8i 1.6i 2.4i 3.2i +.el .ta 0.5i 1.0i 1.5i 2.0i +.. +.de PS +.sp +.ns +.TP \\$1 +.na +.nf +.ie n .ta 0.8i 3.0i +.el .ta 0.5i 2.0i +.. +.de PE +.br +.ad +.fi +.sp +.TA +.. +.de QS +.in +.2i +.nf +.na +.ie n .ta 1.0i 3.0i +.el .ta 0.6i 2.0i +.. +.de QC +.QS +.ie n .ta 2.0i 3.0i +.el .ta 1.6i 2.6i +.ft CR +.. +.de QE +.in -.2i +.ft +.fi +.ad +.TA +.. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.TH Xft __libmansuffix__ __vendorversion__ "X Version 11" .SH NAME Xft \- X FreeType interface library .SH DESCRIPTION @@ -58,7 +106,7 @@ is an alias for The following example illustrates how .BR Xft 's version constants might be used: -.nf +.QS #if (XFT_VERSION >= 20107) (void) puts("Version 2.1.7 or later of the Xft library is in" " use."); @@ -68,7 +116,7 @@ version constants might be used: XFT_MINOR, XFT_REVISION); #endif -.fi +.QE .\" I don't understand what these are for. -- BR, 2005-04-02 .\" XFT_CORE used in xftname.c .\" XFT_RENDER used in xftdpy.c, xftfreetype.c, xftname.c @@ -80,16 +128,17 @@ version constants might be used: .SH "DATA TYPES" .TP .B XftFont -.nf +.QS typedef struct _XftFont { - int ascent; - int descent; - int height; - int max_advance_width; - FcCharSet *charset; - FcPattern *pattern; + int ascent; + int descent; + int height; + int max_advance_width; + FcCharSet *charset; + FcPattern *pattern; } XftFont; -.fi +.QE +.IP An .B XftFont is the primary data structure of interest to programmers using @@ -214,12 +263,13 @@ data with .BR XftFontOpenInfo (). .TP .B XftColor -.nf +.QS typedef struct _XftColor { - unsigned long pixel; - XRenderColor color; + unsigned long pixel; + XRenderColor color; } XftColor; -.fi +.QE +.IP An .B XftColor object permits text and other items to be rendered in a particular @@ -240,7 +290,7 @@ instructs the X server to free the color currently allocated for an .BR XftColor . .TP .B "" -One an +Once an .B XftColor has been initialized, .BR XftDrawSrcPicture (), @@ -317,15 +367,14 @@ is returned by .\" XftDrawSetSubwindowMode .TP .B XftCharSpec -.nf +.QS typedef struct _XftCharSpec { - FcChar32 ucs4; - short x; - short y; + FcChar32 ucs4; + short x; + short y; } XftCharSpec; -.fi -.TP -.B "" +.QE +.IP The .B FcChar32 data type is defined by the Fontconfig library. @@ -333,16 +382,15 @@ data type is defined by the Fontconfig library. .\" XftCharSpecRender .TP .B XftCharFontSpec -.nf +.QS typedef struct _XftCharFontSpec { - XftFont *font; - FcChar32 ucs4; - short x; - short y; + XftFont *font; + FcChar32 ucs4; + short x; + short y; } XftCharFontSpec; -.fi -.TP -.B "" +.QE +.IP The .B FcChar32 data type is defined by the Fontconfig library. @@ -350,15 +398,14 @@ data type is defined by the Fontconfig library. .\" XftCharFontSpecRender .TP .B XftGlyphSpec -.nf +.QS typedef struct _XftGlyphSpec { - FT_UInt glyph; - short x; - short y; + FT_UInt glyph; + short x; + short y; } XftGlyphSpec; -.fi -.TP -.B "" +.QE +.IP The .B FT_UInt data type is defined by the FreeType library. @@ -366,16 +413,15 @@ data type is defined by the FreeType library. .\" XftGlyphSpecRender .TP .B XftGlyphFontSpec -.nf +.QS typedef struct _XftGlyphFontSpec { - XftFont *font; - FT_UInt glyph; - short x; - short y; + XftFont *font; + FT_UInt glyph; + short x; + short y; } XftGlyphFontSpec; -.fi -.TP -.B "" +.QE +.IP The .B FT_UInt data type is defined by the FreeType library. @@ -383,12 +429,12 @@ data type is defined by the FreeType library. .\" XftGlyphFontSpecRender .SH FUNCTIONS .SS "Opening and Matching Fonts" -.nf -\fBXftFont *\fR -\fBXftFontOpen (Display *\fIdpy\fB,\fR -\fB int \fIscreen\fB,\fR -\fB ...);\fR\fR -.fi +.PS +\fBXftFont\fP *\fBXftFontOpen\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBint\fP \fIscreen\fP, + ...); +.PE .B XftFontOpen takes a list of pattern element triples of the form .IR field , " type" , " value" @@ -403,22 +449,23 @@ data type is defined by the X11 library. Returns NULL if no match is found. .PP Example: -.nf +.QS font = XftFontOpen (dpy, screen, XFT_FAMILY, XftTypeString, "charter", XFT_SIZE, XftTypeDouble, 12.0, NULL); -.fi +.QE +.IP This opens the \(lqcharter\(rq font at 12 points. The point size is automatically converted to the correct pixel size based on the resolution of the monitor. .PP -.nf -\fBXftFont *\fR -\fBXftFontOpenName (Display *\fIdpy\fB,\fR -\fB int \fIscreen\fB,\fR -\fB unsigned char *\fIname\fB);\fR -.fi +.PS +\fBXftFont\fP *\fBXftFontOpenName\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBint\fP \fIscreen\fP, + \fBunsigned char\fP *\fIname\fP); +.PE .B XftFontOpenName behaves as .B XftFontOpen @@ -427,25 +474,25 @@ the Fontconfig library's .BR FcNameParse () function). .PP -.nf -\fBXftFont *\fR -\fBXftFontOpenXlfd (Display *\fIdpy\fB,\fR -\fB int \fIscreen\fB,\fR -\fB unsigned char *\fIxlfd\fB)\fR -.fi +.PS +\fBXftFont\fP *\fBXftFontOpenXlfd\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBint\fP \fIscreen\fP, + \fBunsigned char\fP *\fIxlfd\fP) +.PE .B XftFontOpenXlfd behaves as .B XftFontOpen does, except that it takes a string containing an X Logical Font Description (XLFD). .PP -.nf -\fBFcPattern *\fR -\fBXftFontMatch (Display *\fIdpy\fB,\fR -\fB int \fIscreen\fB,\fR -\fB FcPattern *\fIpattern\fB,\fR -\fB FcResult *\fIresult\fB);\fR -.fi +.PS +\fBFcPattern\fP *\fBXftFontMatch\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBint\fP \fIscreen\fP, + \fBFcPattern\fP *\fIpattern\fP, + \fBFcResult\fP *\fIresult\fP); +.PE Also used internally by the .BR XftFontOpen * functions, @@ -458,14 +505,14 @@ and .B FcResult data types are defined by the Fontconfig library. .SS "Determining the Pixel Extents of a Text String" -.nf -\fBvoid\fR -\fBXftTextExtents8 (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FcChar8 *\fIstring\fB,\fR -\fB int \fIlen\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftTextExtents8\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFcChar8\fP *\fIstring\fP, + \fBint\fP \fIlen\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE .B XftTextExtents8 computes the pixel extents on display .I dpy @@ -483,14 +530,14 @@ data type is defined by the Fontconfig library, and the .B XGlyphInfo data type is defined by the X Rendering Extension library. .PP -.nf -\fBvoid\fR -\fBXftTextExtents16 (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FcChar16 *\fIstring\fB,\fR -\fB int \fIlen\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftTextExtents16\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFcChar16\fP *\fIstring\fP, + \fBint\fP \fIlen\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE .B XftTextExtents16 computes the pixel extents on display .I dpy @@ -508,14 +555,14 @@ data type is defined by the Fontconfig library, and the .B XGlyphInfo data type is defined by the X Rendering Extension library. .PP -.nf -\fBvoid\fR -\fBXftTextExtents32 (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FcChar32 *\fIstring\fB,\fR -\fB int \fIlen\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftTextExtents32\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFcChar32\fP *\fIstring\fP, + \fBint\fP \fIlen\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE .B XftTextExtents32 computes the pixel extents on display .I dpy @@ -533,14 +580,14 @@ data type is defined by the Fontconfig library, and the .B XGlyphInfo data type is defined by the X Rendering Extension library. .PP -.nf -\fBvoid\fR -\fBXftTextExtentsUtf8 (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FcChar8 *\fIstring\fB,\fR -\fB int \fIlen\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftTextExtentsUtf8\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFcChar8\fP *\fIstring\fP, + \fBint\fP \fIlen\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE .B XftTextExtentsUtf8 computes the pixel extents on display .I dpy @@ -556,15 +603,15 @@ The .B XGlyphInfo data type is defined by the X Rendering Extension library. .PP -.nf -\fBvoid\fR -\fBXftTextExtentsUtf16 (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FcChar8 *\fIstring\fB,\fR -\fB FcEndian \fIendian\fB,\fR -\fB int \fIlen\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fR \fBXftTextExtentsUtf16\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFcChar8\fP *\fIstring\fP, + \fBFcEndian\fP \fIendian\fP, + \fBint\fP \fIlen\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE .B XftTextExtentsUtf16 computes the pixel extents on display .I dpy @@ -586,14 +633,14 @@ data type is defined by the Fontconfig library, and the .B XGlyphInfo data type is defined by the X Rendering Extension library. .PP -.nf -\fBvoid\fR -\fBXftGlyphExtents (Display *\fIdpy\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB FT_UInt *\fIglyphs\fB,\fR -\fB int \fInglyphs\fB,\fR -\fB XGlyphInfo *\fIextents\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftGlyphExtents\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBXftFont\fP *\fIfont\fP, + \fBFT_UInt\fP *\fIglyphs\fP, + \fBint\fP \fInglyphs\fP, + \fBXGlyphInfo\fP *\fIextents\fP); +.PE Also used internally by the .BR XftTextExtents * functions, @@ -614,13 +661,13 @@ data type is defined by the FreeType library, and the .B XGlyphInfo data type is defined by the X Rendering Extension library. .SS "Drawing Strings (and Other Things)" -.nf -\fBXftDraw *\fR -\fBXftDrawCreate (Display *\fIdpy\fB,\fR -\fB Drawable \fIdrawable\fB,\fR -\fB Visual *\fIvisual\fB,\fR -\fB Colormap \fIcolormap\fB);\fR -.fi +.PS +\fBXftDrawfP *\fBXftDrawCreate\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBDrawable\fP \fIdrawable\fP, + \fBVisual\fP *\fIvisual\fP, + \fBColormap\fP \fIcolormap\fP); +.PE .B XftDrawCreate creates a structure that can be used to render text and rectangles using the specified @@ -637,11 +684,11 @@ and .B Colormap data types are defined by the X11 library. .PP -.nf -\fBXftDraw *\fR -\fBXftDrawCreateBitmap (Display *\fIdpy\fB,\fR -\fB Pixmap \fIbitmap\fB);\fR -.fi +.PS +\fBXftDraw\fP *\fBXftDrawCreateBitmap\fP ( + \fBDisplay\fP *\fIdpy\fB,\fR + \fBPixmap\fP \fIbitmap\fB);\fR +.PE .B XftDrawCreateBitmap behaves as .BR XftDrawCreate , @@ -650,12 +697,12 @@ The .B Pixmap data type is defined by the X11 library. .PP -.nf -\fBXftDraw *\fR -\fBXftDrawCreateAlpha (Display *\fIdpy\fB,\fR -\fB Pixmap \fIpixmap\fB,\fR -\fB int \fIdepth\fB);\fR -.fi +.PS +\fBXftDraw *\fP \fBXftDrawCreateAlpha\fP ( + \fBDisplay\fP *\fIdpy\fP, + \fBPixmap\fP \fIpixmap\fP, + \fBint\fP \fIdepth\fP); +.PE .B XftDrawCreateAlpha behaves as .BR XftDrawCreate , @@ -666,64 +713,64 @@ The .B Pixmap data type is defined by the X11 library. .PP -.nf -\fBvoid\fR -\fBXftDrawChange (XftDraw *\fIdraw\fB,\fR -\fB Drawable \fIdrawable\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftDrawChange\fP ( + \fBXftDraw\fP *\fIdraw\fP, + \fBDrawable\fP \fIdrawable\fP); +.PE .B XftDrawChange changes the X drawable association of the existing Xft draw object .I draw from its current value to .IR drawable . .PP -.nf -\fBDisplay *\fR -\fBXftDrawDisplay (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBDisplay\fP *\fBXftDrawDisplay\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawDisplay returns a pointer to the display associated with the Xft draw object .IR draw . .PP -.nf -\fBDrawable\fR -\fBXftDrawDrawable (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBDrawable\fP \fBXftDrawDrawable\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawDrawable returns the X drawable associated with the Xft draw object .IR draw . .PP -.nf -\fBColormap\fR -\fBXftDrawColormap (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBColormap\fP \fBXftDrawColormap\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawColormap returns the colormap associated with the Xft draw object .IR draw . .PP -.nf -\fBVisual *\fR -\fBXftDrawVisual (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBVisual\fR *\fBXftDrawVisual\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawVisual returns a pointer to the visual associated with the Xft draw object .IR draw . .PP -.nf -\fBPicture\fR -\fBXftDrawPicture (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBPicture\fP \fBXftDrawPicture\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawPicture returns the picture associated with the Xft draw object .IR draw . If the the X server does not support the X Rendering Extension, 0 is returned. .PP -.nf -\fBPicture\fR -\fBXftDrawSrcPicture (XftDraw *\fIdraw\fB,\fR -\fB XftColor *\fIcolor\fB);\fR -.fi +.PS +\fBPicture\fP \fBXftDrawSrcPicture\fP ( + \fBXftDraw\fP *\fIdraw\fP, + \fBXftColor\fP *\fIcolor\fP); +.PE .\" Unfortunately, I'm not quite sure what this does. I think it is the gizmo .\" that is used to create an Xrender Picture object so that glyphs can be .\" drawn in the XftDraw object @@ -736,10 +783,10 @@ Rendering Extension; instead, .B XftGlyphCore is used. .PP -.nf -\fBvoid\fR -\fBXftDrawDestroy (XftDraw *\fIdraw\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftDrawDestroy\fP ( + \fBXftDraw\fP *\fIdraw\fP); +.PE .B XftDrawDestroy destroys .I draw @@ -747,16 +794,16 @@ destroys .B XftCreate functions) and frees the memory that was allocated for it. .PP -.nf -\fBvoid\fR -\fBXftDrawString8 (XftDraw *\fId\fB,\fR -\fB XftColor *\fIcolor\fB,\fR -\fB XftFont *\fIfont\fB,\fR -\fB int \fIx\fB,\fR -\fB int \fIy\fB,\fR -\fB unsigned char *\fIstring\fB,\fR -\fB int \fIlen\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftDrawString8\fP ( + \fBXftDraw\fP *\fId\fP, + \fBXftColor\fP *\fIcolor\fP, + \fBXftFont\fP *\fIfont\fP, + \fBint\fP \fIx\fP, + \fBint\fP \fIy\fP, + \fBunsigned char\fP *\fIstring\fP, + \fBint\fP \fIlen\fP); +.PE .B XftDrawString8 draws no more than .I len @@ -771,15 +818,15 @@ in at position .IR x , " y" . .PP -.nf -\fBvoid\fR -\fBXftDrawRect (XftDraw *\fId\fB,\fR -\fB XftColor *\fIcolor\fB,\fR -\fB int \fIx\fB,\fR -\fB int \fIy\fB,\fR -\fB unsigned int \fIwidth\fB,\fR -\fB unsigned int \fIheight\fB);\fR -.fi +.PS +\fBvoid\fP \fBXftDrawRect\fP ( + \fBXftDraw\fP *\fId\fP, + \fBXftColor\fP *\fIcolor\fP, + \fBint\fP \fIx\fP, + \fBint\fP \fIy\fP, + \fBunsigned int\fP \fIwidth\fP, + \fBunsigned int\fP \fIheight\fP); +.PE .B XftDrawRect draws a solid rectangle of the specified .IR color , |