| 4349 |
Serge |
1 |
|
|
|
2 |
"http://www.w3.org/TR/html4/loose.dtd"> |
|
|
3 |
|
|
|
4 |
|
|
|
5 |
|
|
|
6 |
FreeType-2.5.0 API Reference |
|
|
7 |
|
|
|
32 |
|
|
|
33 |
|
|
|
34 |
|
|
|
35 |
|
|
|
38 |
FreeType-2.5.0 API Reference
|
|
|
39 |
|
|
|
40 |
|
|
|
41 |
TrueType Tables |
|
|
42 |
|
|
|
43 |
Synopsis
|
|
|
44 |
|
|
|
56 |
|
|
|
57 |
|
|
|
58 |
This section contains the definition of TrueType-specific tables as well as some routines used to access and process them.
|
|
|
59 |
|
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
|
|
|
63 |
Defined in FT_TRUETYPE_IDS_H (freetype/ttnameid.h). |
|
|
64 |
|
|
|
|
65 |
|
|
|
75 |
|
|
|
78 |
| values | |
|
|
79 |
|
|
|
80 |
|
|
81 |
| TT_PLATFORM_APPLE_UNICODE |
|
|
|
82 |
| |
|
|
83 |
Used by Apple to indicate a Unicode character map and/or name entry. See TT_APPLE_ID_XXX for corresponding ‘encoding_id’ values. Note that name entries in this format are coded as big-endian UCS-2 character codes only.
|
|
|
84 |
|
|
|
|
85 |
| TT_PLATFORM_MACINTOSH | |
|
|
86 |
Used by Apple to indicate a MacOS-specific charmap and/or name entry. See TT_MAC_ID_XXX for corresponding ‘encoding_id’ values. Note that most TrueType fonts contain an Apple roman charmap to be usable on MacOS systems (even if they contain a Microsoft charmap as well).
|
|
|
87 |
|
|
|
|
88 |
| TT_PLATFORM_ISO | |
|
|
89 |
This value was used to specify ISO/IEC 10646 charmaps. It is however now deprecated. See TT_ISO_ID_XXX for a list of corresponding ‘encoding_id’ values.
|
|
|
90 |
|
|
|
|
91 |
| TT_PLATFORM_MICROSOFT | |
|
|
92 |
Used by Microsoft to indicate Windows-specific charmaps. See TT_MS_ID_XXX for a list of corresponding ‘encoding_id’ values. Note that most fonts contain a Unicode charmap using (TT_PLATFORM_MICROSOFT, TT_MS_ID_UNICODE_CS).
|
|
|
93 |
|
|
|
|
94 |
| TT_PLATFORM_CUSTOM | |
|
|
95 |
Used to indicate application-specific charmaps.
|
|
|
96 |
|
|
|
|
97 |
| TT_PLATFORM_ADOBE | |
|
|
98 |
This value isn't part of any font format specification, but is used by FreeType to report Adobe-specific charmaps in an FT_CharMapRec structure. See TT_ADOBE_ID_XXX.
|
|
|
99 |
|
|
|
|
100 |
| |
|
|
101 |
|
|
|
|
102 |
|
|
|
|
103 |
|
|
|
104 |
|
|
|
107 |
|
|
|
108 |
|
|
|
109 |
|
|
|
110 |
|
|
|
111 |
Defined in FT_TRUETYPE_IDS_H (freetype/ttnameid.h). |
|
|
112 |
|
|
|
|
113 |
|
|
|
123 |
|
|
|
126 |
| values | |
|
|
127 |
|
|
|
128 |
|
|
129 |
| TT_APPLE_ID_DEFAULT | |
|
|
130 |
Unicode version 1.0.
|
|
|
131 |
|
|
|
|
132 |
| TT_APPLE_ID_UNICODE_1_1 |
|
|
|
133 |
| |
|
|
134 |
Unicode 1.1; specifies Hangul characters starting at U+34xx.
|
|
|
135 |
|
|
|
|
136 |
| TT_APPLE_ID_ISO_10646 | |
|
|
137 |
Deprecated (identical to preceding).
|
|
|
138 |
|
|
|
|
139 |
| TT_APPLE_ID_UNICODE_2_0 |
|
|
|
140 |
| |
|
|
141 |
Unicode 2.0 and beyond (UTF-16 BMP only).
|
|
|
142 |
|
|
|
|
143 |
| TT_APPLE_ID_UNICODE_32 | |
|
|
144 |
Unicode 3.1 and beyond, using UTF-32.
|
|
|
145 |
|
|
|
|
146 |
| TT_APPLE_ID_VARIANT_SELECTOR |
|
|
|
147 |
| |
|
|
148 |
From Adobe, not Apple. Not a normal cmap. Specifies variations on a real cmap.
|
|
|
149 |
|
|
|
|
150 |
| |
|
|
151 |
|
|
|
|
152 |
|
|
|
|
153 |
|
|
|
154 |
|
|
|
157 |
|
|
|
158 |
|
|
|
314 |
|
|
|
315 |
|
|
|
318 |
|
|
|
319 |
|
|
|
350 |
|
|
|
351 |
|
|
|
354 |
|
|
|
355 |
|
|
|
405 |
|
|
|
406 |
|
|
|
409 |
|
|
|
410 |
|
|
|
444 |
|
|
|
445 |
|
|
|
448 |
|
|
|
449 |
|
|
|
450 |
|
|
|
451 |
|
|
|
452 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
453 |
|
|
|
|
454 |
|
|
|
485 |
|
|
|
486 |
A structure used to model a TrueType font header table. All fields follow the TrueType specification.
|
|
|
487 |
|
|
|
|
488 |
|
|
|
|
489 |
|
|
|
490 |
|
|
|
493 |
|
|
|
494 |
|
|
|
495 |
|
|
|
496 |
|
|
|
497 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
498 |
|
|
|
|
499 |
|
|
|
532 |
|
|
|
533 |
A structure used to model a TrueType horizontal header, the ‘hhea’ table, as well as the corresponding horizontal metrics table, i.e., the ‘hmtx’ table.
|
|
|
534 |
|
|
|
|
535 |
| fields | |
|
|
536 |
|
|
|
537 |
|
|
538 |
| Version | |
|
|
539 |
The table version.
|
|
|
540 |
|
|
|
|
541 |
| Ascender | |
|
|
542 |
The font's ascender, i.e., the distance from the baseline to the top-most of all glyph points found in the font.
|
|
|
543 |
This value is invalid in many fonts, as it is usually set by the font designer, and often reflects only a portion of the glyphs found in the font (maybe ASCII).
|
|
|
544 |
You should use the ‘sTypoAscender’ field of the OS/2 table instead if you want the correct one.
|
|
|
545 |
|
|
|
|
546 |
| Descender | |
|
|
547 |
The font's descender, i.e., the distance from the baseline to the bottom-most of all glyph points found in the font. It is negative.
|
|
|
548 |
This value is invalid in many fonts, as it is usually set by the font designer, and often reflects only a portion of the glyphs found in the font (maybe ASCII).
|
|
|
549 |
You should use the ‘sTypoDescender’ field of the OS/2 table instead if you want the correct one.
|
|
|
550 |
|
|
|
|
551 |
| Line_Gap | |
|
|
552 |
The font's line gap, i.e., the distance to add to the ascender and descender to get the BTB, i.e., the baseline-to-baseline distance for the font.
|
|
|
553 |
|
|
|
|
554 |
| advance_Width_Max | |
|
|
555 |
This field is the maximum of all advance widths found in the font. It can be used to compute the maximum width of an arbitrary string of text.
|
|
|
556 |
|
|
|
|
557 |
| min_Left_Side_Bearing | |
|
|
558 |
The minimum left side bearing of all glyphs within the font.
|
|
|
559 |
|
|
|
|
560 |
| min_Right_Side_Bearing | |
|
|
561 |
The minimum right side bearing of all glyphs within the font.
|
|
|
562 |
|
|
|
|
563 |
| xMax_Extent | |
|
|
564 |
The maximum horizontal extent (i.e., the ‘width’ of a glyph's bounding box) for all glyphs in the font.
|
|
|
565 |
|
|
|
|
566 |
| caret_Slope_Rise | |
|
|
567 |
The rise coefficient of the cursor's slope of the cursor (slope=rise/run).
|
|
|
568 |
|
|
|
|
569 |
| caret_Slope_Run | |
|
|
570 |
The run coefficient of the cursor's slope.
|
|
|
571 |
|
|
|
|
572 |
| Reserved | |
|
|
573 |
8 reserved bytes.
|
|
|
574 |
|
|
|
|
575 |
| metric_Data_Format | |
|
|
576 |
Always 0.
|
|
|
577 |
|
|
|
|
578 |
| number_Of_HMetrics | |
|
|
579 |
Number of HMetrics entries in the ‘hmtx’ table -- this value can be smaller than the total number of glyphs in the font.
|
|
|
580 |
|
|
|
|
581 |
| long_metrics | |
|
|
582 |
A pointer into the ‘hmtx’ table.
|
|
|
583 |
|
|
|
|
584 |
| short_metrics | |
|
|
585 |
A pointer into the ‘hmtx’ table.
|
|
|
586 |
|
|
|
|
587 |
| |
|
|
588 |
|
|
|
|
589 |
| note | |
|
|
590 |
IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should be identical except for the names of their fields which are different.
|
|
|
591 |
This ensures that a single function in the ‘ttload’ module is able to read both the horizontal and vertical headers.
|
|
|
592 |
|
|
|
|
593 |
|
|
|
|
594 |
|
|
|
595 |
|
|
|
598 |
|
|
|
599 |
|
|
|
600 |
|
|
|
601 |
|
|
|
602 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
603 |
|
|
|
|
604 |
|
|
|
637 |
|
|
|
638 |
A structure used to model a TrueType vertical header, the ‘vhea’ table, as well as the corresponding vertical metrics table, i.e., the ‘vmtx’ table.
|
|
|
639 |
|
|
|
|
640 |
| fields | |
|
|
641 |
|
|
|
642 |
|
|
643 |
| Version | |
|
|
644 |
The table version.
|
|
|
645 |
|
|
|
|
646 |
| Ascender | |
|
|
647 |
The font's ascender, i.e., the distance from the baseline to the top-most of all glyph points found in the font.
|
|
|
648 |
This value is invalid in many fonts, as it is usually set by the font designer, and often reflects only a portion of the glyphs found in the font (maybe ASCII).
|
|
|
649 |
You should use the ‘sTypoAscender’ field of the OS/2 table instead if you want the correct one.
|
|
|
650 |
|
|
|
|
651 |
| Descender | |
|
|
652 |
The font's descender, i.e., the distance from the baseline to the bottom-most of all glyph points found in the font. It is negative.
|
|
|
653 |
This value is invalid in many fonts, as it is usually set by the font designer, and often reflects only a portion of the glyphs found in the font (maybe ASCII).
|
|
|
654 |
You should use the ‘sTypoDescender’ field of the OS/2 table instead if you want the correct one.
|
|
|
655 |
|
|
|
|
656 |
| Line_Gap | |
|
|
657 |
The font's line gap, i.e., the distance to add to the ascender and descender to get the BTB, i.e., the baseline-to-baseline distance for the font.
|
|
|
658 |
|
|
|
|
659 |
| advance_Height_Max | |
|
|
660 |
This field is the maximum of all advance heights found in the font. It can be used to compute the maximum height of an arbitrary string of text.
|
|
|
661 |
|
|
|
|
662 |
| min_Top_Side_Bearing | |
|
|
663 |
The minimum top side bearing of all glyphs within the font.
|
|
|
664 |
|
|
|
|
665 |
| min_Bottom_Side_Bearing |
|
|
|
666 |
| |
|
|
667 |
The minimum bottom side bearing of all glyphs within the font.
|
|
|
668 |
|
|
|
|
669 |
| yMax_Extent | |
|
|
670 |
The maximum vertical extent (i.e., the ‘height’ of a glyph's bounding box) for all glyphs in the font.
|
|
|
671 |
|
|
|
|
672 |
| caret_Slope_Rise | |
|
|
673 |
The rise coefficient of the cursor's slope of the cursor (slope=rise/run).
|
|
|
674 |
|
|
|
|
675 |
| caret_Slope_Run | |
|
|
676 |
The run coefficient of the cursor's slope.
|
|
|
677 |
|
|
|
|
678 |
| caret_Offset | |
|
|
679 |
The cursor's offset for slanted fonts. This value is ‘reserved’ in vmtx version 1.0.
|
|
|
680 |
|
|
|
|
681 |
| Reserved | |
|
|
682 |
8 reserved bytes.
|
|
|
683 |
|
|
|
|
684 |
| metric_Data_Format | |
|
|
685 |
Always 0.
|
|
|
686 |
|
|
|
|
687 |
| number_Of_HMetrics | |
|
|
688 |
Number of VMetrics entries in the ‘vmtx’ table -- this value can be smaller than the total number of glyphs in the font.
|
|
|
689 |
|
|
|
|
690 |
| long_metrics | |
|
|
691 |
A pointer into the ‘vmtx’ table.
|
|
|
692 |
|
|
|
|
693 |
| short_metrics | |
|
|
694 |
A pointer into the ‘vmtx’ table.
|
|
|
695 |
|
|
|
|
696 |
| |
|
|
697 |
|
|
|
|
698 |
| note | |
|
|
699 |
IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should be identical except for the names of their fields which are different.
|
|
|
700 |
This ensures that a single function in the ‘ttload’ module is able to read both the horizontal and vertical headers.
|
|
|
701 |
|
|
|
|
702 |
|
|
|
|
703 |
|
|
|
704 |
|
|
|
707 |
|
|
|
708 |
|
|
|
709 |
|
|
|
710 |
|
|
|
711 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
712 |
|
|
|
|
713 |
|
|
|
768 |
|
|
|
769 |
A structure used to model a TrueType OS/2 table. This is the long table version. All fields comply to the TrueType specification.
|
|
|
770 |
Note that we now support old Mac fonts which do not include an OS/2 table. In this case, the ‘version’ field is always set to 0xFFFF.
|
|
|
771 |
|
|
|
|
772 |
|
|
|
|
773 |
|
|
|
774 |
|
|
|
777 |
|
|
|
778 |
|
|
|
779 |
|
|
|
780 |
|
|
|
781 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
782 |
|
|
|
|
783 |
|
|
|
803 |
|
|
|
804 |
A structure used to model a TrueType PostScript table. All fields comply to the TrueType specification. This structure does not reference the PostScript glyph names, which can be nevertheless accessed with the ‘ttpost’ module.
|
|
|
805 |
|
|
|
|
806 |
|
|
|
|
807 |
|
|
|
808 |
|
|
|
811 |
|
|
|
812 |
|
|
|
813 |
|
|
|
814 |
|
|
|
815 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
816 |
|
|
|
|
817 |
|
|
|
840 |
|
|
|
841 |
A structure used to model a TrueType PCLT table. All fields comply to the TrueType specification.
|
|
|
842 |
|
|
|
|
843 |
|
|
|
|
844 |
|
|
|
845 |
|
|
|
848 |
|
|
|
849 |
|
|
|
850 |
|
|
|
851 |
|
|
|
852 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
853 |
|
|
|
|
854 |
|
|
|
877 |
|
|
|
878 |
The maximum profile is a table containing many max values which can be used to pre-allocate arrays. This ensures that no memory allocation occurs during a glyph load.
|
|
|
879 |
|
|
|
|
880 |
| fields | |
|
|
881 |
|
|
|
882 |
|
|
883 |
| version | |
|
|
884 |
The version number.
|
|
|
885 |
|
|
|
|
886 |
| numGlyphs | |
|
|
887 |
The number of glyphs in this TrueType font.
|
|
|
888 |
|
|
|
|
889 |
| maxPoints | |
|
|
890 |
The maximum number of points in a non-composite TrueType glyph. See also the structure element ‘maxCompositePoints’.
|
|
|
891 |
|
|
|
|
892 |
| maxContours | |
|
|
893 |
The maximum number of contours in a non-composite TrueType glyph. See also the structure element ‘maxCompositeContours’.
|
|
|
894 |
|
|
|
|
895 |
| maxCompositePoints | |
|
|
896 |
The maximum number of points in a composite TrueType glyph. See also the structure element ‘maxPoints’.
|
|
|
897 |
|
|
|
|
898 |
| maxCompositeContours | |
|
|
899 |
The maximum number of contours in a composite TrueType glyph. See also the structure element ‘maxContours’.
|
|
|
900 |
|
|
|
|
901 |
| maxZones | |
|
|
902 |
The maximum number of zones used for glyph hinting.
|
|
|
903 |
|
|
|
|
904 |
| maxTwilightPoints | |
|
|
905 |
The maximum number of points in the twilight zone used for glyph hinting.
|
|
|
906 |
|
|
|
|
907 |
| maxStorage | |
|
|
908 |
The maximum number of elements in the storage area used for glyph hinting.
|
|
|
909 |
|
|
|
|
910 |
| maxFunctionDefs | |
|
|
911 |
The maximum number of function definitions in the TrueType bytecode for this font.
|
|
|
912 |
|
|
|
|
913 |
| maxInstructionDefs | |
|
|
914 |
The maximum number of instruction definitions in the TrueType bytecode for this font.
|
|
|
915 |
|
|
|
|
916 |
| maxStackElements | |
|
|
917 |
The maximum number of stack elements used during bytecode interpretation.
|
|
|
918 |
|
|
|
|
919 |
| maxSizeOfInstructions | |
|
|
920 |
The maximum number of TrueType opcodes used for glyph hinting.
|
|
|
921 |
|
|
|
|
922 |
| maxComponentElements | |
|
|
923 |
The maximum number of simple (i.e., non- composite) glyphs in a composite glyph.
|
|
|
924 |
|
|
|
|
925 |
| maxComponentDepth | |
|
|
926 |
The maximum nesting depth of composite glyphs.
|
|
|
927 |
|
|
|
|
928 |
| |
|
|
929 |
|
|
|
|
930 |
| note | |
|
|
931 |
This structure is only used during font loading.
|
|
|
932 |
|
|
|
|
933 |
|
|
|
|
934 |
|
|
|
935 |
|
|
|
938 |
|
|
|
939 |
|
|
|
965 |
|
|
|
966 |
|
|
|
969 |
|
|
|
970 |
|
|
|
971 |
|
|
|
972 |
|
|
|
973 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
974 |
|
|
|
|
975 |
|
|
|
982 |
|
|
|
983 |
Return a pointer to a given SFNT table within a face.
|
|
|
984 |
|
|
|
|
985 |
|
|
|
996 |
| return | |
|
|
997 |
A type-less pointer to the table. This will be 0 in case of error, or if the corresponding table was not found OR loaded from the file.
|
|
|
998 |
Use a typecast according to ‘tag’ to access the structure elements.
|
|
|
999 |
|
|
|
|
1000 |
| note | |
|
|
1001 |
The table is owned by the face object and disappears with it.
|
|
|
1002 |
This function is only useful to access SFNT tables that are loaded by the sfnt, truetype, and opentype drivers. See FT_Sfnt_Tag for a list.
|
|
|
1003 |
Here an example how to access the ‘vhea’ table:
|
|
|
1004 |
|
|
|
1005 |
TT_VertHeader* vert_header; |
|
|
1006 |
|
|
|
1007 |
|
|
|
1008 |
vert_header = |
|
|
1009 |
(TT_VertHeader*)FT_Get_Sfnt_Table( face, ft_sfnt_vhea ); |
|
|
1010 |
|
|
|
1011 |
|
|
|
|
1012 |
|
|
|
|
1013 |
|
|
|
1014 |
|
|
|
1017 |
|
|
|
1018 |
|
|
|
1019 |
|
|
|
1020 |
|
|
|
1021 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
1022 |
|
|
|
|
1023 |
|
|
|
1033 |
|
|
|
1034 |
Load any font table into client memory.
|
|
|
1035 |
|
|
|
|
1036 |
|
|
|
1050 |
| output | |
|
|
1051 |
|
|
|
1052 |
|
|
1053 |
| buffer | |
|
|
1054 |
The target buffer address. The client must ensure that the memory array is big enough to hold the data.
|
|
|
1055 |
|
|
|
|
1056 |
| |
|
|
1057 |
|
|
|
|
1058 |
| inout | |
|
|
1059 |
|
|
|
1060 |
|
|
1061 |
| length | |
|
|
1062 |
If the ‘length’ parameter is NULL, then try to load the whole table. Return an error code if it fails.
|
|
|
1063 |
Else, if ‘*length’ is 0, exit immediately while returning the table's (or file) full size in it.
|
|
|
1064 |
Else the number of bytes to read from the table or file, from the starting offset.
|
|
|
1065 |
|
|
|
|
1066 |
| |
|
|
1067 |
|
|
|
|
1068 |
| return | |
|
|
1069 |
FreeType error code. 0 means success.
|
|
|
1070 |
|
|
|
|
1071 |
| note | |
|
|
1072 |
If you need to determine the table's length you should first call this function with ‘*length’ set to 0, as in the following example:
|
|
|
1073 |
|
|
|
1074 |
FT_ULong length = 0; |
|
|
1075 |
|
|
|
1076 |
|
|
|
1077 |
error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length ); |
|
|
1078 |
if ( error ) { ... table does not exist ... } |
|
|
1079 |
|
|
|
1080 |
buffer = malloc( length ); |
|
|
1081 |
if ( buffer == NULL ) { ... not enough memory ... } |
|
|
1082 |
|
|
|
1083 |
error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length ); |
|
|
1084 |
if ( error ) { ... could not load table ... } |
|
|
1085 |
|
|
|
1086 |
|
|
|
|
1087 |
|
|
|
|
1088 |
|
|
|
1089 |
|
|
|
1092 |
|
|
|
1093 |
|
|
|
1144 |
|
|
|
1145 |
|
|
|
1148 |
|
|
|
1149 |
|
|
|
1150 |
|
|
|
1151 |
|
|
|
1152 |
Defined in FT_TRUETYPE_TABLES_H (freetype/tttables.h). |
|
|
1153 |
|
|
|
|
1154 |
|
|
|
1160 |
|
|
|
1161 |
Return TrueType/sfnt specific cmap language ID. Definitions of language ID values are in ‘freetype/ttnameid.h’.
|
|
|
1162 |
|
|
|
|
1163 |
|
|
|
1171 |
| return | |
|
|
1172 |
The language ID of ‘charmap’. If ‘charmap’ doesn't belong to a TrueType/sfnt face, just return 0 as the default value.
|
|
|
1173 |
For a format 14 cmap (to access Unicode IVS), the return value is 0xFFFFFFFF.
|
|
|
1174 |
|
|
|
|
1175 |
|
|
|
|
1176 |
|
|
|
1177 |
|
|
|
1180 |
|
|
|
1181 |
|
|
|
1207 |
|
|
|
1208 |
|
|
|
1211 |
|
|
|
1212 |
|
|
|
1226 |
|
|
|
1227 |
|
|
|
1230 |
|
|
|
1231 |
|
|
|
1232 |
|