summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas E. Dickey <dickey@invisible-island.net>2022-06-10 10:08:10 -0400
committerThomas E. Dickey <dickey@invisible-island.net>2022-06-11 11:10:55 -0400
commitc76339229144ab6342315a27ee67a7ade1f43464 (patch)
treeb792b6720ce40949f9fa29dfa83f2a8e714f16a6
parent58b1fed139c6dfd1a20a8b6090181f43aaffcc59 (diff)
downloadxorg-lib-libXft-c76339229144ab6342315a27ee67a7ade1f43464.tar.gz
reduce clutter for external data-types by documenting them one time
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
-rw-r--r--man/Xft.man113
1 files changed, 53 insertions, 60 deletions
diff --git a/man/Xft.man b/man/Xft.man
index 247690e..b4c1370 100644
--- a/man/Xft.man
+++ b/man/Xft.man
@@ -129,10 +129,23 @@ version constants might be used:
.\" XFT_NMISSING used in xftcore.c, xftextent.c, xftglyphs.c,
.\" xftrender.c
.SH "DATA TYPES"
+Xft datatypes follow a naming convention,
+prefixing all names with \*(``Xft\*(''
.SS From Xlib...
Xlib datatypes do not follow a naming convention.
They are documented in
-.I Xlib \- C Language Interface
+.IR "Xlib \- C Language Interface" .
+.PP
+.B Xft
+uses these names:
+Bool,
+Colormap,
+Display,
+Drawable,
+Pixmap,
+Region,
+Visual, and
+XRectangle.
.TP 5
.B Region
Declared in \fI<X11/Xutil.h>\fP and \fI<X11/Xregion.h>\fP,
@@ -144,19 +157,53 @@ Internally, a
is represented by the union of an arbitrary number of rectangles.
Xlib maintains a rectangle which tells it the extent of this union.
.SS From XRender...
-XRender datatypes are inspired by Xlib,
+The X Render Extension library
+datatypes are inspired by Xlib,
but lack the corresponding documentation.
+Refer to the header file for details:
+.RS
+.PP
+.I <X11/extensions/Xrender.h>
+.RE
+.PP
+.B Xft
+uses these names:
+Picture,
+XGlyphInfo,
+XRenderColor.
.SS From Fontconfig...
Fontconfig datatypes follow a naming convention,
prefixing all names with \*(``Fc\*('' which are documented in
-.I Fontconfig Developers Reference
+.IR "Fontconfig Developers Reference" .
+.PP
+.B Xft
+uses these Fontconfig names:
+FcBool,
+FcChar8,
+FcChar16,
+FcChar32,
+FcCharSet,
+FcEndian,
+FcFontSet,
+FcPattern, and
+FcResult.
.SS From FreeType 2...
FreeType 2 datatypes follow a naming convention,
prefixing all names with \*(``FT_\*('' which are documented in
-.I FreeType API Reference
+.IR "FreeType API Reference" .
+.PP
+.B Xft
+uses these names:
+FT_Face,
+FT_Library, and
+FT_UInt.
+.PP
+FreeType 2 uses
+.B FT_UInt
+(an unsigned integer)
+to represent
+.IR glyphs .
.SS XftFont
-Xft datatypes follow a naming convention,
-prefixing all names with \*(``Xft\*(''
.QS
typedef struct _XftFont {
int ascent;
@@ -174,11 +221,6 @@ is the primary data structure of interest to programmers using
.BR Xft ;
it contains general font metrics and pointers to the Fontconfig
character set and pattern associated with the font.
-The
-.B FcCharSet
-and
-.B FcPattern
-data types are defined by the Fontconfig library.
.PP
.BR XftFont s
are populated with any of
@@ -294,9 +336,6 @@ An
.B XftColor
object permits text and other items to be rendered in a particular
color (or the closest approximation offered by the X visual in use).
-The
-.B XRenderColor
-data type is defined by the X Render Extension library.
.PP
.BR XftColorAllocName ()
and
@@ -409,8 +448,6 @@ typedef struct _XftCharSpec {
.QE
.PP
The
-.B FcChar32
-data type is defined by the Fontconfig library.
.B XftCharSpec
is used by
.BR XftDrawCharSpec (),
@@ -427,9 +464,6 @@ typedef struct _XftCharFontSpec {
} XftCharFontSpec;
.QE
.PP
-The
-.B FcChar32
-data type is defined by the Fontconfig library.
.SS
.B XftGlyphSpec
.QS
@@ -439,10 +473,6 @@ typedef struct _XftGlyphSpec {
short y;
} XftGlyphSpec;
.QE
-.PP
-The
-.B FT_UInt
-data type is defined by the FreeType library.
.SS XftGlyphFontSpec
.QS
typedef struct _XftGlyphFontSpec {
@@ -452,10 +482,6 @@ typedef struct _XftGlyphFontSpec {
short y;
} XftGlyphFontSpec;
.QE
-.PP
-The
-.B FT_UInt
-data type is defined by the FreeType library.
.SH FUNCTIONS
.\" *************************************************************************
.SS "Initialization"
@@ -717,11 +743,6 @@ can also be used directly to determine the Fontconfig font pattern
resulting from an
.B Xft
font open request.
-The
-.B FcPattern
-and
-.B FcResult
-data types are defined by the Fontconfig library.
.PS
\fBFcPattern\fP *\fBXftXlfdParse\fP (
\fB_Xconst char\fP *\fIxlfd_orig\fP,
@@ -815,11 +836,6 @@ consisting of eight-bit characters when drawn with
.IR font ,
storing them in
.IR extents .
-The
-.B FcChar8
-data type is defined by the Fontconfig library, and the
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.PP
.PS
\fBvoid\fP \fBXftTextExtents16\fP (
@@ -840,11 +856,6 @@ consisting of sixteen-bit characters when drawn with
.IR font ,
storing them in
.IR extents .
-The
-.B FcChar16
-data type is defined by the Fontconfig library, and the
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.PP
.PS
\fBvoid\fP \fBXftTextExtents32\fP (
@@ -865,11 +876,6 @@ consisting of thirty-two-bit characters when drawn with
.IR font ,
storing them in
.IR extents .
-The
-.B FcChar32
-data type is defined by the Fontconfig library, and the
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.PP
.PS
\fBvoid\fP \fBXftTextExtentsUtf8\fP (
@@ -890,9 +896,6 @@ when drawn with
.IR font ,
storing them in
.IR extents .
-The
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.PP
.PS
\fBvoid\fR \fBXftTextExtentsUtf16\fP (
@@ -918,11 +921,6 @@ The endianness of
.I string
must be specified in
.IR endian .
-The
-.B FcEndian
-data type is defined by the Fontconfig library, and the
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.PP
.PS
\fBvoid\fP \fBXftGlyphExtents\fP (
@@ -946,11 +944,6 @@ drawn with
.IR font ,
storing them in
.IR extents .
-The
-.B FT_UInt
-data type is defined by the FreeType library, and the
-.B XGlyphInfo
-data type is defined by the X Rendering Extension library.
.IP
If any of the
.I glyphs