| 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 |
Basic Data Types |
|
|
42 |
|
|
|
43 |
Synopsis
|
|
|
44 |
|
|
|
61 |
|
|
|
62 |
|
|
|
63 |
This section contains the basic data types defined by FreeType 2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section.
|
|
|
64 |
|
|
|
|
65 |
|
|
|
66 |
|
|
|
67 |
|
|
|
68 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
69 |
|
|
|
|
70 |
|
|
|
71 |
|
|
|
72 |
typedef unsigned char FT_Byte; |
|
|
73 |
|
|
|
74 |
|
|
|
|
75 |
|
|
|
76 |
A simple typedef for the unsigned char type.
|
|
|
77 |
|
|
|
|
78 |
|
|
|
|
79 |
|
|
|
80 |
|
|
|
83 |
|
|
|
84 |
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
88 |
|
|
|
|
89 |
|
|
|
94 |
|
|
|
95 |
A typedef for constant memory areas.
|
|
|
96 |
|
|
|
|
97 |
|
|
|
|
98 |
|
|
|
99 |
|
|
|
102 |
|
|
|
103 |
|
|
|
117 |
|
|
|
118 |
|
|
|
121 |
|
|
|
122 |
|
|
|
136 |
|
|
|
137 |
|
|
|
140 |
|
|
|
141 |
|
|
|
155 |
|
|
|
156 |
|
|
|
159 |
|
|
|
160 |
|
|
|
161 |
|
|
|
162 |
|
|
|
163 |
Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). |
|
|
164 |
|
|
|
|
165 |
|
|
|
170 |
|
|
|
171 |
A typedef for a 16bit signed integer type.
|
|
|
172 |
|
|
|
|
173 |
|
|
|
|
174 |
|
|
|
175 |
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
|
181 |
|
|
|
182 |
Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). |
|
|
183 |
|
|
|
|
184 |
|
|
|
189 |
|
|
|
190 |
A typedef for a 16bit unsigned integer type.
|
|
|
191 |
|
|
|
|
192 |
|
|
|
|
193 |
|
|
|
194 |
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). |
|
|
202 |
|
|
|
|
203 |
|
|
|
208 |
|
|
|
209 |
A typedef for a 32bit signed integer type. The size depends on the configuration.
|
|
|
210 |
|
|
|
|
211 |
|
|
|
|
212 |
|
|
|
213 |
|
|
|
216 |
|
|
|
217 |
|
|
|
228 |
|
|
|
229 |
|
|
|
232 |
|
|
|
233 |
|
|
|
247 |
|
|
|
248 |
|
|
|
251 |
|
|
|
252 |
|
|
|
266 |
|
|
|
267 |
|
|
|
270 |
|
|
|
271 |
|
|
|
285 |
|
|
|
286 |
|
|
|
289 |
|
|
|
290 |
|
|
|
304 |
|
|
|
305 |
|
|
|
308 |
|
|
|
309 |
|
|
|
310 |
|
|
|
311 |
|
|
|
312 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
313 |
|
|
|
|
314 |
|
|
|
319 |
|
|
|
320 |
A typedef of unsigned char, used for simple booleans. As usual, values 1 and 0 represent true and false, respectively.
|
|
|
321 |
|
|
|
|
322 |
|
|
|
|
323 |
|
|
|
324 |
|
|
|
327 |
|
|
|
328 |
|
|
|
329 |
|
|
|
330 |
|
|
|
331 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
332 |
|
|
|
|
333 |
|
|
|
338 |
|
|
|
339 |
This is equivalent to the ANSI C ‘size_t’ type, i.e., the largest unsigned integer type used to express a file size or position, or a memory block size.
|
|
|
340 |
|
|
|
|
341 |
|
|
|
|
342 |
|
|
|
343 |
|
|
|
346 |
|
|
|
347 |
|
|
|
348 |
|
|
|
349 |
|
|
|
350 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
351 |
|
|
|
|
352 |
|
|
|
357 |
|
|
|
358 |
This is equivalent to the ANSI C ‘ptrdiff_t’ type, i.e., the largest signed integer type used to express the distance between two pointers.
|
|
|
359 |
|
|
|
|
360 |
|
|
|
|
361 |
|
|
|
362 |
|
|
|
365 |
|
|
|
366 |
|
|
|
367 |
|
|
|
368 |
|
|
|
369 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
370 |
|
|
|
|
371 |
|
|
|
376 |
|
|
|
377 |
A simple typedef for the char type, usually used for strings.
|
|
|
378 |
|
|
|
|
379 |
|
|
|
|
380 |
|
|
|
381 |
|
|
|
384 |
|
|
|
385 |
|
|
|
386 |
|
|
|
387 |
|
|
|
388 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
389 |
|
|
|
|
390 |
|
|
|
395 |
|
|
|
396 |
A typedef for 32-bit tags (as used in the SFNT format).
|
|
|
397 |
|
|
|
|
398 |
|
|
|
|
399 |
|
|
|
400 |
|
|
|
403 |
|
|
|
404 |
|
|
|
405 |
|
|
|
406 |
|
|
|
407 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
408 |
|
|
|
|
409 |
|
|
|
414 |
|
|
|
415 |
The FreeType error code type. A value of 0 is always interpreted as a successful operation.
|
|
|
416 |
|
|
|
|
417 |
|
|
|
|
418 |
|
|
|
419 |
|
|
|
422 |
|
|
|
423 |
|
|
|
424 |
|
|
|
425 |
|
|
|
426 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
427 |
|
|
|
|
428 |
|
|
|
433 |
|
|
|
434 |
This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients.
|
|
|
435 |
|
|
|
|
436 |
|
|
|
|
437 |
|
|
|
438 |
|
|
|
441 |
|
|
|
442 |
|
|
|
456 |
|
|
|
457 |
|
|
|
460 |
|
|
|
461 |
|
|
|
462 |
|
|
|
463 |
|
|
|
464 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
465 |
|
|
|
|
466 |
|
|
|
471 |
|
|
|
472 |
The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed-point pixel coordinates.
|
|
|
473 |
|
|
|
|
474 |
|
|
|
|
475 |
|
|
|
476 |
|
|
|
479 |
|
|
|
480 |
|
|
|
481 |
|
|
|
482 |
|
|
|
483 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
484 |
|
|
|
|
485 |
|
|
|
495 |
|
|
|
496 |
A simple structure used to store a 2D vector; coordinates are of the FT_Pos type.
|
|
|
497 |
|
|
|
|
498 |
|
|
|
509 |
|
|
|
|
510 |
|
|
|
511 |
|
|
|
514 |
|
|
|
515 |
|
|
|
516 |
|
|
|
517 |
|
|
|
518 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
519 |
|
|
|
|
520 |
|
|
|
530 |
|
|
|
531 |
A structure used to hold an outline's bounding box, i.e., the coordinates of its extrema in the horizontal and vertical directions.
|
|
|
532 |
|
|
|
|
533 |
|
|
|
550 |
| note | |
|
|
551 |
The bounding box is specified with the coordinates of the lower left and the upper right corner. In PostScript, those values are often called (llx,lly) and (urx,ury), respectively.
|
|
|
552 |
If ‘yMin’ is negative, this value gives the glyph's descender. Otherwise, the glyph doesn't descend below the baseline. Similarly, if ‘ymax’ is positive, this value gives the glyph's ascender.
|
|
|
553 |
‘xMin’ gives the horizontal distance from the glyph's origin to the left edge of the glyph's bounding box. If ‘xMin’ is negative, the glyph extends to the left of the origin.
|
|
|
554 |
|
|
|
|
555 |
|
|
|
|
556 |
|
|
|
557 |
|
|
|
560 |
|
|
|
561 |
|
|
|
562 |
|
|
|
563 |
|
|
|
564 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
565 |
|
|
|
|
566 |
|
|
|
576 |
|
|
|
577 |
A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is:
|
|
|
578 |
|
|
|
579 |
x' = x*xx + y*xy |
|
|
580 |
y' = x*yx + y*yy |
|
|
581 |
|
|
|
582 |
|
|
|
|
583 |
|
|
|
600 |
|
|
|
|
601 |
|
|
|
602 |
|
|
|
605 |
|
|
|
606 |
|
|
|
607 |
|
|
|
608 |
|
|
|
609 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
610 |
|
|
|
|
611 |
|
|
|
612 |
|
|
|
613 |
typedef signed short FT_FWord; /* distance in FUnits */ |
|
|
614 |
|
|
|
615 |
|
|
|
|
616 |
|
|
|
617 |
A signed 16-bit integer used to store a distance in original font units.
|
|
|
618 |
|
|
|
|
619 |
|
|
|
|
620 |
|
|
|
621 |
|
|
|
624 |
|
|
|
625 |
|
|
|
626 |
|
|
|
627 |
|
|
|
628 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
629 |
|
|
|
|
630 |
|
|
|
631 |
|
|
|
632 |
typedef unsigned short FT_UFWord; /* unsigned distance */ |
|
|
633 |
|
|
|
634 |
|
|
|
|
635 |
|
|
|
636 |
An unsigned 16-bit integer used to store a distance in original font units.
|
|
|
637 |
|
|
|
|
638 |
|
|
|
|
639 |
|
|
|
640 |
|
|
|
643 |
|
|
|
644 |
|
|
|
658 |
|
|
|
659 |
|
|
|
662 |
|
|
|
663 |
|
|
|
664 |
|
|
|
665 |
|
|
|
666 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
667 |
|
|
|
|
668 |
|
|
|
678 |
|
|
|
679 |
A simple structure used to store a 2D vector unit vector. Uses FT_F2Dot14 types.
|
|
|
680 |
|
|
|
|
681 |
|
|
|
692 |
|
|
|
|
693 |
|
|
|
694 |
|
|
|
697 |
|
|
|
698 |
|
|
|
699 |
|
|
|
700 |
|
|
|
701 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
702 |
|
|
|
|
703 |
|
|
|
708 |
|
|
|
709 |
A signed 26.6 fixed-point type used for vectorial pixel coordinates.
|
|
|
710 |
|
|
|
|
711 |
|
|
|
|
712 |
|
|
|
713 |
|
|
|
716 |
|
|
|
717 |
|
|
|
718 |
|
|
|
719 |
|
|
|
720 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
721 |
|
|
|
|
722 |
|
|
|
740 |
|
|
|
741 |
An enumeration type used to describe the format of pixels in a given bitmap. Note that additional formats may be added in the future.
|
|
|
742 |
|
|
|
|
743 |
| values | |
|
|
744 |
|
|
|
745 |
|
|
746 |
| FT_PIXEL_MODE_NONE | |
|
|
747 |
Value 0 is reserved.
|
|
|
748 |
|
|
|
|
749 |
| FT_PIXEL_MODE_MONO | |
|
|
750 |
A monochrome bitmap, using 1 bit per pixel. Note that pixels are stored in most-significant order (MSB), which means that the left-most pixel in a byte has value 128.
|
|
|
751 |
|
|
|
|
752 |
| FT_PIXEL_MODE_GRAY | |
|
|
753 |
An 8-bit bitmap, generally used to represent anti-aliased glyph images. Each pixel is stored in one byte. Note that the number of ‘gray’ levels is stored in the ‘num_grays’ field of the FT_Bitmap structure (it generally is 256).
|
|
|
754 |
|
|
|
|
755 |
| FT_PIXEL_MODE_GRAY2 | |
|
|
756 |
A 2-bit per pixel bitmap, used to represent embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.
|
|
|
757 |
|
|
|
|
758 |
| FT_PIXEL_MODE_GRAY4 | |
|
|
759 |
A 4-bit per pixel bitmap, representing embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.
|
|
|
760 |
|
|
|
|
761 |
| FT_PIXEL_MODE_LCD | |
|
|
762 |
An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on LCD displays; the bitmap is three times wider than the original glyph image. See also FT_RENDER_MODE_LCD.
|
|
|
763 |
|
|
|
|
764 |
| FT_PIXEL_MODE_LCD_V | |
|
|
765 |
An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on rotated LCD displays; the bitmap is three times taller than the original glyph image. See also FT_RENDER_MODE_LCD_V.
|
|
|
766 |
|
|
|
|
767 |
| FT_PIXEL_MODE_BGRA | |
|
|
768 |
An image with four 8-bit channels per pixel, representing a color image (such as emoticons) with alpha channel. For each pixel, the format is BGRA, which means, the blue channel comes first in memory. The color channels are pre-multiplied and in the sRGB colorspace. For example, full red at half-translucent opacity will be represented as ‘00,00,80,80’, not ‘00,00,FF,80’. See also FT_LOAD_COLOR.
|
|
|
769 |
|
|
|
|
770 |
| |
|
|
771 |
|
|
|
|
772 |
|
|
|
|
773 |
|
|
|
774 |
|
|
|
777 |
|
|
|
778 |
|
|
|
816 |
|
|
|
817 |
|
|
|
820 |
|
|
|
821 |
|
|
|
822 |
|
|
|
823 |
|
|
|
824 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
825 |
|
|
|
|
826 |
|
|
|
838 |
|
|
|
839 |
THIS TYPE IS DEPRECATED. DO NOT USE IT!
|
|
|
840 |
An enumeration type to describe the format of a bitmap palette, used with ft_pixel_mode_pal4 and ft_pixel_mode_pal8.
|
|
|
841 |
|
|
|
|
842 |
| values | |
|
|
843 |
|
|
|
844 |
|
|
845 |
| ft_palette_mode_rgb | |
|
|
846 |
The palette is an array of 3-byte RGB records.
|
|
|
847 |
|
|
|
|
848 |
| ft_palette_mode_rgba | |
|
|
849 |
The palette is an array of 4-byte RGBA records.
|
|
|
850 |
|
|
|
|
851 |
| |
|
|
852 |
|
|
|
|
853 |
| note | |
|
|
854 |
As ft_pixel_mode_pal2, pal4 and pal8 are currently unused by FreeType, these types are not handled by the library itself.
|
|
|
855 |
|
|
|
|
856 |
|
|
|
|
857 |
|
|
|
858 |
|
|
|
861 |
|
|
|
862 |
|
|
|
863 |
|
|
|
864 |
|
|
|
865 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
866 |
|
|
|
|
867 |
|
|
|
883 |
|
|
|
884 |
A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the ‘pixel_mode’ field.
|
|
|
885 |
|
|
|
|
886 |
| fields | |
|
|
887 |
|
|
|
888 |
|
|
889 |
| rows | |
|
|
890 |
The number of bitmap rows.
|
|
|
891 |
|
|
|
|
892 |
| width | |
|
|
893 |
The number of pixels in bitmap row.
|
|
|
894 |
|
|
|
|
895 |
| pitch | |
|
|
896 |
The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row.
|
|
|
897 |
Note that ‘padding’ means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value.
|
|
|
898 |
For the B/W rasterizer, ‘pitch’ is always an even number.
|
|
|
899 |
To change the pitch of a bitmap (say, to make it a multiple of 4), use FT_Bitmap_Convert. Alternatively, you might use callback functions to directly render to the application's surface; see the file ‘example2.cpp’ in the tutorial for a demonstration.
|
|
|
900 |
|
|
|
|
901 |
| buffer | |
|
|
902 |
A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.
|
|
|
903 |
|
|
|
|
904 |
| num_grays | |
|
|
905 |
This field is only used with FT_PIXEL_MODE_GRAY; it gives the number of gray levels used in the bitmap.
|
|
|
906 |
|
|
|
|
907 |
| pixel_mode | |
|
|
908 |
The pixel mode, i.e., how pixel bits are stored. See FT_Pixel_Mode for possible values.
|
|
|
909 |
|
|
|
|
910 |
| palette_mode | |
|
|
911 |
This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently.
|
|
|
912 |
|
|
|
|
913 |
| palette | |
|
|
914 |
A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently.
|
|
|
915 |
|
|
|
|
916 |
| |
|
|
917 |
|
|
|
|
918 |
| note | |
|
|
919 |
For now, the only pixel modes supported by FreeType are mono and grays. However, drivers might be added in the future to support more ‘colorful’ options.
|
|
|
920 |
|
|
|
|
921 |
|
|
|
|
922 |
|
|
|
923 |
|
|
|
926 |
|
|
|
927 |
|
|
|
928 |
|
|
|
929 |
|
|
|
930 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
931 |
|
|
|
|
932 |
|
|
|
933 |
|
|
|
934 |
#ifndef FT_IMAGE_TAG |
|
|
935 |
#define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) \ |
|
|
936 |
value = ( ( (unsigned long)_x1 << 24 ) | \ |
|
|
937 |
( (unsigned long)_x2 << 16 ) | \ |
|
|
938 |
( (unsigned long)_x3 << 8 ) | \ |
|
|
939 |
(unsigned long)_x4 ) |
|
|
940 |
#endif /* FT_IMAGE_TAG */ |
|
|
941 |
|
|
|
942 |
|
|
|
|
943 |
|
|
|
944 |
This macro converts four-letter tags to an unsigned long type.
|
|
|
945 |
|
|
|
|
946 |
| note | |
|
|
947 |
Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this:
|
|
|
948 |
|
|
|
949 |
#define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value |
|
|
950 |
|
|
|
951 |
to get a simple enumeration without assigning special numbers.
|
|
|
952 |
|
|
|
|
953 |
|
|
|
|
954 |
|
|
|
955 |
|
|
|
958 |
|
|
|
959 |
|
|
|
960 |
|
|
|
961 |
|
|
|
962 |
Defined in FT_IMAGE_H (freetype/ftimage.h). |
|
|
963 |
|
|
|
|
964 |
|
|
|
965 |
|
|
|
966 |
typedef enum FT_Glyph_Format_ |
|
|
967 |
{ |
|
|
968 |
FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ), |
|
|
969 |
|
|
|
970 |
FT_IMAGE_TAG( FT_GLYPH_FORMAT_COMPOSITE, 'c', 'o', 'm', 'p' ), |
|
|
971 |
FT_IMAGE_TAG( FT_GLYPH_FORMAT_BITMAP, 'b', 'i', 't', 's' ), |
|
|
972 |
FT_IMAGE_TAG( FT_GLYPH_FORMAT_OUTLINE, 'o', 'u', 't', 'l' ), |
|
|
973 |
FT_IMAGE_TAG( FT_GLYPH_FORMAT_PLOTTER, 'p', 'l', 'o', 't' ) |
|
|
974 |
|
|
|
975 |
} FT_Glyph_Format; |
|
|
976 |
|
|
|
977 |
|
|
|
|
978 |
|
|
|
979 |
An enumeration type used to describe the format of a given glyph image. Note that this version of FreeType only supports two image formats, even though future font drivers will be able to register their own format.
|
|
|
980 |
|
|
|
|
981 |
| values | |
|
|
982 |
|
|
|
983 |
|
|
984 |
| FT_GLYPH_FORMAT_NONE | |
|
|
985 |
The value 0 is reserved.
|
|
|
986 |
|
|
|
|
987 |
| FT_GLYPH_FORMAT_COMPOSITE |
|
|
|
988 |
| |
|
|
989 |
The glyph image is a composite of several other images. This format is only used with FT_LOAD_NO_RECURSE, and is used to report compound glyphs (like accented characters).
|
|
|
990 |
|
|
|
|
991 |
| FT_GLYPH_FORMAT_BITMAP | |
|
|
992 |
The glyph image is a bitmap, and can be described as an FT_Bitmap. You generally need to access the ‘bitmap’ field of the FT_GlyphSlotRec structure to read it.
|
|
|
993 |
|
|
|
|
994 |
| FT_GLYPH_FORMAT_OUTLINE |
|
|
|
995 |
| |
|
|
996 |
The glyph image is a vectorial outline made of line segments and Bézier arcs; it can be described as an FT_Outline; you generally want to access the ‘outline’ field of the FT_GlyphSlotRec structure to read it.
|
|
|
997 |
|
|
|
|
998 |
| FT_GLYPH_FORMAT_PLOTTER |
|
|
|
999 |
| |
|
|
1000 |
The glyph image is a vectorial path with no inside and outside contours. Some Type 1 fonts, like those in the Hershey family, contain glyphs in this format. These are described as FT_Outline, but FreeType isn't currently capable of rendering them correctly.
|
|
|
1001 |
|
|
|
|
1002 |
| |
|
|
1003 |
|
|
|
|
1004 |
|
|
|
|
1005 |
|
|
|
1006 |
|
|
|
1009 |
|
|
|
1010 |
|
|
|
1051 |
|
|
|
1052 |
|
|
|
1055 |
|
|
|
1056 |
|
|
|
1086 |
|
|
|
1087 |
|
|
|
1090 |
|
|
|
1091 |
|
|
|
1092 |
|
|
|
1093 |
|
|
|
1094 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
1095 |
|
|
|
|
1096 |
|
|
|
1101 |
|
|
|
1102 |
Describe a function used to destroy the ‘client’ data of any FreeType object. See the description of the FT_Generic type for details of usage.
|
|
|
1103 |
|
|
|
|
1104 |
| input | |
|
|
1105 |
The address of the FreeType object which is under finalization. Its client data is accessed through its ‘generic’ field.
|
|
|
1106 |
|
|
|
|
1107 |
|
|
|
|
1108 |
|
|
|
1109 |
|
|
|
1112 |
|
|
|
1113 |
|
|
|
1114 |
|
|
|
1115 |
|
|
|
1116 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
1117 |
|
|
|
|
1118 |
|
|
|
1128 |
|
|
|
1129 |
Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object.
|
|
|
1130 |
Some FreeType object contains a ‘generic’ field, of type FT_Generic, which usage is left to client applications and font servers.
|
|
|
1131 |
It can be used to store a pointer to client-specific data, as well as the address of a ‘finalizer’ function, which will be called by FreeType when the object is destroyed (for example, the previous client example would put the address of the glyph cache destructor in the ‘finalizer’ field).
|
|
|
1132 |
|
|
|
|
1133 |
| fields | |
|
|
1134 |
|
|
|
1135 |
|
|
1136 |
| data | |
|
|
1137 |
A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library.
|
|
|
1138 |
|
|
|
|
1139 |
| finalizer | |
|
|
1140 |
A pointer to a ‘generic finalizer’ function, which will be called when the object is destroyed. If this field is set to NULL, no code will be called.
|
|
|
1141 |
|
|
|
|
1142 |
| |
|
|
1143 |
|
|
|
|
1144 |
|
|
|
|
1145 |
|
|
|
1146 |
|
|
|
1149 |
|
|
|
1150 |
|
|
|
1151 |
|
|
|
1152 |
|
|
|
1153 |
Defined in FT_TYPES_H (freetype/fttypes.h). |
|
|
1154 |
|
|
|
|
1155 |
|
|
|
1165 |
|
|
|
1166 |
This macro converts four-letter tags which are used to label TrueType tables into an unsigned long to be used within FreeType.
|
|
|
1167 |
|
|
|
|
1168 |
| note | |
|
|
1169 |
The produced values must be 32-bit integers. Don't redefine this macro.
|
|
|
1170 |
|
|
|
|
1171 |
|
|
|
|
1172 |
|
|
|
1173 |
|
|
|
1176 |
|
|
|
1177 |
|
|
|
1188 |
|
|
|
1189 |
|
|
|
1192 |
|
|
|
1193 |
|
|
|
1204 |
|
|
|
1205 |
|
|
|
1208 |
|
|
|
1209 |
|
|
|
1210 |
|