source: trunk/poppler/freetype2/include/freetype/freetype.h @ 251

Last change on this file since 251 was 251, checked in by Eugene Romanenko, 13 years ago

PDF plugin: freetype library updated to version 2.3.5

File size: 229.1 KB
Line 
1/***************************************************************************/
2/*                                                                         */
3/*  freetype.h                                                             */
4/*                                                                         */
5/*    FreeType high-level API and common types (specification only).       */
6/*                                                                         */
7/*  Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by       */
8/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
9/*                                                                         */
10/*  This file is part of the FreeType project, and may only be used,       */
11/*  modified, and distributed under the terms of the FreeType project      */
12/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
13/*  this file you indicate that you have read the license and              */
14/*  understand and accept it fully.                                        */
15/*                                                                         */
16/***************************************************************************/
17
18
19#ifndef FT_FREETYPE_H
20#error "`ft2build.h' hasn't been included yet!"
21#error "Please always use macros to include FreeType header files."
22#error "Example:"
23#error "  #include <ft2build.h>"
24#error "  #include FT_FREETYPE_H"
25#endif
26
27
28  /*************************************************************************/
29  /*                                                                       */
30  /* The `raster' component duplicates some of the declarations in         */
31  /* freetype.h for stand-alone use if _FREETYPE_ isn't defined.           */
32  /*                                                                       */
33  /*************************************************************************/
34
35
36#ifndef __FREETYPE_H__
37#define __FREETYPE_H__
38
39
40#include <ft2build.h>
41#include FT_CONFIG_CONFIG_H
42#include FT_ERRORS_H
43#include FT_TYPES_H
44
45
46FT_BEGIN_HEADER
47
48
49
50  /*************************************************************************/
51  /*                                                                       */
52  /* <Section>                                                             */
53  /*    user_allocation                                                    */
54  /*                                                                       */
55  /* <Title>                                                               */
56  /*    User allocation                                                    */
57  /*                                                                       */
58  /* <Abstract>                                                            */
59  /*    How client applications should allocate FreeType data structures.  */
60  /*                                                                       */
61  /* <Description>                                                         */
62  /*    FreeType assumes that structures allocated by the user and passed  */
63  /*    as arguments are zeroed out except for the actual data.  With      */
64  /*    other words, it is recommended to use `calloc' (or variants of it) */
65  /*    instead of `malloc' for allocation.                                */
66  /*                                                                       */
67  /*************************************************************************/
68
69
70
71  /*************************************************************************/
72  /*************************************************************************/
73  /*                                                                       */
74  /*                        B A S I C   T Y P E S                          */
75  /*                                                                       */
76  /*************************************************************************/
77  /*************************************************************************/
78
79
80  /*************************************************************************/
81  /*                                                                       */
82  /* <Section>                                                             */
83  /*    base_interface                                                     */
84  /*                                                                       */
85  /* <Title>                                                               */
86  /*    Base Interface                                                     */
87  /*                                                                       */
88  /* <Abstract>                                                            */
89  /*    The FreeType~2 base font interface.                                */
90  /*                                                                       */
91  /* <Description>                                                         */
92  /*    This section describes the public high-level API of FreeType~2.    */
93  /*                                                                       */
94  /* <Order>                                                               */
95  /*    FT_Library                                                         */
96  /*    FT_Face                                                            */
97  /*    FT_Size                                                            */
98  /*    FT_GlyphSlot                                                       */
99  /*    FT_CharMap                                                         */
100  /*    FT_Encoding                                                        */
101  /*                                                                       */
102  /*    FT_FaceRec                                                         */
103  /*                                                                       */
104  /*    FT_FACE_FLAG_SCALABLE                                              */
105  /*    FT_FACE_FLAG_FIXED_SIZES                                           */
106  /*    FT_FACE_FLAG_FIXED_WIDTH                                           */
107  /*    FT_FACE_FLAG_HORIZONTAL                                            */
108  /*    FT_FACE_FLAG_VERTICAL                                              */
109  /*    FT_FACE_FLAG_SFNT                                                  */
110  /*    FT_FACE_FLAG_KERNING                                               */
111  /*    FT_FACE_FLAG_MULTIPLE_MASTERS                                      */
112  /*    FT_FACE_FLAG_GLYPH_NAMES                                           */
113  /*    FT_FACE_FLAG_EXTERNAL_STREAM                                       */
114  /*    FT_FACE_FLAG_FAST_GLYPHS                                           */
115  /*    FT_FACE_FLAG_HINTER                                                */
116  /*                                                                       */
117  /*    FT_STYLE_FLAG_BOLD                                                 */
118  /*    FT_STYLE_FLAG_ITALIC                                               */
119  /*                                                                       */
120  /*    FT_SizeRec                                                         */
121  /*    FT_Size_Metrics                                                    */
122  /*                                                                       */
123  /*    FT_GlyphSlotRec                                                    */
124  /*    FT_Glyph_Metrics                                                   */
125  /*    FT_SubGlyph                                                        */
126  /*                                                                       */
127  /*    FT_Bitmap_Size                                                     */
128  /*                                                                       */
129  /*    FT_Init_FreeType                                                   */
130  /*    FT_Done_FreeType                                                   */
131  /*                                                                       */
132  /*    FT_New_Face                                                        */
133  /*    FT_Done_Face                                                       */
134  /*    FT_New_Memory_Face                                                 */
135  /*    FT_Open_Face                                                       */
136  /*    FT_Open_Args                                                       */
137  /*    FT_Parameter                                                       */
138  /*    FT_Attach_File                                                     */
139  /*    FT_Attach_Stream                                                   */
140  /*                                                                       */
141  /*    FT_Set_Char_Size                                                   */
142  /*    FT_Set_Pixel_Sizes                                                 */
143  /*    FT_Request_Size                                                    */
144  /*    FT_Select_Size                                                     */
145  /*    FT_Size_Request_Type                                               */
146  /*    FT_Size_Request                                                    */
147  /*    FT_Set_Transform                                                   */
148  /*    FT_Load_Glyph                                                      */
149  /*    FT_Get_Char_Index                                                  */
150  /*    FT_Get_Name_Index                                                  */
151  /*    FT_Load_Char                                                       */
152  /*                                                                       */
153  /*    FT_OPEN_MEMORY                                                     */
154  /*    FT_OPEN_STREAM                                                     */
155  /*    FT_OPEN_PATHNAME                                                   */
156  /*    FT_OPEN_DRIVER                                                     */
157  /*    FT_OPEN_PARAMS                                                     */
158  /*                                                                       */
159  /*    FT_LOAD_DEFAULT                                                    */
160  /*    FT_LOAD_RENDER                                                     */
161  /*    FT_LOAD_MONOCHROME                                                 */
162  /*    FT_LOAD_LINEAR_DESIGN                                              */
163  /*    FT_LOAD_NO_SCALE                                                   */
164  /*    FT_LOAD_NO_HINTING                                                 */
165  /*    FT_LOAD_NO_BITMAP                                                  */
166  /*    FT_LOAD_CROP_BITMAP                                                */
167  /*                                                                       */
168  /*    FT_LOAD_VERTICAL_LAYOUT                                            */
169  /*    FT_LOAD_IGNORE_TRANSFORM                                           */
170  /*    FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH                                */
171  /*    FT_LOAD_FORCE_AUTOHINT                                             */
172  /*    FT_LOAD_NO_RECURSE                                                 */
173  /*    FT_LOAD_PEDANTIC                                                   */
174  /*                                                                       */
175  /*    FT_LOAD_TARGET_NORMAL                                              */
176  /*    FT_LOAD_TARGET_LIGHT                                               */
177  /*    FT_LOAD_TARGET_MONO                                                */
178  /*    FT_LOAD_TARGET_LCD                                                 */
179  /*    FT_LOAD_TARGET_LCD_V                                               */
180  /*                                                                       */
181  /*    FT_Render_Glyph                                                    */
182  /*    FT_Render_Mode                                                     */
183  /*    FT_Get_Kerning                                                     */
184  /*    FT_Kerning_Mode                                                    */
185  /*    FT_Get_Track_Kerning                                               */
186  /*    FT_Get_Glyph_Name                                                  */
187  /*    FT_Get_Postscript_Name                                             */
188  /*                                                                       */
189  /*    FT_CharMapRec                                                      */
190  /*    FT_Select_Charmap                                                  */
191  /*    FT_Set_Charmap                                                     */
192  /*    FT_Get_Charmap_Index                                               */
193  /*                                                                       */
194  /*************************************************************************/
195
196
197  /*************************************************************************/
198  /*                                                                       */
199  /* <Struct>                                                              */
200  /*    FT_Glyph_Metrics                                                   */
201  /*                                                                       */
202  /* <Description>                                                         */
203  /*    A structure used to model the metrics of a single glyph.  The      */
204  /*    values are expressed in 26.6 fractional pixel format; if the flag  */
205  /*    @FT_LOAD_NO_SCALE has been used while loading the glyph, values    */
206  /*    are expressed in font units instead.                               */
207  /*                                                                       */
208  /* <Fields>                                                              */
209  /*    width ::                                                           */
210  /*      The glyph's width.                                               */
211  /*                                                                       */
212  /*    height ::                                                          */
213  /*      The glyph's height.                                              */
214  /*                                                                       */
215  /*    horiBearingX ::                                                    */
216  /*      Left side bearing for horizontal layout.                         */
217  /*                                                                       */
218  /*    horiBearingY ::                                                    */
219  /*      Top side bearing for horizontal layout.                          */
220  /*                                                                       */
221  /*    horiAdvance ::                                                     */
222  /*      Advance width for horizontal layout.                             */
223  /*                                                                       */
224  /*    vertBearingX ::                                                    */
225  /*      Left side bearing for vertical layout.                           */
226  /*                                                                       */
227  /*    vertBearingY ::                                                    */
228  /*      Top side bearing for vertical layout.                            */
229  /*                                                                       */
230  /*    vertAdvance ::                                                     */
231  /*      Advance height for vertical layout.                              */
232  /*                                                                       */
233  typedef struct  FT_Glyph_Metrics_
234  {
235    FT_Pos  width;
236    FT_Pos  height;
237
238    FT_Pos  horiBearingX;
239    FT_Pos  horiBearingY;
240    FT_Pos  horiAdvance;
241
242    FT_Pos  vertBearingX;
243    FT_Pos  vertBearingY;
244    FT_Pos  vertAdvance;
245
246  } FT_Glyph_Metrics;
247
248
249  /*************************************************************************/
250  /*                                                                       */
251  /* <Struct>                                                              */
252  /*    FT_Bitmap_Size                                                     */
253  /*                                                                       */
254  /* <Description>                                                         */
255  /*    This structure models the metrics of a bitmap strike (i.e., a set  */
256  /*    of glyphs for a given point size and resolution) in a bitmap font. */
257  /*    It is used for the `available_sizes' field of @FT_Face.            */
258  /*                                                                       */
259  /* <Fields>                                                              */
260  /*    height :: The vertical distance, in pixels, between two            */
261  /*              consecutive baselines.  It is always positive.           */
262  /*                                                                       */
263  /*    width  :: The average width, in pixels, of all glyphs in the       */
264  /*              strike.                                                  */
265  /*                                                                       */
266  /*    size   :: The nominal size of the strike in 26.6 fractional        */
267  /*              points.  This field is not very useful.                  */
268  /*                                                                       */
269  /*    x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional   */
270  /*              pixels.                                                  */
271  /*                                                                       */
272  /*    y_ppem :: The vertical ppem (nominal height) in 26.6 fractional    */
273  /*              pixels.                                                  */
274  /*                                                                       */
275  /* <Note>                                                                */
276  /*    Windows FNT:                                                       */
277  /*      The nominal size given in a FNT font is not reliable.  Thus when */
278  /*      the driver finds it incorrect, it sets `size' to some calculated */
279  /*      values and sets `x_ppem' and `y_ppem' to the pixel width and     */
280  /*      height given in the font, respectively.                          */
281  /*                                                                       */
282  /*    TrueType embedded bitmaps:                                         */
283  /*      `size', `width', and `height' values are not contained in the    */
284  /*      bitmap strike itself.  They are computed from the global font    */
285  /*      parameters.                                                      */
286  /*                                                                       */
287  typedef struct  FT_Bitmap_Size_
288  {
289    FT_Short  height;
290    FT_Short  width;
291
292    FT_Pos    size;
293
294    FT_Pos    x_ppem;
295    FT_Pos    y_ppem;
296
297  } FT_Bitmap_Size;
298
299
300  /*************************************************************************/
301  /*************************************************************************/
302  /*                                                                       */
303  /*                     O B J E C T   C L A S S E S                       */
304  /*                                                                       */
305  /*************************************************************************/
306  /*************************************************************************/
307
308  /*************************************************************************/
309  /*                                                                       */
310  /* <Type>                                                                */
311  /*    FT_Library                                                         */
312  /*                                                                       */
313  /* <Description>                                                         */
314  /*    A handle to a FreeType library instance.  Each `library' is        */
315  /*    completely independent from the others; it is the `root' of a set  */
316  /*    of objects like fonts, faces, sizes, etc.                          */
317  /*                                                                       */
318  /*    It also embeds a memory manager (see @FT_Memory), as well as a     */
319  /*    scan-line converter object (see @FT_Raster).                       */
320  /*                                                                       */
321  /*    For multi-threading applications each thread should have its own   */
322  /*    FT_Library object.                                                 */
323  /*                                                                       */
324  /* <Note>                                                                */
325  /*    Library objects are normally created by @FT_Init_FreeType, and     */
326  /*    destroyed with @FT_Done_FreeType.                                  */
327  /*                                                                       */
328  typedef struct FT_LibraryRec_  *FT_Library;
329
330
331  /*************************************************************************/
332  /*                                                                       */
333  /* <Type>                                                                */
334  /*    FT_Module                                                          */
335  /*                                                                       */
336  /* <Description>                                                         */
337  /*    A handle to a given FreeType module object.  Each module can be a  */
338  /*    font driver, a renderer, or anything else that provides services   */
339  /*    to the formers.                                                    */
340  /*                                                                       */
341  typedef struct FT_ModuleRec_*  FT_Module;
342
343
344  /*************************************************************************/
345  /*                                                                       */
346  /* <Type>                                                                */
347  /*    FT_Driver                                                          */
348  /*                                                                       */
349  /* <Description>                                                         */
350  /*    A handle to a given FreeType font driver object.  Each font driver */
351  /*    is a special module capable of creating faces from font files.     */
352  /*                                                                       */
353  typedef struct FT_DriverRec_*  FT_Driver;
354
355
356  /*************************************************************************/
357  /*                                                                       */
358  /* <Type>                                                                */
359  /*    FT_Renderer                                                        */
360  /*                                                                       */
361  /* <Description>                                                         */
362  /*    A handle to a given FreeType renderer.  A renderer is a special    */
363  /*    module in charge of converting a glyph image to a bitmap, when     */
364  /*    necessary.  Each renderer supports a given glyph image format, and */
365  /*    one or more target surface depths.                                 */
366  /*                                                                       */
367  typedef struct FT_RendererRec_*  FT_Renderer;
368
369
370  /*************************************************************************/
371  /*                                                                       */
372  /* <Type>                                                                */
373  /*    FT_Face                                                            */
374  /*                                                                       */
375  /* <Description>                                                         */
376  /*    A handle to a given typographic face object.  A face object models */
377  /*    a given typeface, in a given style.                                */
378  /*                                                                       */
379  /* <Note>                                                                */
380  /*    Each face object also owns a single @FT_GlyphSlot object, as well  */
381  /*    as one or more @FT_Size objects.                                   */
382  /*                                                                       */
383  /*    Use @FT_New_Face or @FT_Open_Face to create a new face object from */
384  /*    a given filepathname or a custom input stream.                     */
385  /*                                                                       */
386  /*    Use @FT_Done_Face to destroy it (along with its slot and sizes).   */
387  /*                                                                       */
388  /* <Also>                                                                */
389  /*    The @FT_FaceRec details the publicly accessible fields of a given  */
390  /*    face object.                                                       */
391  /*                                                                       */
392  typedef struct FT_FaceRec_*  FT_Face;
393
394
395  /*************************************************************************/
396  /*                                                                       */
397  /* <Type>                                                                */
398  /*    FT_Size                                                            */
399  /*                                                                       */
400  /* <Description>                                                         */
401  /*    A handle to an object used to model a face scaled to a given       */
402  /*    character size.                                                    */
403  /*                                                                       */
404  /* <Note>                                                                */
405  /*    Each @FT_Face has an _active_ @FT_Size object that is used by      */
406  /*    functions like @FT_Load_Glyph to determine the scaling             */
407  /*    transformation which is used to load and hint glyphs and metrics.  */
408  /*                                                                       */
409  /*    You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes,                */
410  /*    @FT_Request_Size or even @FT_Select_Size to change the content     */
411  /*    (i.e., the scaling values) of the active @FT_Size.                 */
412  /*                                                                       */
413  /*    You can use @FT_New_Size to create additional size objects for a   */
414  /*    given @FT_Face, but they won't be used by other functions until    */
415  /*    you activate it through @FT_Activate_Size.  Only one size can be   */
416  /*    activated at any given time per face.                              */
417  /*                                                                       */
418  /* <Also>                                                                */
419  /*    The @FT_SizeRec structure details the publicly accessible fields   */
420  /*    of a given size object.                                            */
421  /*                                                                       */
422  typedef struct FT_SizeRec_*  FT_Size;
423
424
425  /*************************************************************************/
426  /*                                                                       */
427  /* <Type>                                                                */
428  /*    FT_GlyphSlot                                                       */
429  /*                                                                       */
430  /* <Description>                                                         */
431  /*    A handle to a given `glyph slot'.  A slot is a container where it  */
432  /*    is possible to load any one of the glyphs contained in its parent  */
433  /*    face.                                                              */
434  /*                                                                       */
435  /*    In other words, each time you call @FT_Load_Glyph or               */
436  /*    @FT_Load_Char, the slot's content is erased by the new glyph data, */
437  /*    i.e., the glyph's metrics, its image (bitmap or outline), and      */
438  /*    other control information.                                         */
439  /*                                                                       */
440  /* <Also>                                                                */
441  /*    @FT_GlyphSlotRec details the publicly accessible glyph fields.     */
442  /*                                                                       */
443  typedef struct FT_GlyphSlotRec_*  FT_GlyphSlot;
444
445
446  /*************************************************************************/
447  /*                                                                       */
448  /* <Type>                                                                */
449  /*    FT_CharMap                                                         */
450  /*                                                                       */
451  /* <Description>                                                         */
452  /*    A handle to a given character map.  A charmap is used to translate */
453  /*    character codes in a given encoding into glyph indexes for its     */
454  /*    parent's face.  Some font formats may provide several charmaps per */
455  /*    font.                                                              */
456  /*                                                                       */
457  /*    Each face object owns zero or more charmaps, but only one of them  */
458  /*    can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char.   */
459  /*                                                                       */
460  /*    The list of available charmaps in a face is available through the  */
461  /*    `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec.   */
462  /*                                                                       */
463  /*    The currently active charmap is available as `face->charmap'.      */
464  /*    You should call @FT_Set_Charmap to change it.                      */
465  /*                                                                       */
466  /* <Note>                                                                */
467  /*    When a new face is created (either through @FT_New_Face or         */
468  /*    @FT_Open_Face), the library looks for a Unicode charmap within     */
469  /*    the list and automatically activates it.                           */
470  /*                                                                       */
471  /* <Also>                                                                */
472  /*    The @FT_CharMapRec details the publicly accessible fields of a     */
473  /*    given character map.                                               */
474  /*                                                                       */
475  typedef struct FT_CharMapRec_*  FT_CharMap;
476
477
478  /*************************************************************************/
479  /*                                                                       */
480  /* <Macro>                                                               */
481  /*    FT_ENC_TAG                                                         */
482  /*                                                                       */
483  /* <Description>                                                         */
484  /*    This macro converts four-letter tags into an unsigned long.  It is */
485  /*    used to define `encoding' identifiers (see @FT_Encoding).          */
486  /*                                                                       */
487  /* <Note>                                                                */
488  /*    Since many 16-bit compilers don't like 32-bit enumerations, you    */
489  /*    should redefine this macro in case of problems to something like   */
490  /*    this:                                                              */
491  /*                                                                       */
492  /*    {                                                                  */
493  /*      #define FT_ENC_TAG( value, a, b, c, d )  value                   */
494  /*    }                                                                  */
495  /*                                                                       */
496  /*    to get a simple enumeration without assigning special numbers.     */
497  /*                                                                       */
498
499#ifndef FT_ENC_TAG
500#define FT_ENC_TAG( value, a, b, c, d )         \
501          value = ( ( (FT_UInt32)(a) << 24 ) |  \
502                    ( (FT_UInt32)(b) << 16 ) |  \
503                    ( (FT_UInt32)(c) <<  8 ) |  \
504                      (FT_UInt32)(d)         )
505
506#endif /* FT_ENC_TAG */
507
508
509  /*************************************************************************/
510  /*                                                                       */
511  /* <Enum>                                                                */
512  /*    FT_Encoding                                                        */
513  /*                                                                       */
514  /* <Description>                                                         */
515  /*    An enumeration used to specify character sets supported by         */
516  /*    charmaps.  Used in the @FT_Select_Charmap API function.            */
517  /*                                                                       */
518  /* <Note>                                                                */
519  /*    Despite the name, this enumeration lists specific character        */
520  /*    repertories (i.e., charsets), and not text encoding methods (e.g., */
521  /*    UTF-8, UTF-16, GB2312_EUC, etc.).                                  */
522  /*                                                                       */
523  /*    Because of 32-bit charcodes defined in Unicode (i.e., surrogates), */
524  /*    all character codes must be expressed as FT_Longs.                 */
525  /*                                                                       */
526  /*    Other encodings might be defined in the future.                    */
527  /*                                                                       */
528  /* <Values>                                                              */
529  /*   FT_ENCODING_NONE ::                                                 */
530  /*     The encoding value~0 is reserved.                                 */
531  /*                                                                       */
532  /*   FT_ENCODING_UNICODE ::                                              */
533  /*     Corresponds to the Unicode character set.  This value covers      */
534  /*     all versions of the Unicode repertoire, including ASCII and       */
535  /*     Latin-1.  Most fonts include a Unicode charmap, but not all       */
536  /*     of them.                                                          */
537  /*                                                                       */
538  /*   FT_ENCODING_MS_SYMBOL ::                                            */
539  /*     Corresponds to the Microsoft Symbol encoding, used to encode      */
540  /*     mathematical symbols in the 32..255 character code range.  For    */
541  /*     more information, see `http://www.ceviz.net/symbol.htm'.          */
542  /*                                                                       */
543  /*   FT_ENCODING_SJIS ::                                                 */
544  /*     Corresponds to Japanese SJIS encoding.  More info at              */
545  /*     at `http://langsupport.japanreference.com/encoding.shtml'.        */
546  /*     See note on multi-byte encodings below.                           */
547  /*                                                                       */
548  /*   FT_ENCODING_GB2312 ::                                               */
549  /*     Corresponds to an encoding system for Simplified Chinese as used  */
550  /*     used in mainland China.                                           */
551  /*                                                                       */
552  /*   FT_ENCODING_BIG5 ::                                                 */
553  /*     Corresponds to an encoding system for Traditional Chinese as used */
554  /*     in Taiwan and Hong Kong.                                          */
555  /*                                                                       */
556  /*   FT_ENCODING_WANSUNG ::                                              */
557  /*     Corresponds to the Korean encoding system known as Wansung.       */
558  /*     For more information see                                          */
559  /*     `http://www.microsoft.com/typography/unicode/949.txt'.            */
560  /*                                                                       */
561  /*   FT_ENCODING_JOHAB ::                                                */
562  /*     The Korean standard character set (KS~C 5601-1992), which         */
563  /*     corresponds to MS Windows code page 1361.  This character set     */
564  /*     includes all possible Hangeul character combinations.             */
565  /*                                                                       */
566  /*   FT_ENCODING_ADOBE_LATIN_1 ::                                        */
567  /*     Corresponds to a Latin-1 encoding as defined in a Type~1          */
568  /*     PostScript font.  It is limited to 256 character codes.           */
569  /*                                                                       */
570  /*   FT_ENCODING_ADOBE_STANDARD ::                                       */
571  /*     Corresponds to the Adobe Standard encoding, as found in Type~1,   */
572  /*     CFF, and OpenType/CFF fonts.  It is limited to 256 character      */
573  /*     codes.                                                            */
574  /*                                                                       */
575  /*   FT_ENCODING_ADOBE_EXPERT ::                                         */
576  /*     Corresponds to the Adobe Expert encoding, as found in Type~1,     */
577  /*     CFF, and OpenType/CFF fonts.  It is limited to 256 character      */
578  /*     codes.                                                            */
579  /*                                                                       */
580  /*   FT_ENCODING_ADOBE_CUSTOM ::                                         */
581  /*     Corresponds to a custom encoding, as found in Type~1, CFF, and    */
582  /*     OpenType/CFF fonts.  It is limited to 256 character codes.        */
583  /*                                                                       */
584  /*   FT_ENCODING_APPLE_ROMAN ::                                          */
585  /*     Corresponds to the 8-bit Apple roman encoding.  Many TrueType and */
586  /*     OpenType fonts contain a charmap for this encoding, since older   */
587  /*     versions of Mac OS are able to use it.                            */
588  /*                                                                       */
589  /*   FT_ENCODING_OLD_LATIN_2 ::                                          */
590  /*     This value is deprecated and was never used nor reported by       */
591  /*     FreeType.  Don't use or test for it.                              */
592  /*                                                                       */
593  /*   FT_ENCODING_MS_SJIS ::                                              */
594  /*     Same as FT_ENCODING_SJIS.  Deprecated.                            */
595  /*                                                                       */
596  /*   FT_ENCODING_MS_GB2312 ::                                            */
597  /*     Same as FT_ENCODING_GB2312.  Deprecated.                          */
598  /*                                                                       */
599  /*   FT_ENCODING_MS_BIG5 ::                                              */
600  /*     Same as FT_ENCODING_BIG5.  Deprecated.                            */
601  /*                                                                       */
602  /*   FT_ENCODING_MS_WANSUNG ::                                           */
603  /*     Same as FT_ENCODING_WANSUNG.  Deprecated.                         */
604  /*                                                                       */
605  /*   FT_ENCODING_MS_JOHAB ::                                             */
606  /*     Same as FT_ENCODING_JOHAB.  Deprecated.                           */
607  /*                                                                       */
608  /* <Note>                                                                */
609  /*   By default, FreeType automatically synthetizes a Unicode charmap    */
610  /*   for PostScript fonts, using their glyph names dictionaries.         */
611  /*   However, it also reports the encodings defined explicitly in the    */
612  /*   font file, for the cases when they are needed, with the Adobe       */
613  /*   values as well.                                                     */
614  /*                                                                       */
615  /*   FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap   */
616  /*   is neither Unicode nor ISO-8859-1 (otherwise it is set to           */
617  /*   FT_ENCODING_UNICODE).  Use @FT_Get_BDF_Charset_ID to find out which */
618  /*   encoding is really present.  If, for example, the `cs_registry'     */
619  /*   field is `KOI8' and the `cs_encoding' field is `R', the font is     */
620  /*   encoded in KOI8-R.                                                  */
621  /*                                                                       */
622  /*   FT_ENCODING_NONE is always set (with a single exception) by the     */
623  /*   winfonts driver.  Use @FT_Get_WinFNT_Header and examine the         */
624  /*   `charset' field of the @FT_WinFNT_HeaderRec structure to find out   */
625  /*   which encoding is really present.  For example,                     */
626  /*   @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for        */
627  /*   Russian).                                                           */
628  /*                                                                       */
629  /*   FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH  */
630  /*   and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to   */
631  /*   FT_ENCODING_APPLE_ROMAN).                                           */
632  /*                                                                       */
633  /*   If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function        */
634  /*   @FT_Get_CMap_Language_ID  to query the Mac language ID which may be */
635  /*   needed to be able to distinguish Apple encoding variants.  See      */
636  /*                                                                       */
637  /*     http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/README.TXT   */
638  /*                                                                       */
639  /*   to get an idea how to do that.  Basically, if the language ID is~0, */
640  /*   don't use it, otherwise subtract 1 from the language ID.  Then      */
641  /*   examine `encoding_id'.  If, for example, `encoding_id' is           */
642  /*   @TT_MAC_ID_ROMAN and the language ID (minus~1) is                   */
643  /*   `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman.         */
644  /*   @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi        */
645  /*   variant the Arabic encoding.                                        */
646  /*                                                                       */
647  typedef enum  FT_Encoding_
648  {
649    FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ),
650
651    FT_ENC_TAG( FT_ENCODING_MS_SYMBOL, 's', 'y', 'm', 'b' ),
652    FT_ENC_TAG( FT_ENCODING_UNICODE,   'u', 'n', 'i', 'c' ),
653
654    FT_ENC_TAG( FT_ENCODING_SJIS,    's', 'j', 'i', 's' ),
655    FT_ENC_TAG( FT_ENCODING_GB2312,  'g', 'b', ' ', ' ' ),
656    FT_ENC_TAG( FT_ENCODING_BIG5,    'b', 'i', 'g', '5' ),
657    FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ),
658    FT_ENC_TAG( FT_ENCODING_JOHAB,   'j', 'o', 'h', 'a' ),
659
660    /* for backwards compatibility */
661    FT_ENCODING_MS_SJIS    = FT_ENCODING_SJIS,
662    FT_ENCODING_MS_GB2312  = FT_ENCODING_GB2312,
663    FT_ENCODING_MS_BIG5    = FT_ENCODING_BIG5,
664    FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG,
665    FT_ENCODING_MS_JOHAB   = FT_ENCODING_JOHAB,
666
667    FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD, 'A', 'D', 'O', 'B' ),
668    FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT,   'A', 'D', 'B', 'E' ),
669    FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM,   'A', 'D', 'B', 'C' ),
670    FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1,  'l', 'a', 't', '1' ),
671
672    FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2, 'l', 'a', 't', '2' ),
673
674    FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' )
675
676  } FT_Encoding;
677
678
679  /*************************************************************************/
680  /*                                                                       */
681  /* <Enum>                                                                */
682  /*    ft_encoding_xxx                                                    */
683  /*                                                                       */
684  /* <Description>                                                         */
685  /*    These constants are deprecated; use the corresponding @FT_Encoding */
686  /*    values instead.                                                    */
687  /*                                                                       */
688#define ft_encoding_none            FT_ENCODING_NONE
689#define ft_encoding_unicode         FT_ENCODING_UNICODE
690#define ft_encoding_symbol          FT_ENCODING_MS_SYMBOL
691#define ft_encoding_latin_1         FT_ENCODING_ADOBE_LATIN_1
692#define ft_encoding_latin_2         FT_ENCODING_OLD_LATIN_2
693#define ft_encoding_sjis            FT_ENCODING_SJIS
694#define ft_encoding_gb2312          FT_ENCODING_GB2312
695#define ft_encoding_big5            FT_ENCODING_BIG5
696#define ft_encoding_wansung         FT_ENCODING_WANSUNG
697#define ft_encoding_johab           FT_ENCODING_JOHAB
698
699#define ft_encoding_adobe_standard  FT_ENCODING_ADOBE_STANDARD
700#define ft_encoding_adobe_expert    FT_ENCODING_ADOBE_EXPERT
701#define ft_encoding_adobe_custom    FT_ENCODING_ADOBE_CUSTOM
702#define ft_encoding_apple_roman     FT_ENCODING_APPLE_ROMAN
703
704
705  /*************************************************************************/
706  /*                                                                       */
707  /* <Struct>                                                              */
708  /*    FT_CharMapRec                                                      */
709  /*                                                                       */
710  /* <Description>                                                         */
711  /*    The base charmap structure.                                        */
712  /*                                                                       */
713  /* <Fields>                                                              */
714  /*    face        :: A handle to the parent face object.                 */
715  /*                                                                       */
716  /*    encoding    :: An @FT_Encoding tag identifying the charmap.  Use   */
717  /*                   this with @FT_Select_Charmap.                       */
718  /*                                                                       */
719  /*    platform_id :: An ID number describing the platform for the        */
720  /*                   following encoding ID.  This comes directly from    */
721  /*                   the TrueType specification and should be emulated   */
722  /*                   for other formats.                                  */
723  /*                                                                       */
724  /*    encoding_id :: A platform specific encoding number.  This also     */
725  /*                   comes from the TrueType specification and should be */
726  /*                   emulated similarly.                                 */
727  /*                                                                       */
728  typedef struct  FT_CharMapRec_
729  {
730    FT_Face      face;
731    FT_Encoding  encoding;
732    FT_UShort    platform_id;
733    FT_UShort    encoding_id;
734
735  } FT_CharMapRec;
736
737
738  /*************************************************************************/
739  /*************************************************************************/
740  /*                                                                       */
741  /*                 B A S E   O B J E C T   C L A S S E S                 */
742  /*                                                                       */
743  /*************************************************************************/
744  /*************************************************************************/
745
746
747  /*************************************************************************/
748  /*                                                                       */
749  /* <Type>                                                                */
750  /*    FT_Face_Internal                                                   */
751  /*                                                                       */
752  /* <Description>                                                         */
753  /*    An opaque handle to an `FT_Face_InternalRec' structure, used to    */
754  /*    model private data of a given @FT_Face object.                     */
755  /*                                                                       */
756  /*    This structure might change between releases of FreeType~2 and is  */
757  /*    not generally available to client applications.                    */
758  /*                                                                       */
759  typedef struct FT_Face_InternalRec_*  FT_Face_Internal;
760
761
762  /*************************************************************************/
763  /*                                                                       */
764  /* <Struct>                                                              */
765  /*    FT_FaceRec                                                         */
766  /*                                                                       */
767  /* <Description>                                                         */
768  /*    FreeType root face class structure.  A face object models a        */
769  /*    typeface in a font file.                                           */
770  /*                                                                       */
771  /* <Fields>                                                              */
772  /*    num_faces           :: The number of faces in the font file.  Some */
773  /*                           font formats can have multiple faces in     */
774  /*                           a font file.                                */
775  /*                                                                       */
776  /*    face_index          :: The index of the face in the font file.  It */
777  /*                           is set to~0 if there is only one face in    */
778  /*                           the font file.                              */
779  /*                                                                       */
780  /*    face_flags          :: A set of bit flags that give important      */
781  /*                           information about the face; see             */
782  /*                           @FT_FACE_FLAG_XXX for the details.          */
783  /*                                                                       */
784  /*    style_flags         :: A set of bit flags indicating the style of  */
785  /*                           the face; see @FT_STYLE_FLAG_XXX for the    */
786  /*                           details.                                    */
787  /*                                                                       */
788  /*    num_glyphs          :: The number of glyphs in the face.  If the   */
789  /*                           face is scalable and has sbits (see         */
790  /*                           `num_fixed_sizes'), it is set to the number */
791  /*                           of outline glyphs.                          */
792  /*                                                                       */
793  /*                           For CID-keyed fonts, this value gives the   */
794  /*                           highest CID used in the font.               */
795  /*                                                                       */
796  /*    family_name         :: The face's family name.  This is an ASCII   */
797  /*                           string, usually in English, which describes */
798  /*                           the typeface's family (like `Times New      */
799  /*                           Roman', `Bodoni', `Garamond', etc).  This   */
800  /*                           is a least common denominator used to list  */
801  /*                           fonts.  Some formats (TrueType & OpenType)  */
802  /*                           provide localized and Unicode versions of   */
803  /*                           this string.  Applications should use the   */
804  /*                           format specific interface to access them.   */
805  /*                           Can be NULL (e.g., in fonts embedded in a   */
806  /*                           PDF file).                                  */
807  /*                                                                       */
808  /*    style_name          :: The face's style name.  This is an ASCII    */
809  /*                           string, usually in English, which describes */
810  /*                           the typeface's style (like `Italic',        */
811  /*                           `Bold', `Condensed', etc).  Not all font    */
812  /*                           formats provide a style name, so this field */
813  /*                           is optional, and can be set to NULL.  As    */
814  /*                           for `family_name', some formats provide     */
815  /*                           localized and Unicode versions of this      */
816  /*                           string.  Applications should use the format */
817  /*                           specific interface to access them.          */
818  /*                                                                       */
819  /*    num_fixed_sizes     :: The number of bitmap strikes in the face.   */
820  /*                           Even if the face is scalable, there might   */
821  /*                           still be bitmap strikes, which are called   */
822  /*                           `sbits' in that case.                       */
823  /*                                                                       */
824  /*    available_sizes     :: An array of @FT_Bitmap_Size for all bitmap  */
825  /*                           strikes in the face.  It is set to NULL if  */
826  /*                           there is no bitmap strike.                  */
827  /*                                                                       */
828  /*    num_charmaps        :: The number of charmaps in the face.         */
829  /*                                                                       */
830  /*    charmaps            :: An array of the charmaps of the face.       */
831  /*                                                                       */
832  /*    generic             :: A field reserved for client uses.  See the  */
833  /*                           @FT_Generic type description.               */
834  /*                                                                       */
835  /*    bbox                :: The font bounding box.  Coordinates are     */
836  /*                           expressed in font units (see                */
837  /*                           `units_per_EM').  The box is large enough   */
838  /*                           to contain any glyph from the font.  Thus,  */
839  /*                           `bbox.yMax' can be seen as the `maximal     */
840  /*                           ascender', and `bbox.yMin' as the `minimal  */
841  /*                           descender'.  Only relevant for scalable     */
842  /*                           formats.                                    */
843  /*                                                                       */
844  /*                           Note that the bounding box might be off by  */
845  /*                           (at least) one pixel for hinted fonts.  See */
846  /*                           @FT_Size_Metrics for further discussion.    */
847  /*                                                                       */
848  /*    units_per_EM        :: The number of font units per EM square for  */
849  /*                           this face.  This is typically 2048 for      */
850  /*                           TrueType fonts, and 1000 for Type~1 fonts.  */
851  /*                           Only relevant for scalable formats.         */
852  /*                                                                       */
853  /*    ascender            :: The typographic ascender of the face,       */
854  /*                           expressed in font units.  For font formats  */
855  /*                           not having this information, it is set to   */
856  /*                           `bbox.yMax'.  Only relevant for scalable    */
857  /*                           formats.                                    */
858  /*                                                                       */
859  /*    descender           :: The typographic descender of the face,      */
860  /*                           expressed in font units.  For font formats  */
861  /*                           not having this information, it is set to   */
862  /*                           `bbox.yMin'.  Note that this field is       */
863  /*                           usually negative.  Only relevant for        */
864  /*                           scalable formats.                           */
865  /*                                                                       */
866  /*    height              :: The height is the vertical distance         */
867  /*                           between two consecutive baselines,          */
868  /*                           expressed in font units.  It is always      */
869  /*                           positive.  Only relevant for scalable       */
870  /*                           formats.                                    */
871  /*                                                                       */
872  /*    max_advance_width   :: The maximal advance width, in font units,   */
873  /*                           for all glyphs in this face.  This can be   */
874  /*                           used to make word wrapping computations     */
875  /*                           faster.  Only relevant for scalable         */
876  /*                           formats.                                    */
877  /*                                                                       */
878  /*    max_advance_height  :: The maximal advance height, in font units,  */
879  /*                           for all glyphs in this face.  This is only  */
880  /*                           relevant for vertical layouts, and is set   */
881  /*                           to `height' for fonts that do not provide   */
882  /*                           vertical metrics.  Only relevant for        */
883  /*                           scalable formats.                           */
884  /*                                                                       */
885  /*    underline_position  :: The position, in font units, of the         */
886  /*                           underline line for this face.  It's the     */
887  /*                           center of the underlining stem.  Only       */
888  /*                           relevant for scalable formats.              */
889  /*                                                                       */
890  /*    underline_thickness :: The thickness, in font units, of the        */
891  /*                           underline for this face.  Only relevant for */
892  /*                           scalable formats.                           */
893  /*                                                                       */
894  /*    glyph               :: The face's associated glyph slot(s).        */
895  /*                                                                       */
896  /*    size                :: The current active size for this face.      */
897  /*                                                                       */
898  /*    charmap             :: The current active charmap for this face.   */
899  /*                                                                       */
900  /* <Note>                                                                */
901  /*   Fields may be changed after a call to @FT_Attach_File or            */
902  /*   @FT_Attach_Stream.                                                  */
903  /*                                                                       */
904  typedef struct  FT_FaceRec_
905  {
906    FT_Long           num_faces;
907    FT_Long           face_index;
908
909    FT_Long           face_flags;
910    FT_Long           style_flags;
911
912    FT_Long           num_glyphs;
913
914    FT_String*        family_name;
915    FT_String*        style_name;
916
917    FT_Int            num_fixed_sizes;
918    FT_Bitmap_Size*   available_sizes;
919
920    FT_Int            num_charmaps;
921    FT_CharMap*       charmaps;
922
923    FT_Generic        generic;
924
925    /*# The following member variables (down to `underline_thickness') */
926    /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size    */
927    /*# for bitmap fonts.                                              */
928    FT_BBox           bbox;
929
930    FT_UShort         units_per_EM;
931    FT_Short          ascender;
932    FT_Short          descender;
933    FT_Short          height;
934
935    FT_Short          max_advance_width;
936    FT_Short          max_advance_height;
937
938    FT_Short          underline_position;
939    FT_Short          underline_thickness;
940
941    FT_GlyphSlot      glyph;
942    FT_Size           size;
943    FT_CharMap        charmap;
944
945    /*@private begin */
946
947    FT_Driver         driver;
948    FT_Memory         memory;
949    FT_Stream         stream;
950
951    FT_ListRec        sizes_list;
952
953    FT_Generic        autohint;
954    void*             extensions;
955
956    FT_Face_Internal  internal;
957
958    /*@private end */
959
960  } FT_FaceRec;
961
962
963  /*************************************************************************/
964  /*                                                                       */
965  /* <Enum>                                                                */
966  /*    FT_FACE_FLAG_XXX                                                   */
967  /*                                                                       */
968  /* <Description>                                                         */
969  /*    A list of bit flags used in the `face_flags' field of the          */
970  /*    @FT_FaceRec structure.  They inform client applications of         */
971  /*    properties of the corresponding face.                              */
972  /*                                                                       */
973  /* <Values>                                                              */
974  /*    FT_FACE_FLAG_SCALABLE ::                                           */
975  /*      Indicates that the face contains outline glyphs.  This doesn't   */
976  /*      prevent bitmap strikes, i.e., a face can have both this and      */
977  /*      and @FT_FACE_FLAG_FIXED_SIZES set.                               */
978  /*                                                                       */
979  /*    FT_FACE_FLAG_FIXED_SIZES ::                                        */
980  /*      Indicates that the face contains bitmap strikes.  See also the   */
981  /*      `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec.   */
982  /*                                                                       */
983  /*    FT_FACE_FLAG_FIXED_WIDTH ::                                        */
984  /*      Indicates that the face contains fixed-width characters (like    */
985  /*      Courier, Lucido, MonoType, etc.).                                */
986  /*                                                                       */
987  /*    FT_FACE_FLAG_SFNT ::                                               */
988  /*      Indicates that the face uses the `sfnt' storage scheme.  For     */
989  /*      now, this means TrueType and OpenType.                           */
990  /*                                                                       */
991  /*    FT_FACE_FLAG_HORIZONTAL ::                                         */
992  /*      Indicates that the face contains horizontal glyph metrics.  This */
993  /*      should be set for all common formats.                            */
994  /*                                                                       */
995  /*    FT_FACE_FLAG_VERTICAL ::                                           */
996  /*      Indicates that the face contains vertical glyph metrics.  This   */
997  /*      is only available in some formats, not all of them.              */
998  /*                                                                       */
999  /*    FT_FACE_FLAG_KERNING ::                                            */
1000  /*      Indicates that the face contains kerning information.  If set,   */
1001  /*      the kerning distance can be retrieved through the function       */
1002  /*      @FT_Get_Kerning.  Otherwise the function always return the       */
1003  /*      vector (0,0).  Note that FreeType doesn't handle kerning data    */
1004  /*      from the `GPOS' table (as present in some OpenType fonts).       */
1005  /*                                                                       */
1006  /*    FT_FACE_FLAG_FAST_GLYPHS ::                                        */
1007  /*      THIS FLAG IS DEPRECATED.  DO NOT USE OR TEST IT.                 */
1008  /*                                                                       */
1009  /*    FT_FACE_FLAG_MULTIPLE_MASTERS ::                                   */
1010  /*      Indicates that the font contains multiple masters and is capable */
1011  /*      of interpolating between them.  See the multiple-masters         */
1012  /*      specific API for details.                                        */
1013  /*                                                                       */
1014  /*    FT_FACE_FLAG_GLYPH_NAMES ::                                        */
1015  /*      Indicates that the font contains glyph names that can be         */
1016  /*      retrieved through @FT_Get_Glyph_Name.  Note that some TrueType   */
1017  /*      fonts contain broken glyph name tables.  Use the function        */
1018  /*      @FT_Has_PS_Glyph_Names when needed.                              */
1019  /*                                                                       */
1020  /*    FT_FACE_FLAG_EXTERNAL_STREAM ::                                    */
1021  /*      Used internally by FreeType to indicate that a face's stream was */
1022  /*      provided by the client application and should not be destroyed   */
1023  /*      when @FT_Done_Face is called.  Don't read or test this flag.     */
1024  /*                                                                       */
1025  /*    FT_FACE_FLAG_HINTER ::                                             */
1026  /*      Set if the font driver has a hinting machine of its own.  For    */
1027  /*      example, with TrueType fonts, it makes sense to use data from    */
1028  /*      the SFNT `gasp' table only if the native TrueType hinting engine */
1029  /*      (with the bytecode interpreter) is available and active.         */
1030  /*                                                                       */
1031  /*    FT_FACE_FLAG_CID_KEYED ::                                          */
1032  /*      Set if the font is CID-keyed.  In that case, the font is not     */
1033  /*      accessed by glyph indices but by CID values.  For subsetted      */
1034  /*      CID-keyed fonts this has the consequence that not all index      */
1035  /*      values are a valid argument to FT_Load_Glyph.  Only the CID      */
1036  /*      values for which corresponding glyphs in the subsetted font      */
1037  /*      exist make FT_Load_Glyph return successfully; in all other cases */
1038  /*      you get an `FT_Err_Invalid_Argument' error.                      */
1039  /*                                                                       */
1040#define FT_FACE_FLAG_SCALABLE          ( 1L <<  0 )
1041#define FT_FACE_FLAG_FIXED_SIZES       ( 1L <<  1 )
1042#define FT_FACE_FLAG_FIXED_WIDTH       ( 1L <<  2 )
1043#define FT_FACE_FLAG_SFNT              ( 1L <<  3 )
1044#define FT_FACE_FLAG_HORIZONTAL        ( 1L <<  4 )
1045#define FT_FACE_FLAG_VERTICAL          ( 1L <<  5 )
1046#define FT_FACE_FLAG_KERNING           ( 1L <<  6 )
1047#define FT_FACE_FLAG_FAST_GLYPHS       ( 1L <<  7 )
1048#define FT_FACE_FLAG_MULTIPLE_MASTERS  ( 1L <<  8 )
1049#define FT_FACE_FLAG_GLYPH_NAMES       ( 1L <<  9 )
1050#define FT_FACE_FLAG_EXTERNAL_STREAM   ( 1L << 10 )
1051#define FT_FACE_FLAG_HINTER            ( 1L << 11 )
1052#define FT_FACE_FLAG_CID_KEYED         ( 1L << 12 )
1053
1054  /* */
1055
1056
1057  /*************************************************************************
1058   *
1059   * @macro:
1060   *   FT_HAS_HORIZONTAL( face )
1061   *
1062   * @description:
1063   *   A macro that returns true whenever a face object contains
1064   *   horizontal metrics (this is true for all font formats though).
1065   *
1066   * @also:
1067   *   @FT_HAS_VERTICAL can be used to check for vertical metrics.
1068   *
1069   */
1070#define FT_HAS_HORIZONTAL( face ) \
1071          ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
1072
1073
1074  /*************************************************************************
1075   *
1076   * @macro:
1077   *   FT_HAS_VERTICAL( face )
1078   *
1079   * @description:
1080   *   A macro that returns true whenever a face object contains vertical
1081   *   metrics.
1082   *
1083   */
1084#define FT_HAS_VERTICAL( face ) \
1085          ( face->face_flags & FT_FACE_FLAG_VERTICAL )
1086
1087
1088  /*************************************************************************
1089   *
1090   * @macro:
1091   *   FT_HAS_KERNING( face )
1092   *
1093   * @description:
1094   *   A macro that returns true whenever a face object contains kerning
1095   *   data that can be accessed with @FT_Get_Kerning.
1096   *
1097   */
1098#define FT_HAS_KERNING( face ) \
1099          ( face->face_flags & FT_FACE_FLAG_KERNING )
1100
1101
1102  /*************************************************************************
1103   *
1104   * @macro:
1105   *   FT_IS_SCALABLE( face )
1106   *
1107   * @description:
1108   *   A macro that returns true whenever a face object contains a scalable
1109   *   font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF,
1110   *   and PFR font formats.
1111   *
1112   */
1113#define FT_IS_SCALABLE( face ) \
1114          ( face->face_flags & FT_FACE_FLAG_SCALABLE )
1115
1116
1117  /*************************************************************************
1118   *
1119   * @macro:
1120   *   FT_IS_SFNT( face )
1121   *
1122   * @description:
1123   *   A macro that returns true whenever a face object contains a font
1124   *   whose format is based on the SFNT storage scheme.  This usually
1125   *   means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded
1126   *   bitmap fonts.
1127   *
1128   *   If this macro is true, all functions defined in @FT_SFNT_NAMES_H and
1129   *   @FT_TRUETYPE_TABLES_H are available.
1130   *
1131   */
1132#define FT_IS_SFNT( face ) \
1133          ( face->face_flags & FT_FACE_FLAG_SFNT )
1134
1135
1136  /*************************************************************************
1137   *
1138   * @macro:
1139   *   FT_IS_FIXED_WIDTH( face )
1140   *
1141   * @description:
1142   *   A macro that returns true whenever a face object contains a font face
1143   *   that contains fixed-width (or `monospace', `fixed-pitch', etc.)
1144   *   glyphs.
1145   *
1146   */
1147#define FT_IS_FIXED_WIDTH( face ) \
1148          ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
1149
1150
1151  /*************************************************************************
1152   *
1153   * @macro:
1154   *   FT_HAS_FIXED_SIZES( face )
1155   *
1156   * @description:
1157   *   A macro that returns true whenever a face object contains some
1158   *   embedded bitmaps.  See the `available_sizes' field of the
1159   *   @FT_FaceRec structure.
1160   *
1161   */
1162#define FT_HAS_FIXED_SIZES( face ) \
1163          ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
1164
1165  /* */
1166
1167
1168  /*************************************************************************
1169   *
1170   * @macro:
1171   *   FT_HAS_FAST_GLYPHS( face )
1172   *
1173   * @description:
1174   *   Deprecated.
1175   *
1176   */
1177#define FT_HAS_FAST_GLYPHS( face )  0
1178
1179
1180  /*************************************************************************
1181   *
1182   * @macro:
1183   *   FT_HAS_GLYPH_NAMES( face )
1184   *
1185   * @description:
1186   *   A macro that returns true whenever a face object contains some glyph
1187   *   names that can be accessed through @FT_Get_Glyph_Name.
1188   *
1189   */
1190#define FT_HAS_GLYPH_NAMES( face ) \
1191          ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
1192
1193
1194  /*************************************************************************
1195   *
1196   * @macro:
1197   *   FT_HAS_MULTIPLE_MASTERS( face )
1198   *
1199   * @description:
1200   *   A macro that returns true whenever a face object contains some
1201   *   multiple masters.  The functions provided by @FT_MULTIPLE_MASTERS_H
1202   *   are then available to choose the exact design you want.
1203   *
1204   */
1205#define FT_HAS_MULTIPLE_MASTERS( face ) \
1206          ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
1207
1208
1209  /*************************************************************************
1210   *
1211   * @macro:
1212   *   FT_IS_CID_KEYED( face )
1213   *
1214   * @description:
1215   *   A macro that returns true whenever a face object contains a CID-keyed
1216   *   font.  See the discussion of @FT_FACE_FLAG_CID_KEYED for more
1217   *   details.
1218   *
1219   *   If this macro is true, all functions defined in @FT_CID_H are
1220   *   available.
1221   *
1222   */
1223#define FT_IS_CID_KEYED( face ) \
1224          ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
1225
1226
1227  /*************************************************************************/
1228  /*                                                                       */
1229  /* <Constant>                                                            */
1230  /*    FT_STYLE_FLAG_XXX                                                  */
1231  /*                                                                       */
1232  /* <Description>                                                         */
1233  /*    A list of bit-flags used to indicate the style of a given face.    */
1234  /*    These are used in the `style_flags' field of @FT_FaceRec.          */
1235  /*                                                                       */
1236  /* <Values>                                                              */
1237  /*    FT_STYLE_FLAG_ITALIC ::                                            */
1238  /*      Indicates that a given face style is italic or oblique.          */
1239  /*                                                                       */
1240  /*    FT_STYLE_FLAG_BOLD ::                                              */
1241  /*      Indicates that a given face is bold.                             */
1242  /*                                                                       */
1243  /* <Note>                                                                */
1244  /*    The style information as provided by FreeType is very basic.  More */
1245  /*    details are beyond the scope and should be done on a higher level  */
1246  /*    (for example, by analyzing various fields of the `OS/2' table in   */
1247  /*    SFNT based fonts).                                                 */
1248  /*                                                                       */
1249#define FT_STYLE_FLAG_ITALIC  ( 1 << 0 )
1250#define FT_STYLE_FLAG_BOLD    ( 1 << 1 )
1251
1252
1253  /*************************************************************************/
1254  /*                                                                       */
1255  /* <Type>                                                                */
1256  /*    FT_Size_Internal                                                   */
1257  /*                                                                       */
1258  /* <Description>                                                         */
1259  /*    An opaque handle to an `FT_Size_InternalRec' structure, used to    */
1260  /*    model private data of a given @FT_Size object.                     */
1261  /*                                                                       */
1262  typedef struct FT_Size_InternalRec_*  FT_Size_Internal;
1263
1264
1265  /*************************************************************************/
1266  /*                                                                       */
1267  /* <Struct>                                                              */
1268  /*    FT_Size_Metrics                                                    */
1269  /*                                                                       */
1270  /* <Description>                                                         */
1271  /*    The size metrics structure gives the metrics of a size object.     */
1272  /*                                                                       */
1273  /* <Fields>                                                              */
1274  /*    x_ppem       :: The width of the scaled EM square in pixels, hence */
1275  /*                    the term `ppem' (pixels per EM).  It is also       */
1276  /*                    referred to as `nominal width'.                    */
1277  /*                                                                       */
1278  /*    y_ppem       :: The height of the scaled EM square in pixels,      */
1279  /*                    hence the term `ppem' (pixels per EM).  It is also */
1280  /*                    referred to as `nominal height'.                   */
1281  /*                                                                       */
1282  /*    x_scale      :: A 16.16 fractional scaling value used to convert   */
1283  /*                    horizontal metrics from font units to 26.6         */
1284  /*                    fractional pixels.  Only relevant for scalable     */
1285  /*                    font formats.                                      */
1286  /*                                                                       */
1287  /*    y_scale      :: A 16.16 fractional scaling value used to convert   */
1288  /*                    vertical metrics from font units to 26.6           */
1289  /*                    fractional pixels.  Only relevant for scalable     */
1290  /*                    font formats.                                      */
1291  /*                                                                       */
1292  /*    ascender     :: The ascender in 26.6 fractional pixels.  See       */
1293  /*                    @FT_FaceRec for the details.                       */
1294  /*                                                                       */
1295  /*    descender    :: The descender in 26.6 fractional pixels.  See      */
1296  /*                    @FT_FaceRec for the details.                       */
1297  /*                                                                       */
1298  /*    height       :: The height in 26.6 fractional pixels.  See         */
1299  /*                    @FT_FaceRec for the details.                       */
1300  /*                                                                       */
1301  /*    max_advance  :: The maximal advance width in 26.6 fractional       */
1302  /*                    pixels.  See @FT_FaceRec for the details.          */
1303  /*                                                                       */
1304  /* <Note>                                                                */
1305  /*    The scaling values, if relevant, are determined first during a     */
1306  /*    size changing operation.  The remaining fields are then set by the */
1307  /*    driver.  For scalable formats, they are usually set to scaled      */
1308  /*    values of the corresponding fields in @FT_FaceRec.                 */
1309  /*                                                                       */
1310  /*    Note that due to glyph hinting, these values might not be exact    */
1311  /*    for certain fonts.  Thus they must be treated as unreliable        */
1312  /*    with an error margin of at least one pixel!                        */
1313  /*                                                                       */
1314  /*    Indeed, the only way to get the exact metrics is to render _all_   */
1315  /*    glyphs.  As this would be a definite performance hit, it is up to  */
1316  /*    client applications to perform such computations.                  */
1317  /*                                                                       */
1318  /*    The FT_Size_Metrics structure is valid for bitmap fonts also.      */
1319  /*                                                                       */
1320  typedef struct  FT_Size_Metrics_
1321  {
1322    FT_UShort  x_ppem;      /* horizontal pixels per EM               */
1323    FT_UShort  y_ppem;      /* vertical pixels per EM                 */
1324
1325    FT_Fixed   x_scale;     /* scaling values used to convert font    */
1326    FT_Fixed   y_scale;     /* units to 26.6 fractional pixels        */
1327
1328    FT_Pos     ascender;    /* ascender in 26.6 frac. pixels          */
1329    FT_Pos     descender;   /* descender in 26.6 frac. pixels         */
1330    FT_Pos     height;      /* text height in 26.6 frac. pixels       */
1331    FT_Pos     max_advance; /* max horizontal advance, in 26.6 pixels */
1332
1333  } FT_Size_Metrics;
1334
1335
1336  /*************************************************************************/
1337  /*                                                                       */
1338  /* <Struct>                                                              */
1339  /*    FT_SizeRec                                                         */
1340  /*                                                                       */
1341  /* <Description>                                                         */
1342  /*    FreeType root size class structure.  A size object models a face   */
1343  /*    object at a given size.                                            */
1344  /*                                                                       */
1345  /* <Fields>                                                              */
1346  /*    face    :: Handle to the parent face object.                       */
1347  /*                                                                       */
1348  /*    generic :: A typeless pointer, which is unused by the FreeType     */
1349  /*               library or any of its drivers.  It can be used by       */
1350  /*               client applications to link their own data to each size */
1351  /*               object.                                                 */
1352  /*                                                                       */
1353  /*    metrics :: Metrics for this size object.  This field is read-only. */
1354  /*                                                                       */
1355  typedef struct  FT_SizeRec_
1356  {
1357    FT_Face           face;      /* parent face object              */
1358    FT_Generic        generic;   /* generic pointer for client uses */
1359    FT_Size_Metrics   metrics;   /* size metrics                    */
1360    FT_Size_Internal  internal;
1361
1362  } FT_SizeRec;
1363
1364
1365  /*************************************************************************/
1366  /*                                                                       */
1367  /* <Struct>                                                              */
1368  /*    FT_SubGlyph                                                        */
1369  /*                                                                       */
1370  /* <Description>                                                         */
1371  /*    The subglyph structure is an internal object used to describe      */
1372  /*    subglyphs (for example, in the case of composites).                */
1373  /*                                                                       */
1374  /* <Note>                                                                */
1375  /*    The subglyph implementation is not part of the high-level API,     */
1376  /*    hence the forward structure declaration.                           */
1377  /*                                                                       */
1378  /*    You can however retrieve subglyph information with                 */
1379  /*    @FT_Get_SubGlyph_Info.                                             */
1380  /*                                                                       */
1381  typedef struct FT_SubGlyphRec_*  FT_SubGlyph;
1382
1383
1384  /*************************************************************************/
1385  /*                                                                       */
1386  /* <Type>                                                                */
1387  /*    FT_Slot_Internal                                                   */
1388  /*                                                                       */
1389  /* <Description>                                                         */
1390  /*    An opaque handle to an `FT_Slot_InternalRec' structure, used to    */
1391  /*    model private data of a given @FT_GlyphSlot object.                */
1392  /*                                                                       */
1393  typedef struct FT_Slot_InternalRec_*  FT_Slot_Internal;
1394
1395
1396  /*************************************************************************/
1397  /*                                                                       */
1398  /* <Struct>                                                              */
1399  /*    FT_GlyphSlotRec                                                    */
1400  /*                                                                       */
1401  /* <Description>                                                         */
1402  /*    FreeType root glyph slot class structure.  A glyph slot is a       */
1403  /*    container where individual glyphs can be loaded, be they in        */
1404  /*    outline or bitmap format.                                          */
1405  /*                                                                       */
1406  /* <Fields>                                                              */
1407  /*    library           :: A handle to the FreeType library instance     */
1408  /*                         this slot belongs to.                         */
1409  /*                                                                       */
1410  /*    face              :: A handle to the parent face object.           */
1411  /*                                                                       */
1412  /*    next              :: In some cases (like some font tools), several */
1413  /*                         glyph slots per face object can be a good     */
1414  /*                         thing.  As this is rare, the glyph slots are  */
1415  /*                         listed through a direct, single-linked list   */
1416  /*                         using its `next' field.                       */
1417  /*                                                                       */
1418  /*    generic           :: A typeless pointer which is unused by the     */
1419  /*                         FreeType library or any of its drivers.  It   */
1420  /*                         can be used by client applications to link    */
1421  /*                         their own data to each glyph slot object.     */
1422  /*                                                                       */
1423  /*    metrics           :: The metrics of the last loaded glyph in the   */
1424  /*                         slot.  The returned values depend on the last */
1425  /*                         load flags (see the @FT_Load_Glyph API        */
1426  /*                         function) and can be expressed either in 26.6 */
1427  /*                         fractional pixels or font units.              */
1428  /*                                                                       */
1429  /*                         Note that even when the glyph image is        */
1430  /*                         transformed, the metrics are not.             */
1431  /*                                                                       */
1432  /*    linearHoriAdvance :: The advance width of the unhinted glyph.      */
1433  /*                         Its value is expressed in 16.16 fractional    */
1434  /*                         pixels, unless @FT_LOAD_LINEAR_DESIGN is set  */
1435  /*                         when loading the glyph.  This field can be    */
1436  /*                         important to perform correct WYSIWYG layout.  */
1437  /*                         Only relevant for outline glyphs.             */
1438  /*                                                                       */
1439  /*    linearVertAdvance :: The advance height of the unhinted glyph.     */
1440  /*                         Its value is expressed in 16.16 fractional    */
1441  /*                         pixels, unless @FT_LOAD_LINEAR_DESIGN is set  */
1442  /*                         when loading the glyph.  This field can be    */
1443  /*                         important to perform correct WYSIWYG layout.  */
1444  /*                         Only relevant for outline glyphs.             */
1445  /*                                                                       */
1446  /*    advance           :: This is the transformed advance width for the */
1447  /*                         glyph.                                        */
1448  /*                                                                       */
1449  /*    format            :: This field indicates the format of the image  */
1450  /*                         contained in the glyph slot.  Typically       */
1451  /*                         @FT_GLYPH_FORMAT_BITMAP,                      */
1452  /*                         @FT_GLYPH_FORMAT_OUTLINE, or                  */
1453  /*                         @FT_GLYPH_FORMAT_COMPOSITE, but others are    */
1454  /*                         possible.                                     */
1455  /*                                                                       */
1456  /*    bitmap            :: This field is used as a bitmap descriptor     */
1457  /*                         when the slot format is                       */
1458  /*                         @FT_GLYPH_FORMAT_BITMAP.  Note that the       */
1459  /*                         address and content of the bitmap buffer can  */
1460  /*                         change between calls of @FT_Load_Glyph and a  */
1461  /*                         few other functions.                          */
1462  /*                                                                       */
1463  /*    bitmap_left       :: This is the bitmap's left bearing expressed   */
1464  /*                         in integer pixels.  Of course, this is only   */
1465  /*                         valid if the format is                        */
1466  /*                         @FT_GLYPH_FORMAT_BITMAP.                      */
1467  /*                                                                       */
1468  /*    bitmap_top        :: This is the bitmap's top bearing expressed in */
1469  /*                         integer pixels.  Remember that this is the    */
1470  /*                         distance from the baseline to the top-most    */
1471  /*                         glyph scanline, upwards y~coordinates being   */
1472  /*                         *positive*.                                   */
1473  /*                                                                       */
1474  /*    outline           :: The outline descriptor for the current glyph  */
1475  /*                         image if its format is                        */
1476  /*                         @FT_GLYPH_FORMAT_OUTLINE.  Once a glyph is    */
1477  /*                         loaded, `outline' can be transformed,         */
1478  /*                         distorted, embolded, etc.  However, it must   */
1479  /*                         not be freed.                                 */
1480  /*                                                                       */
1481  /*    num_subglyphs     :: The number of subglyphs in a composite glyph. */
1482  /*                         This field is only valid for the composite    */
1483  /*                         glyph format that should normally only be     */
1484  /*                         loaded with the @FT_LOAD_NO_RECURSE flag.     */
1485  /*                         For now this is internal to FreeType.         */
1486  /*                                                                       */
1487  /*    subglyphs         :: An array of subglyph descriptors for          */
1488  /*                         composite glyphs.  There are `num_subglyphs'  */
1489  /*                         elements in there.  Currently internal to     */
1490  /*                         FreeType.                                     */
1491  /*                                                                       */
1492  /*    control_data      :: Certain font drivers can also return the      */
1493  /*                         control data for a given glyph image (e.g.    */
1494  /*                         TrueType bytecode, Type~1 charstrings, etc.). */
1495  /*                         This field is a pointer to such data.         */
1496  /*                                                                       */
1497  /*    control_len       :: This is the length in bytes of the control    */
1498  /*                         data.                                         */
1499  /*                                                                       */
1500  /*    other             :: Really wicked formats can use this pointer to */
1501  /*                         present their own glyph image to client       */
1502  /*                         applications.  Note that the application      */
1503  /*                         needs to know about the image format.         */
1504  /*                                                                       */
1505  /*    lsb_delta         :: The difference between hinted and unhinted    */
1506  /*                         left side bearing while autohinting is        */
1507  /*                         active.  Zero otherwise.                      */
1508  /*                                                                       */
1509  /*    rsb_delta         :: The difference between hinted and unhinted    */
1510  /*                         right side bearing while autohinting is       */
1511  /*                         active.  Zero otherwise.                      */
1512  /*                                                                       */
1513  /* <Note>                                                                */
1514  /*    If @FT_Load_Glyph is called with default flags (see                */
1515  /*    @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in   */
1516  /*    its native format (e.g., an outline glyph for TrueType and Type~1  */
1517  /*    formats).                                                          */
1518  /*                                                                       */
1519  /*    This image can later be converted into a bitmap by calling         */
1520  /*    @FT_Render_Glyph.  This function finds the current renderer for    */
1521  /*    the native image's format then invokes it.                         */
1522  /*                                                                       */
1523  /*    The renderer is in charge of transforming the native image through */
1524  /*    the slot's face transformation fields, then convert it into a      */
1525  /*    bitmap that is returned in `slot->bitmap'.                         */
1526  /*                                                                       */
1527  /*    Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */
1528  /*    to specify the position of the bitmap relative to the current pen  */
1529  /*    position (e.g., coordinates (0,0) on the baseline).  Of course,    */
1530  /*    `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP.         */
1531  /*                                                                       */
1532  /* <Note>                                                                */
1533  /*    Here a small pseudo code fragment which shows how to use           */
1534  /*    `lsb_delta' and `rsb_delta':                                       */
1535  /*                                                                       */
1536  /*    {                                                                  */
1537  /*      FT_Pos  origin_x       = 0;                                      */
1538  /*      FT_Pos  prev_rsb_delta = 0;                                      */
1539  /*                                                                       */
1540  /*                                                                       */
1541  /*      for all glyphs do                                                */
1542  /*        <compute kern between current and previous glyph and add it to */
1543  /*         `origin_x'>                                                   */
1544  /*                                                                       */
1545  /*        <load glyph with `FT_Load_Glyph'>                              */
1546  /*                                                                       */
1547  /*        if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 )           */
1548  /*          origin_x -= 64;                                              */
1549  /*        else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 )      */
1550  /*          origin_x += 64;                                              */
1551  /*                                                                       */
1552  /*        prev_rsb_delta = face->glyph->rsb_delta;                       */
1553  /*                                                                       */
1554  /*        <save glyph image, or render glyph, or ...>                    */
1555  /*                                                                       */
1556  /*        origin_x += face->glyph->advance.x;                            */
1557  /*      endfor                                                           */
1558  /*    }                                                                  */
1559  /*                                                                       */
1560  typedef struct  FT_GlyphSlotRec_
1561  {
1562    FT_Library        library;
1563    FT_Face           face;
1564    FT_GlyphSlot      next;
1565    FT_UInt           reserved;       /* retained for binary compatibility */
1566    FT_Generic        generic;
1567
1568    FT_Glyph_Metrics  metrics;
1569    FT_Fixed          linearHoriAdvance;
1570    FT_Fixed          linearVertAdvance;
1571    FT_Vector         advance;
1572
1573    FT_Glyph_Format   format;
1574
1575    FT_Bitmap         bitmap;
1576    FT_Int            bitmap_left;
1577    FT_Int            bitmap_top;
1578
1579    FT_Outline        outline;
1580
1581    FT_UInt           num_subglyphs;
1582    FT_SubGlyph       subglyphs;
1583
1584    void*             control_data;
1585    long              control_len;
1586
1587    FT_Pos            lsb_delta;
1588    FT_Pos            rsb_delta;
1589
1590    void*             other;
1591
1592    FT_Slot_Internal  internal;
1593
1594  } FT_GlyphSlotRec;
1595
1596
1597  /*************************************************************************/
1598  /*************************************************************************/
1599  /*                                                                       */
1600  /*                         F U N C T I O N S                             */
1601  /*                                                                       */
1602  /*************************************************************************/
1603  /*************************************************************************/
1604
1605
1606  /*************************************************************************/
1607  /*                                                                       */
1608  /* <Function>                                                            */
1609  /*    FT_Init_FreeType                                                   */
1610  /*                                                                       */
1611  /* <Description>                                                         */
1612  /*    Initialize a new FreeType library object.  The set of modules      */
1613  /*    that are registered by this function is determined at build time.  */
1614  /*                                                                       */
1615  /* <Output>                                                              */
1616  /*    alibrary :: A handle to a new library object.                      */
1617  /*                                                                       */
1618  /* <Return>                                                              */
1619  /*    FreeType error code.  0~means success.                             */
1620  /*                                                                       */
1621  FT_EXPORT( FT_Error )
1622  FT_Init_FreeType( FT_Library  *alibrary );
1623
1624
1625  /*************************************************************************/
1626  /*                                                                       */
1627  /* <Function>                                                            */
1628  /*    FT_Done_FreeType                                                   */
1629  /*                                                                       */
1630  /* <Description>                                                         */
1631  /*    Destroy a given FreeType library object and all of its children,   */
1632  /*    including resources, drivers, faces, sizes, etc.                   */
1633  /*                                                                       */
1634  /* <Input>                                                               */
1635  /*    library :: A handle to the target library object.                  */
1636  /*                                                                       */
1637  /* <Return>                                                              */
1638  /*    FreeType error code.  0~means success.                             */
1639  /*                                                                       */
1640  FT_EXPORT( FT_Error )
1641  FT_Done_FreeType( FT_Library  library );
1642
1643
1644  /*************************************************************************/
1645  /*                                                                       */
1646  /* <Enum>                                                                */
1647  /*    FT_OPEN_XXX                                                        */
1648  /*                                                                       */
1649  /* <Description>                                                         */
1650  /*    A list of bit-field constants used within the `flags' field of the */
1651  /*    @FT_Open_Args structure.                                           */
1652  /*                                                                       */
1653  /* <Values>                                                              */
1654  /*    FT_OPEN_MEMORY      :: This is a memory-based stream.              */
1655  /*                                                                       */
1656  /*    FT_OPEN_STREAM      :: Copy the stream from the `stream' field.    */
1657  /*                                                                       */
1658  /*    FT_OPEN_PATHNAME    :: Create a new input stream from a C~path     */
1659  /*                           name.                                       */
1660  /*                                                                       */
1661  /*    FT_OPEN_DRIVER      :: Use the `driver' field.                     */
1662  /*                                                                       */
1663  /*    FT_OPEN_PARAMS      :: Use the `num_params' and `params' fields.   */
1664  /*                                                                       */
1665  /*    ft_open_memory      :: Deprecated; use @FT_OPEN_MEMORY instead.    */
1666  /*                                                                       */
1667  /*    ft_open_stream      :: Deprecated; use @FT_OPEN_STREAM instead.    */
1668  /*                                                                       */
1669  /*    ft_open_pathname    :: Deprecated; use @FT_OPEN_PATHNAME instead.  */
1670  /*                                                                       */
1671  /*    ft_open_driver      :: Deprecated; use @FT_OPEN_DRIVER instead.    */
1672  /*                                                                       */
1673  /*    ft_open_params      :: Deprecated; use @FT_OPEN_PARAMS instead.    */
1674  /*                                                                       */
1675  /* <Note>                                                                */
1676  /*    The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME'     */
1677  /*    flags are mutually exclusive.                                      */
1678  /*                                                                       */
1679#define FT_OPEN_MEMORY    0x1
1680#define FT_OPEN_STREAM    0x2
1681#define FT_OPEN_PATHNAME  0x4
1682#define FT_OPEN_DRIVER    0x8
1683#define FT_OPEN_PARAMS    0x10
1684
1685#define ft_open_memory    FT_OPEN_MEMORY     /* deprecated */
1686#define ft_open_stream    FT_OPEN_STREAM     /* deprecated */
1687#define ft_open_pathname  FT_OPEN_PATHNAME   /* deprecated */
1688#define ft_open_driver    FT_OPEN_DRIVER     /* deprecated */
1689#define ft_open_params    FT_OPEN_PARAMS     /* deprecated */
1690
1691
1692  /*************************************************************************/
1693  /*                                                                       */
1694  /* <Struct>                                                              */
1695  /*    FT_Parameter                                                       */
1696  /*                                                                       */
1697  /* <Description>                                                         */
1698  /*    A simple structure used to pass more or less generic parameters    */
1699  /*    to @FT_Open_Face.                                                  */
1700  /*                                                                       */
1701  /* <Fields>                                                              */
1702  /*    tag  :: A four-byte identification tag.                            */
1703  /*                                                                       */
1704  /*    data :: A pointer to the parameter data.                           */
1705  /*                                                                       */
1706  /* <Note>                                                                */
1707  /*    The ID and function of parameters are driver-specific.             */
1708  /*                                                                       */
1709  typedef struct  FT_Parameter_
1710  {
1711    FT_ULong    tag;
1712    FT_Pointer  data;
1713
1714  } FT_Parameter;
1715
1716
1717  /*************************************************************************/
1718  /*                                                                       */
1719  /* <Struct>                                                              */
1720  /*    FT_Open_Args                                                       */
1721  /*                                                                       */
1722  /* <Description>                                                         */
1723  /*    A structure used to indicate how to open a new font file or        */
1724  /*    stream.  A pointer to such a structure can be used as a parameter  */
1725  /*    for the functions @FT_Open_Face and @FT_Attach_Stream.             */
1726  /*                                                                       */
1727  /* <Fields>                                                              */
1728  /*    flags       :: A set of bit flags indicating how to use the        */
1729  /*                   structure.                                          */
1730  /*                                                                       */
1731  /*    memory_base :: The first byte of the file in memory.               */
1732  /*                                                                       */
1733  /*    memory_size :: The size in bytes of the file in memory.            */
1734  /*                                                                       */
1735  /*    pathname    :: A pointer to an 8-bit file pathname.                */
1736  /*                                                                       */
1737  /*    stream      :: A handle to a source stream object.                 */
1738  /*                                                                       */
1739  /*    driver      :: This field is exclusively used by @FT_Open_Face;    */
1740  /*                   it simply specifies the font driver to use to open  */
1741  /*                   the face.  If set to~0, FreeType tries to load the  */
1742  /*                   face with each one of the drivers in its list.      */
1743  /*                                                                       */
1744  /*    num_params  :: The number of extra parameters.                     */
1745  /*                                                                       */
1746  /*    params      :: Extra parameters passed to the font driver when     */
1747  /*                   opening a new face.                                 */
1748  /*                                                                       */
1749  /* <Note>                                                                */
1750  /*    The stream type is determined by the contents of `flags' which     */
1751  /*    are tested in the following order by @FT_Open_Face:                */
1752  /*                                                                       */
1753  /*    If the `FT_OPEN_MEMORY' bit is set, assume that this is a          */
1754  /*    memory file of `memory_size' bytes, located at `memory_address'.   */
1755  /*    The data are are not copied, and the client is responsible for     */
1756  /*    releasing and destroying them _after_ the corresponding call to    */
1757  /*    @FT_Done_Face.                                                     */
1758  /*                                                                       */
1759  /*    Otherwise, if the `FT_OPEN_STREAM' bit is set, assume that a       */
1760  /*    custom input stream `stream' is used.                              */
1761  /*                                                                       */
1762  /*    Otherwise, if the `FT_OPEN_PATHNAME' bit is set, assume that this  */
1763  /*    is a normal file and use `pathname' to open it.                    */
1764  /*                                                                       */
1765  /*    If the `FT_OPEN_DRIVER' bit is set, @FT_Open_Face only tries to    */
1766  /*    open the file with the driver whose handler is in `driver'.        */
1767  /*                                                                       */
1768  /*    If the `FT_OPEN_PARAMS' bit is set, the parameters given by        */
1769  /*    `num_params' and `params' is used.  They are ignored otherwise.    */
1770  /*                                                                       */
1771  /*    Ideally, both the `pathname' and `params' fields should be tagged  */
1772  /*    as `const'; this is missing for API backwards compatibility.  With */
1773  /*    other words, applications should treat them as read-only.          */
1774  /*                                                                       */
1775  typedef struct  FT_Open_Args_
1776  {
1777    FT_UInt         flags;
1778    const FT_Byte*  memory_base;
1779    FT_Long         memory_size;
1780    FT_String*      pathname;
1781    FT_Stream       stream;
1782    FT_Module       driver;
1783    FT_Int          num_params;
1784    FT_Parameter*   params;
1785
1786  } FT_Open_Args;
1787
1788
1789  /*************************************************************************/
1790  /*                                                                       */
1791  /* <Function>                                                            */
1792  /*    FT_New_Face                                                        */
1793  /*                                                                       */
1794  /* <Description>                                                         */
1795  /*    This function calls @FT_Open_Face to open a font by its pathname.  */
1796  /*                                                                       */
1797  /* <InOut>                                                               */
1798  /*    library    :: A handle to the library resource.                    */
1799  /*                                                                       */
1800  /* <Input>                                                               */
1801  /*    pathname   :: A path to the font file.                             */
1802  /*                                                                       */
1803  /*    face_index :: The index of the face within the font.  The first    */
1804  /*                  face has index~0.                                    */
1805  /*                                                                       */
1806  /* <Output>                                                              */
1807  /*    aface      :: A handle to a new face object.  If `face_index' is   */
1808  /*                  greater than or equal to zero, it must be non-NULL.  */
1809  /*                  See @FT_Open_Face for more details.                  */
1810  /*                                                                       */
1811  /* <Return>                                                              */
1812  /*    FreeType error code.  0~means success.                             */
1813  /*                                                                       */
1814  FT_EXPORT( FT_Error )
1815  FT_New_Face( FT_Library   library,
1816               const char*  filepathname,
1817               FT_Long      face_index,
1818               FT_Face     *aface );
1819
1820
1821  /*************************************************************************/
1822  /*                                                                       */
1823  /* <Function>                                                            */
1824  /*    FT_New_Memory_Face                                                 */
1825  /*                                                                       */
1826  /* <Description>                                                         */
1827  /*    This function calls @FT_Open_Face to open a font which has been    */
1828  /*    loaded into memory.                                                */
1829  /*                                                                       */
1830  /* <InOut>                                                               */
1831  /*    library    :: A handle to the library resource.                    */
1832  /*                                                                       */
1833  /* <Input>                                                               */
1834  /*    file_base  :: A pointer to the beginning of the font data.         */
1835  /*                                                                       */
1836  /*    file_size  :: The size of the memory chunk used by the font data.  */
1837  /*                                                                       */
1838  /*    face_index :: The index of the face within the font.  The first    */
1839  /*                  face has index~0.                                    */
1840  /*                                                                       */
1841  /* <Output>                                                              */
1842  /*    aface      :: A handle to a new face object.  If `face_index' is   */
1843  /*                  greater than or equal to zero, it must be non-NULL.  */
1844  /*                  See @FT_Open_Face for more details.                  */
1845  /*                                                                       */
1846  /* <Return>                                                              */
1847  /*    FreeType error code.  0~means success.                             */
1848  /*                                                                       */
1849  /* <Note>                                                                */
1850  /*    You must not deallocate the memory before calling @FT_Done_Face.   */
1851  /*                                                                       */
1852  FT_EXPORT( FT_Error )
1853  FT_New_Memory_Face( FT_Library      library,
1854                      const FT_Byte*  file_base,
1855                      FT_Long         file_size,
1856                      FT_Long         face_index,
1857                      FT_Face        *aface );
1858
1859
1860  /*************************************************************************/
1861  /*                                                                       */
1862  /* <Function>                                                            */
1863  /*    FT_Open_Face                                                       */
1864  /*                                                                       */
1865  /* <Description>                                                         */
1866  /*    Create a face object from a given resource described by            */
1867  /*    @FT_Open_Args.                                                     */
1868  /*                                                                       */
1869  /* <InOut>                                                               */
1870  /*    library    :: A handle to the library resource.                    */
1871  /*                                                                       */
1872  /* <Input>                                                               */
1873  /*    args       :: A pointer to an `FT_Open_Args' structure which must  */
1874  /*                  be filled by the caller.                             */
1875  /*                                                                       */
1876  /*    face_index :: The index of the face within the font.  The first    */
1877  /*                  face has index~0.                                    */
1878  /*                                                                       */
1879  /* <Output>                                                              */
1880  /*    aface      :: A handle to a new face object.  If `face_index' is   */
1881  /*                  greater than or equal to zero, it must be non-NULL.  */
1882  /*                  See note below.                                      */
1883  /*                                                                       */
1884  /* <Return>                                                              */
1885  /*    FreeType error code.  0~means success.                             */
1886  /*                                                                       */
1887  /* <Note>                                                                */
1888  /*    Unlike FreeType 1.x, this function automatically creates a glyph   */
1889  /*    slot for the face object which can be accessed directly through    */
1890  /*    `face->glyph'.                                                     */
1891  /*                                                                       */
1892  /*    FT_Open_Face can be used to quickly check whether the font         */
1893  /*    format of a given font resource is supported by FreeType.  If the  */
1894  /*    `face_index' field is negative, the function's return value is~0   */
1895  /*    if the font format is recognized, or non-zero otherwise;           */
1896  /*    the function returns a more or less empty face handle in `*aface'  */
1897  /*    (if `aface' isn't NULL).  The only useful field in this special    */
1898  /*    case is `face->num_faces' which gives the number of faces within   */
1899  /*    the font file.  After examination, the returned @FT_Face structure */
1900  /*    should be deallocated with a call to @FT_Done_Face.                */
1901  /*                                                                       */
1902  /*    Each new face object created with this function also owns a        */
1903  /*    default @FT_Size object, accessible as `face->size'.               */
1904  /*                                                                       */
1905  FT_EXPORT( FT_Error )
1906  FT_Open_Face( FT_Library           library,
1907                const FT_Open_Args*  args,
1908                FT_Long              face_index,
1909                FT_Face             *aface );
1910
1911
1912  /*************************************************************************/
1913  /*                                                                       */
1914  /* <Function>                                                            */
1915  /*    FT_Attach_File                                                     */
1916  /*                                                                       */
1917  /* <Description>                                                         */
1918  /*    This function calls @FT_Attach_Stream to attach a file.            */
1919  /*                                                                       */
1920  /* <InOut>                                                               */
1921  /*    face         :: The target face object.                            */
1922  /*                                                                       */
1923  /* <Input>                                                               */
1924  /*    filepathname :: The pathname.                                      */
1925  /*                                                                       */
1926  /* <Return>                                                              */
1927  /*    FreeType error code.  0~means success.                             */
1928  /*                                                                       */
1929  FT_EXPORT( FT_Error )
1930  FT_Attach_File( FT_Face      face,
1931                  const char*  filepathname );
1932
1933
1934  /*************************************************************************/
1935  /*                                                                       */
1936  /* <Function>                                                            */
1937  /*    FT_Attach_Stream                                                   */
1938  /*                                                                       */
1939  /* <Description>                                                         */
1940  /*    `Attach' data to a face object.  Normally, this is used to read    */
1941  /*    additional information for the face object.  For example, you can  */
1942  /*    attach an AFM file that comes with a Type~1 font to get the        */
1943  /*    kerning values and other metrics.                                  */
1944  /*                                                                       */
1945  /* <InOut>                                                               */
1946  /*    face       :: The target face object.                              */
1947  /*                                                                       */
1948  /* <Input>                                                               */
1949  /*    parameters :: A pointer to @FT_Open_Args which must be filled by   */
1950  /*                  the caller.                                          */
1951  /*                                                                       */
1952  /* <Return>                                                              */
1953  /*    FreeType error code.  0~means success.                             */
1954  /*                                                                       */
1955  /* <Note>                                                                */
1956  /*    The meaning of the `attach' (i.e., what really happens when the    */
1957  /*    new file is read) is not fixed by FreeType itself.  It really      */
1958  /*    depends on the font format (and thus the font driver).             */
1959  /*                                                                       */
1960  /*    Client applications are expected to know what they are doing       */
1961  /*    when invoking this function.  Most drivers simply do not implement */
1962  /*    file attachments.                                                  */
1963  /*                                                                       */
1964  FT_EXPORT( FT_Error )
1965  FT_Attach_Stream( FT_Face        face,
1966                    FT_Open_Args*  parameters );
1967
1968
1969  /*************************************************************************/
1970  /*                                                                       */
1971  /* <Function>                                                            */
1972  /*    FT_Done_Face                                                       */
1973  /*                                                                       */
1974  /* <Description>                                                         */
1975  /*    Discard a given face object, as well as all of its child slots and */
1976  /*    sizes.                                                             */
1977  /*                                                                       */
1978  /* <Input>                                                               */
1979  /*    face :: A handle to a target face object.                          */
1980  /*                                                                       */
1981  /* <Return>                                                              */
1982  /*    FreeType error code.  0~means success.                             */
1983  /*                                                                       */
1984  FT_EXPORT( FT_Error )
1985  FT_Done_Face( FT_Face  face );
1986
1987
1988  /*************************************************************************/
1989  /*                                                                       */
1990  /* <Function>                                                            */
1991  /*    FT_Select_Size                                                     */
1992  /*                                                                       */
1993  /* <Description>                                                         */
1994  /*    Select a bitmap strike.                                            */
1995  /*                                                                       */
1996  /* <InOut>                                                               */
1997  /*    face         :: A handle to a target face object.                  */
1998  /*                                                                       */
1999  /* <Input>                                                               */
2000  /*    strike_index :: The index of the bitmap strike in the              */
2001  /*                    `available_sizes' field of @FT_FaceRec structure.  */
2002  /*                                                                       */
2003  /* <Return>                                                              */
2004  /*    FreeType error code.  0~means success.                             */
2005  /*                                                                       */
2006  FT_EXPORT( FT_Error )
2007  FT_Select_Size( FT_Face  face,
2008                  FT_Int   strike_index );
2009
2010
2011  /*************************************************************************/
2012  /*                                                                       */
2013  /* <Enum>                                                                */
2014  /*    FT_Size_Request_Type                                               */
2015  /*                                                                       */
2016  /* <Description>                                                         */
2017  /*    An enumeration type that lists the supported size request types.   */
2018  /*                                                                       */
2019  /* <Values>                                                              */
2020  /*    FT_SIZE_REQUEST_TYPE_NOMINAL ::                                    */
2021  /*      The nominal size.  The `units_per_EM' field of @FT_FaceRec is    */
2022  /*      used to determine both scaling values.                           */
2023  /*                                                                       */
2024  /*    FT_SIZE_REQUEST_TYPE_REAL_DIM ::                                   */
2025  /*      The real dimension.  The sum of the the `Ascender' and (minus    */
2026  /*      of) the `Descender' fields of @FT_FaceRec are used to determine  */
2027  /*      both scaling values.                                             */
2028  /*                                                                       */
2029  /*    FT_SIZE_REQUEST_TYPE_BBOX ::                                       */
2030  /*      The font bounding box.  The width and height of the `bbox' field */
2031  /*      of @FT_FaceRec are used to determine the horizontal and vertical */
2032  /*      scaling value, respectively.                                     */
2033  /*                                                                       */
2034  /*    FT_SIZE_REQUEST_TYPE_CELL ::                                       */
2035  /*      The `max_advance_width' field of @FT_FaceRec is used to          */
2036  /*      determine the horizontal scaling value; the vertical scaling     */
2037  /*      value is determined the same way as                              */
2038  /*      @FT_SIZE_REQUEST_TYPE_REAL_DIM does.  Finally, both scaling      */
2039  /*      values are set to the smaller one.  This type is useful if you   */
2040  /*      want to specify the font size for, say, a window of a given      */
2041  /*      dimension and 80x24 cells.                                       */
2042  /*                                                                       */
2043  /*    FT_SIZE_REQUEST_TYPE_SCALES ::                                     */
2044  /*      Specify the scaling values directly.                             */
2045  /*                                                                       */
2046  /* <Note>                                                                */
2047  /*    The above descriptions only apply to scalable formats.  For bitmap */
2048  /*    formats, the behaviour is up to the driver.                        */
2049  /*                                                                       */
2050  /*    See the note section of @FT_Size_Metrics if you wonder how size    */
2051  /*    requesting relates to scaling values.                              */
2052  /*                                                                       */
2053  typedef enum  FT_Size_Request_Type_
2054  {
2055    FT_SIZE_REQUEST_TYPE_NOMINAL,
2056    FT_SIZE_REQUEST_TYPE_REAL_DIM,
2057    FT_SIZE_REQUEST_TYPE_BBOX,
2058    FT_SIZE_REQUEST_TYPE_CELL,
2059    FT_SIZE_REQUEST_TYPE_SCALES,
2060
2061    FT_SIZE_REQUEST_TYPE_MAX
2062
2063  } FT_Size_Request_Type;
2064
2065
2066  /*************************************************************************/
2067  /*                                                                       */
2068  /* <Struct>                                                              */
2069  /*    FT_Size_RequestRec                                                 */
2070  /*                                                                       */
2071  /* <Description>                                                         */
2072  /*    A structure used to model a size request.                          */
2073  /*                                                                       */
2074  /* <Fields>                                                              */
2075  /*    type           :: See @FT_Size_Request_Type.                       */
2076  /*                                                                       */
2077  /*    width          :: The desired width.                               */
2078  /*                                                                       */
2079  /*    height         :: The desired height.                              */
2080  /*                                                                       */
2081  /*    horiResolution :: The horizontal resolution.  If set to zero,      */
2082  /*                      `width' is treated as a 26.6 fractional pixel    */
2083  /*                      value.                                           */
2084  /*                                                                       */
2085  /*    vertResolution :: The vertical resolution.  If set to zero,        */
2086  /*                      `height' is treated as a 26.6 fractional pixel   */
2087  /*                      value.                                           */
2088  /*                                                                       */
2089  /* <Note>                                                                */
2090  /*    If `width' is zero, then the horizontal scaling value is set      */
2091  /*    equal to the vertical scaling value, and vice versa.               */
2092  /*                                                                       */
2093  typedef struct  FT_Size_RequestRec_
2094  {
2095    FT_Size_Request_Type  type;
2096    FT_Long               width;
2097    FT_Long               height;
2098    FT_UInt               horiResolution;
2099    FT_UInt               vertResolution;
2100
2101  } FT_Size_RequestRec;
2102
2103
2104  /*************************************************************************/
2105  /*                                                                       */
2106  /* <Struct>                                                              */
2107  /*    FT_Size_Request                                                    */
2108  /*                                                                       */
2109  /* <Description>                                                         */
2110  /*    A handle to a size request structure.                              */
2111  /*                                                                       */
2112  typedef struct FT_Size_RequestRec_  *FT_Size_Request;
2113
2114
2115  /*************************************************************************/
2116  /*                                                                       */
2117  /* <Function>                                                            */
2118  /*    FT_Request_Size                                                    */
2119  /*                                                                       */
2120  /* <Description>                                                         */
2121  /*    Resize the scale of the active @FT_Size object in a face.          */
2122  /*                                                                       */
2123  /* <InOut>                                                               */
2124  /*    face :: A handle to a target face object.                          */
2125  /*                                                                       */
2126  /* <Input>                                                               */
2127  /*    req  :: A pointer to a @FT_Size_RequestRec.                        */
2128  /*                                                                       */
2129  /* <Return>                                                              */
2130  /*    FreeType error code.  0~means success.                             */
2131  /*                                                                       */
2132  /* <Note>                                                                */
2133  /*    Although drivers may select the bitmap strike matching the         */
2134  /*    request, you should not rely on this if you intend to select a     */
2135  /*    particular bitmap strike.  Use @FT_Select_Size instead in that     */
2136  /*    case.                                                              */
2137  /*                                                                       */
2138  FT_EXPORT( FT_Error )
2139  FT_Request_Size( FT_Face          face,
2140                   FT_Size_Request  req );
2141
2142
2143  /*************************************************************************/
2144  /*                                                                       */
2145  /* <Function>                                                            */
2146  /*    FT_Set_Char_Size                                                   */
2147  /*                                                                       */
2148  /* <Description>                                                         */
2149  /*    This function calls @FT_Request_Size to request the nominal size   */
2150  /*    (in points).                                                       */
2151  /*                                                                       */
2152  /* <InOut>                                                               */
2153  /*    face            :: A handle to a target face object.               */
2154  /*                                                                       */
2155  /* <Input>                                                               */
2156  /*    char_width      :: The nominal width, in 26.6 fractional points.   */
2157  /*                                                                       */
2158  /*    char_height     :: The nominal height, in 26.6 fractional points.  */
2159  /*                                                                       */
2160  /*    horz_resolution :: The horizontal resolution in dpi.               */
2161  /*                                                                       */
2162  /*    vert_resolution :: The vertical resolution in dpi.                 */
2163  /*                                                                       */
2164  /* <Return>                                                              */
2165  /*    FreeType error code.  0~means success.                             */
2166  /*                                                                       */
2167  /* <Note>                                                                */
2168  /*    If either the character width or height is zero, it is set equal   */
2169  /*    to the other value.                                                */
2170  /*                                                                       */
2171  /*    If either the horizontal or vertical resolution is zero, it is set */
2172  /*    equal to the other value.                                          */
2173  /*                                                                       */
2174  /*    A character width or height smaller than 1pt is set to 1pt; if     */
2175  /*    both resolution values are zero, they are set to 72dpi.            */
2176  /*                                                                       */
2177
2178  FT_EXPORT( FT_Error )
2179  FT_Set_Char_Size( FT_Face     face,
2180                    FT_F26Dot6  char_width,
2181                    FT_F26Dot6  char_height,
2182                    FT_UInt     horz_resolution,
2183                    FT_UInt     vert_resolution );
2184
2185
2186  /*************************************************************************/
2187  /*                                                                       */
2188  /* <Function>                                                            */
2189  /*    FT_Set_Pixel_Sizes                                                 */
2190  /*                                                                       */
2191  /* <Description>                                                         */
2192  /*    This function calls @FT_Request_Size to request the nominal size   */
2193  /*    (in pixels).                                                       */
2194  /*                                                                       */
2195  /* <InOut>                                                               */
2196  /*    face         :: A handle to the target face object.                */
2197  /*                                                                       */
2198  /* <Input>                                                               */
2199  /*    pixel_width  :: The nominal width, in pixels.                      */
2200  /*                                                                       */
2201  /*    pixel_height :: The nominal height, in pixels.                     */
2202  /*                                                                       */
2203  /* <Return>                                                              */
2204  /*    FreeType error code.  0~means success.                             */
2205  /*                                                                       */
2206  FT_EXPORT( FT_Error )
2207  FT_Set_Pixel_Sizes( FT_Face  face,
2208                      FT_UInt  pixel_width,
2209                      FT_UInt  pixel_height );
2210
2211
2212  /*************************************************************************/
2213  /*                                                                       */
2214  /* <Function>                                                            */
2215  /*    FT_Load_Glyph                                                      */
2216  /*                                                                       */
2217  /* <Description>                                                         */
2218  /*    A function used to load a single glyph into the glyph slot of a    */
2219  /*    face object.                                                       */
2220  /*                                                                       */
2221  /* <InOut>                                                               */
2222  /*    face        :: A handle to the target face object where the glyph  */
2223  /*                   is loaded.                                          */
2224  /*                                                                       */
2225  /* <Input>                                                               */
2226  /*    glyph_index :: The index of the glyph in the font file.  For       */
2227  /*                   CID-keyed fonts (either in PS or in CFF format)     */
2228  /*                   this argument specifies the CID value.              */
2229  /*                                                                       */
2230  /*    load_flags  :: A flag indicating what to load for this glyph.  The */
2231  /*                   @FT_LOAD_XXX constants can be used to control the   */
2232  /*                   glyph loading process (e.g., whether the outline    */
2233  /*                   should be scaled, whether to load bitmaps or not,   */
2234  /*                   whether to hint the outline, etc).                  */
2235  /*                                                                       */
2236  /* <Return>                                                              */
2237  /*    FreeType error code.  0~means success.                             */
2238  /*                                                                       */
2239  /* <Note>                                                                */
2240  /*    The loaded glyph may be transformed.  See @FT_Set_Transform for    */
2241  /*    the details.                                                       */
2242  /*                                                                       */
2243  /*    For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is        */
2244  /*    returned for invalid CID values (this is, for CID values which     */
2245  /*    don't have a corresponding glyph in the font).  See the discussion */
2246  /*    of the @FT_FACE_FLAG_CID_KEYED flag for more details.              */
2247  /*                                                                       */
2248  FT_EXPORT( FT_Error )
2249  FT_Load_Glyph( FT_Face   face,
2250                 FT_UInt   glyph_index,
2251                 FT_Int32  load_flags );
2252
2253
2254  /*************************************************************************/
2255  /*                                                                       */
2256  /* <Function>                                                            */
2257  /*    FT_Load_Char                                                       */
2258  /*                                                                       */
2259  /* <Description>                                                         */
2260  /*    A function used to load a single glyph into the glyph slot of a    */
2261  /*    face object, according to its character code.                      */
2262  /*                                                                       */
2263  /* <InOut>                                                               */
2264  /*    face        :: A handle to a target face object where the glyph    */
2265  /*                   is loaded.                                          */
2266  /*                                                                       */
2267  /* <Input>                                                               */
2268  /*    char_code   :: The glyph's character code, according to the        */
2269  /*                   current charmap used in the face.                   */
2270  /*                                                                       */
2271  /*    load_flags  :: A flag indicating what to load for this glyph.  The */
2272  /*                   @FT_LOAD_XXX constants can be used to control the   */
2273  /*                   glyph loading process (e.g., whether the outline    */
2274  /*                   should be scaled, whether to load bitmaps or not,   */
2275  /*                   whether to hint the outline, etc).                  */
2276  /*                                                                       */
2277  /* <Return>                                                              */
2278  /*    FreeType error code.  0~means success.                             */
2279  /*                                                                       */
2280  /* <Note>                                                                */
2281  /*    This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph.  */
2282  /*                                                                       */
2283  FT_EXPORT( FT_Error )
2284  FT_Load_Char( FT_Face   face,
2285                FT_ULong  char_code,
2286                FT_Int32  load_flags );
2287
2288
2289  /*************************************************************************
2290   *
2291   * @enum:
2292   *   FT_LOAD_XXX
2293   *
2294   * @description:
2295   *   A list of bit-field constants used with @FT_Load_Glyph to indicate
2296   *   what kind of operations to perform during glyph loading.
2297   *
2298   * @values:
2299   *   FT_LOAD_DEFAULT ::
2300   *     Corresponding to~0, this value is used as the default glyph load
2301   *     operation.  In this case, the following happens:
2302   *
2303   *     1. FreeType looks for a bitmap for the glyph corresponding to the
2304   *        face's current size.  If one is found, the function returns.
2305   *        The bitmap data can be accessed from the glyph slot (see note
2306   *        below).
2307   *
2308   *     2. If no embedded bitmap is searched or found, FreeType looks for a
2309   *        scalable outline.  If one is found, it is loaded from the font
2310   *        file, scaled to device pixels, then `hinted' to the pixel grid
2311   *        in order to optimize it.  The outline data can be accessed from
2312   *        the glyph slot (see note below).
2313   *
2314   *     Note that by default, the glyph loader doesn't render outlines into
2315   *     bitmaps.  The following flags are used to modify this default
2316   *     behaviour to more specific and useful cases.
2317   *
2318   *   FT_LOAD_NO_SCALE ::
2319   *     Don't scale the outline glyph loaded, but keep it in font units.
2320   *
2321   *     This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
2322   *     unsets @FT_LOAD_RENDER.
2323   *
2324   *   FT_LOAD_NO_HINTING ::
2325   *     Disable hinting.  This generally generates `blurrier' bitmap glyph
2326   *     when the glyph is rendered in any of the anti-aliased modes.  See
2327   *     also the note below.
2328   *
2329   *     This flag is implied by @FT_LOAD_NO_SCALE.
2330   *
2331   *   FT_LOAD_RENDER ::
2332   *     Call @FT_Render_Glyph after the glyph is loaded.  By default, the
2333   *     glyph is rendered in @FT_RENDER_MODE_NORMAL mode.  This can be
2334   *     overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME.
2335   *
2336   *     This flag is unset by @FT_LOAD_NO_SCALE.
2337   *
2338   *   FT_LOAD_NO_BITMAP ::
2339   *     Ignore bitmap strikes when loading.  Bitmap-only fonts ignore this
2340   *     flag.
2341   *
2342   *     @FT_LOAD_NO_SCALE always sets this flag.
2343   *
2344   *   FT_LOAD_VERTICAL_LAYOUT ::
2345   *     Load the glyph for vertical text layout.  _Don't_ use it as it is
2346   *     problematic currently.
2347   *
2348   *   FT_LOAD_FORCE_AUTOHINT ::
2349   *     Indicates that the auto-hinter is preferred over the font's native
2350   *     hinter.  See also the note below.
2351   *
2352   *   FT_LOAD_CROP_BITMAP ::
2353   *     Indicates that the font driver should crop the loaded bitmap glyph
2354   *     (i.e., remove all space around its black bits).  Not all drivers
2355   *     implement this.
2356   *
2357   *   FT_LOAD_PEDANTIC ::
2358   *     Indicates that the font driver should perform pedantic verifications
2359   *     during glyph loading.  This is mostly used to detect broken glyphs
2360   *     in fonts.  By default, FreeType tries to handle broken fonts also.
2361   *
2362   *   FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ::
2363   *     Indicates that the font driver should ignore the global advance
2364   *     width defined in the font.  By default, that value is used as the
2365   *     advance width for all glyphs when the face has
2366   *     @FT_FACE_FLAG_FIXED_WIDTH set.
2367   *
2368   *     This flag exists for historical reasons (to support buggy CJK
2369   *     fonts).
2370   *
2371   *   FT_LOAD_NO_RECURSE ::
2372   *     This flag is only used internally.  It merely indicates that the
2373   *     font driver should not load composite glyphs recursively.  Instead,
2374   *     it should set the `num_subglyph' and `subglyphs' values of the
2375   *     glyph slot accordingly, and set `glyph->format' to
2376   *     @FT_GLYPH_FORMAT_COMPOSITE.
2377   *
2378   *     The description of sub-glyphs is not available to client
2379   *     applications for now.
2380   *
2381   *     This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
2382   *
2383   *   FT_LOAD_IGNORE_TRANSFORM ::
2384   *     Indicates that the transform matrix set by @FT_Set_Transform should
2385   *     be ignored.
2386   *
2387   *   FT_LOAD_MONOCHROME ::
2388   *     This flag is used with @FT_LOAD_RENDER to indicate that you want to
2389   *     render an outline glyph to a 1-bit monochrome bitmap glyph, with
2390   *     8~pixels packed into each byte of the bitmap data.
2391   *
2392   *     Note that this has no effect on the hinting algorithm used.  You
2393   *     should use @FT_LOAD_TARGET_MONO instead so that the
2394   *     monochrome-optimized hinting algorithm is used.
2395   *
2396   *   FT_LOAD_LINEAR_DESIGN ::
2397   *     Indicates that the `linearHoriAdvance' and `linearVertAdvance'
2398   *     fields of @FT_GlyphSlotRec should be kept in font units.  See
2399   *     @FT_GlyphSlotRec for details.
2400   *
2401   *   FT_LOAD_NO_AUTOHINT ::
2402   *     Disable auto-hinter.  See also the note below.
2403   *
2404   * @note:
2405   *   By default, hinting is enabled and the font's native hinter (see
2406   *   @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter.  You can
2407   *   disable hinting by setting @FT_LOAD_NO_HINTING or change the
2408   *   precedence by setting @FT_LOAD_FORCE_AUTOHINT.  You can also set
2409   *   @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be
2410   *   used at all.
2411   *
2412   *   Besides deciding which hinter to use, you can also decide which
2413   *   hinting algorithm to use.  See @FT_LOAD_TARGET_XXX for details.
2414   */
2415#define FT_LOAD_DEFAULT                      0x0
2416#define FT_LOAD_NO_SCALE                     0x1
2417#define FT_LOAD_NO_HINTING                   0x2
2418#define FT_LOAD_RENDER                       0x4
2419#define FT_LOAD_NO_BITMAP                    0x8
2420#define FT_LOAD_VERTICAL_LAYOUT              0x10
2421#define FT_LOAD_FORCE_AUTOHINT               0x20
2422#define FT_LOAD_CROP_BITMAP                  0x40
2423#define FT_LOAD_PEDANTIC                     0x80
2424#define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH  0x200
2425#define FT_LOAD_NO_RECURSE                   0x400
2426#define FT_LOAD_IGNORE_TRANSFORM             0x800
2427#define FT_LOAD_MONOCHROME                   0x1000
2428#define FT_LOAD_LINEAR_DESIGN                0x2000
2429#define FT_LOAD_SBITS_ONLY                   0x4000   /* temporary hack! */
2430#define FT_LOAD_NO_AUTOHINT                  0x8000U
2431
2432  /* */
2433
2434
2435  /**************************************************************************
2436   *
2437   * @enum:
2438   *   FT_LOAD_TARGET_XXX
2439   *
2440   * @description:
2441   *   A list of values that are used to select a specific hinting algorithm
2442   *   to use by the hinter.  You should OR one of these values to your
2443   *   `load_flags' when calling @FT_Load_Glyph.
2444   *
2445   *   Note that font's native hinters may ignore the hinting algorithm you
2446   *   have specified (e.g., the TrueType bytecode interpreter).  You can set
2447   *   @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.
2448   *
2449   *   Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it
2450   *   always implies @FT_LOAD_FORCE_AUTOHINT.
2451   *
2452   * @values:
2453   *   FT_LOAD_TARGET_NORMAL ::
2454   *     This corresponds to the default hinting algorithm, optimized for
2455   *     standard gray-level rendering.  For monochrome output, use
2456   *     @FT_LOAD_TARGET_MONO instead.
2457   *
2458   *   FT_LOAD_TARGET_LIGHT ::
2459   *     A lighter hinting algorithm for non-monochrome modes.  Many
2460   *     generated glyphs are more fuzzy but better resemble its original
2461   *     shape.  A bit like rendering on Mac OS~X.
2462   *
2463   *     As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT.
2464   *
2465   *   FT_LOAD_TARGET_MONO ::
2466   *     Strong hinting algorithm that should only be used for monochrome
2467   *     output.  The result is probably unpleasant if the glyph is rendered
2468   *     in non-monochrome modes.
2469   *
2470   *   FT_LOAD_TARGET_LCD ::
2471   *     A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
2472   *     decimated LCD displays.
2473   *
2474   *   FT_LOAD_TARGET_LCD_V ::
2475   *     A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
2476   *     decimated LCD displays.
2477   *
2478   * @note:
2479   *   You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
2480   *   `load_flags'.  They can't be ORed.
2481   *
2482   *   If @FT_LOAD_RENDER is also set, the glyph is rendered in the
2483   *   corresponding mode (i.e., the mode which matches the used algorithm
2484   *   best) unless @FT_LOAD_MONOCHROME is set.
2485   *
2486   *   You can use a hinting algorithm that doesn't correspond to the same
2487   *   rendering mode.  As an example, it is possible to use the `light'
2488   *   hinting algorithm and have the results rendered in horizontal LCD
2489   *   pixel mode, with code like
2490   *
2491   *     {
2492   *       FT_Load_Glyph( face, glyph_index,
2493   *                      load_flags | FT_LOAD_TARGET_LIGHT );
2494   *
2495   *       FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
2496   *     }
2497   */
2498
2499#define FT_LOAD_TARGET_( x )      ( (FT_Int32)( (x) & 15 ) << 16 )
2500
2501#define FT_LOAD_TARGET_NORMAL     FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL )
2502#define FT_LOAD_TARGET_LIGHT      FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT  )
2503#define FT_LOAD_TARGET_MONO       FT_LOAD_TARGET_( FT_RENDER_MODE_MONO   )
2504#define FT_LOAD_TARGET_LCD        FT_LOAD_TARGET_( FT_RENDER_MODE_LCD    )
2505#define FT_LOAD_TARGET_LCD_V      FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V  )
2506
2507
2508  /**************************************************************************
2509   *
2510   * @macro:
2511   *   FT_LOAD_TARGET_MODE
2512   *
2513   * @description:
2514   *   Return the @FT_Render_Mode corresponding to a given
2515   *   @FT_LOAD_TARGET_XXX value.
2516   *
2517   */
2518
2519#define FT_LOAD_TARGET_MODE( x )  ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
2520
2521
2522  /*************************************************************************/
2523  /*                                                                       */
2524  /* <Function>                                                            */
2525  /*    FT_Set_Transform                                                   */
2526  /*                                                                       */
2527  /* <Description>                                                         */
2528  /*    A function used to set the transformation that is applied to glyph */
2529  /*    images when they are loaded into a glyph slot through              */
2530  /*    @FT_Load_Glyph.                                                    */
2531  /*                                                                       */
2532  /* <InOut>                                                               */
2533  /*    face   :: A handle to the source face object.                      */
2534  /*                                                                       */
2535  /* <Input>                                                               */
2536  /*    matrix :: A pointer to the transformation's 2x2 matrix.  Use~0 for */
2537  /*              the identity matrix.                                     */
2538  /*    delta  :: A pointer to the translation vector.  Use~0 for the null */
2539  /*              vector.                                                  */
2540  /*                                                                       */
2541  /* <Note>                                                                */
2542  /*    The transformation is only applied to scalable image formats after */
2543  /*    the glyph has been loaded.  It means that hinting is unaltered by  */
2544  /*    the transformation and is performed on the character size given in */
2545  /*    the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes.         */
2546  /*                                                                       */
2547  /*    Note that this also transforms the `face.glyph.advance' field, but */
2548  /*    *not* the values in `face.glyph.metrics'.                          */
2549  /*                                                                       */
2550  FT_EXPORT( void )
2551  FT_Set_Transform( FT_Face     face,
2552                    FT_Matrix*  matrix,
2553                    FT_Vector*  delta );
2554
2555
2556  /*************************************************************************/
2557  /*                                                                       */
2558  /* <Enum>                                                                */
2559  /*    FT_Render_Mode                                                     */
2560  /*                                                                       */
2561  /* <Description>                                                         */
2562  /*    An enumeration type that lists the render modes supported by       */
2563  /*    FreeType~2.  Each mode corresponds to a specific type of scanline  */
2564  /*    conversion performed on the outline.                               */
2565  /*                                                                       */
2566  /*    For bitmap fonts the `bitmap->pixel_mode' field in the             */
2567  /*    @FT_GlyphSlotRec structure gives the format of the returned        */
2568  /*    bitmap.                                                            */
2569  /*                                                                       */
2570  /*    All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity.   */
2571  /*                                                                       */
2572  /* <Values>                                                              */
2573  /*    FT_RENDER_MODE_NORMAL ::                                           */
2574  /*      This is the default render mode; it corresponds to 8-bit         */
2575  /*      anti-aliased bitmaps.                                            */
2576  /*                                                                       */
2577  /*    FT_RENDER_MODE_LIGHT ::                                            */
2578  /*      This is equivalent to @FT_RENDER_MODE_NORMAL.  It is only        */
2579  /*      defined as a separate value because render modes are also used   */
2580  /*      indirectly to define hinting algorithm selectors.  See           */
2581  /*      @FT_LOAD_TARGET_XXX for details.                                 */
2582  /*                                                                       */
2583  /*    FT_RENDER_MODE_MONO ::                                             */
2584  /*      This mode corresponds to 1-bit bitmaps (with 2~levels of         */
2585  /*      opacity).                                                        */
2586  /*                                                                       */
2587  /*    FT_RENDER_MODE_LCD ::                                              */
2588  /*      This mode corresponds to horizontal RGB and BGR sub-pixel        */
2589  /*      displays, like LCD-screens.  It produces 8-bit bitmaps that are  */
2590  /*      3~times the width of the original glyph outline in pixels, and   */
2591  /*      which use the @FT_PIXEL_MODE_LCD mode.                           */
2592  /*                                                                       */
2593  /*    FT_RENDER_MODE_LCD_V ::                                            */
2594  /*      This mode corresponds to vertical RGB and BGR sub-pixel displays */
2595  /*      (like PDA screens, rotated LCD displays, etc.).  It produces     */
2596  /*      8-bit bitmaps that are 3~times the height of the original        */
2597  /*      glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode.   */
2598  /*                                                                       */
2599  /* <Note>                                                                */
2600  /*   The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be  */
2601  /*   filtered to reduce color-fringes by using @FT_Library_SetLcdFilter  */
2602  /*   (not active in the default builds).  It is up to the caller to      */
2603  /*   either call @FT_Library_SetLcdFilter (if available) or do the       */
2604  /*   filtering itself.                                                   */
2605  /*                                                                       */
2606  typedef enum  FT_Render_Mode_
2607  {
2608    FT_RENDER_MODE_NORMAL = 0,
2609    FT_RENDER_MODE_LIGHT,
2610    FT_RENDER_MODE_MONO,
2611    FT_RENDER_MODE_LCD,
2612    FT_RENDER_MODE_LCD_V,
2613
2614    FT_RENDER_MODE_MAX
2615
2616  } FT_Render_Mode;
2617
2618
2619  /*************************************************************************/
2620  /*                                                                       */
2621  /* <Enum>                                                                */
2622  /*    ft_render_mode_xxx                                                 */
2623  /*                                                                       */
2624  /* <Description>                                                         */
2625  /*    These constants are deprecated.  Use the corresponding             */
2626  /*    @FT_Render_Mode values instead.                                    */
2627  /*                                                                       */
2628  /* <Values>                                                              */
2629  /*   ft_render_mode_normal :: see @FT_RENDER_MODE_NORMAL                 */
2630  /*   ft_render_mode_mono   :: see @FT_RENDER_MODE_MONO                   */
2631  /*                                                                       */
2632#define ft_render_mode_normal  FT_RENDER_MODE_NORMAL
2633#define ft_render_mode_mono    FT_RENDER_MODE_MONO
2634
2635
2636  /*************************************************************************/
2637  /*                                                                       */
2638  /* <Function>                                                            */
2639  /*    FT_Render_Glyph                                                    */
2640  /*                                                                       */
2641  /* <Description>                                                         */
2642  /*    Convert a given glyph image to a bitmap.  It does so by inspecting */
2643  /*    the glyph image format, finding the relevant renderer, and         */
2644  /*    invoking it.                                                       */
2645  /*                                                                       */
2646  /* <InOut>                                                               */
2647  /*    slot        :: A handle to the glyph slot containing the image to  */
2648  /*                   convert.                                            */
2649  /*                                                                       */
2650  /* <Input>                                                               */
2651  /*    render_mode :: This is the render mode used to render the glyph    */
2652  /*                   image into a bitmap.  See @FT_Render_Mode for a     */
2653  /*                   list of possible values.                            */
2654  /*                                                                       */
2655  /* <Return>                                                              */
2656  /*    FreeType error code.  0~means success.                             */
2657  /*                                                                       */
2658  FT_EXPORT( FT_Error )
2659  FT_Render_Glyph( FT_GlyphSlot    slot,
2660                   FT_Render_Mode  render_mode );
2661
2662
2663  /*************************************************************************/
2664  /*                                                                       */
2665  /* <Enum>                                                                */
2666  /*    FT_Kerning_Mode                                                    */
2667  /*                                                                       */
2668  /* <Description>                                                         */
2669  /*    An enumeration used to specify which kerning values to return in   */
2670  /*    @FT_Get_Kerning.                                                   */
2671  /*                                                                       */
2672  /* <Values>                                                              */
2673  /*    FT_KERNING_DEFAULT  :: Return scaled and grid-fitted kerning       */
2674  /*                           distances (value is~0).                     */
2675  /*                                                                       */
2676  /*    FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning    */
2677  /*                           distances.                                  */
2678  /*                                                                       */
2679  /*    FT_KERNING_UNSCALED :: Return the kerning vector in original font  */
2680  /*                           units.                                      */
2681  /*                                                                       */
2682  typedef enum  FT_Kerning_Mode_
2683  {
2684    FT_KERNING_DEFAULT  = 0,
2685    FT_KERNING_UNFITTED,
2686    FT_KERNING_UNSCALED
2687
2688  } FT_Kerning_Mode;
2689
2690
2691  /*************************************************************************/
2692  /*                                                                       */
2693  /* <Const>                                                               */
2694  /*    ft_kerning_default                                                 */
2695  /*                                                                       */
2696  /* <Description>                                                         */
2697  /*    This constant is deprecated.  Please use @FT_KERNING_DEFAULT       */
2698  /*    instead.                                                           */
2699  /*                                                                       */
2700#define ft_kerning_default   FT_KERNING_DEFAULT
2701
2702
2703  /*************************************************************************/
2704  /*                                                                       */
2705  /* <Const>                                                               */
2706  /*    ft_kerning_unfitted                                                */
2707  /*                                                                       */
2708  /* <Description>                                                         */
2709  /*    This constant is deprecated.  Please use @FT_KERNING_UNFITTED      */
2710  /*    instead.                                                           */
2711  /*                                                                       */
2712#define ft_kerning_unfitted  FT_KERNING_UNFITTED
2713
2714
2715  /*************************************************************************/
2716  /*                                                                       */
2717  /* <Const>                                                               */
2718  /*    ft_kerning_unscaled                                                */
2719  /*                                                                       */
2720  /* <Description>                                                         */
2721  /*    This constant is deprecated.  Please use @FT_KERNING_UNSCALED      */
2722  /*    instead.                                                           */
2723  /*                                                                       */
2724#define ft_kerning_unscaled  FT_KERNING_UNSCALED
2725
2726
2727  /*************************************************************************/
2728  /*                                                                       */
2729  /* <Function>                                                            */
2730  /*    FT_Get_Kerning                                                     */
2731  /*                                                                       */
2732  /* <Description>                                                         */
2733  /*    Return the kerning vector between two glyphs of a same face.       */
2734  /*                                                                       */
2735  /* <Input>                                                               */
2736  /*    face        :: A handle to a source face object.                   */
2737  /*                                                                       */
2738  /*    left_glyph  :: The index of the left glyph in the kern pair.       */
2739  /*                                                                       */
2740  /*    right_glyph :: The index of the right glyph in the kern pair.      */
2741  /*                                                                       */
2742  /*    kern_mode   :: See @FT_Kerning_Mode for more information.          */
2743  /*                   Determines the scale and dimension of the returned  */
2744  /*                   kerning vector.                                     */
2745  /*                                                                       */
2746  /* <Output>                                                              */
2747  /*    akerning    :: The kerning vector.  This is either in font units   */
2748  /*                   or in pixels (26.6 format) for scalable formats,    */
2749  /*                   and in pixels for fixed-sizes formats.              */
2750  /*                                                                       */
2751  /* <Return>                                                              */
2752  /*    FreeType error code.  0~means success.                             */
2753  /*                                                                       */
2754  /* <Note>                                                                */
2755  /*    Only horizontal layouts (left-to-right & right-to-left) are        */
2756  /*    supported by this method.  Other layouts, or more sophisticated    */
2757  /*    kernings, are out of the scope of this API function -- they can be */
2758  /*    implemented through format-specific interfaces.                    */
2759  /*                                                                       */
2760  FT_EXPORT( FT_Error )
2761  FT_Get_Kerning( FT_Face     face,
2762                  FT_UInt     left_glyph,
2763                  FT_UInt     right_glyph,
2764                  FT_UInt     kern_mode,
2765                  FT_Vector  *akerning );
2766
2767
2768  /*************************************************************************/
2769  /*                                                                       */
2770  /* <Function>                                                            */
2771  /*    FT_Get_Track_Kerning                                               */
2772  /*                                                                       */
2773  /* <Description>                                                         */
2774  /*    Return the track kerning for a given face object at a given size.  */
2775  /*                                                                       */
2776  /* <Input>                                                               */
2777  /*    face        :: A handle to a source face object.                   */
2778  /*                                                                       */
2779  /*    point_size  :: The point size in 16.16 fractional points.          */
2780  /*                                                                       */
2781  /*    degree      :: The degree of tightness.                            */
2782  /*                                                                       */
2783  /* <Output>                                                              */
2784  /*    akerning    :: The kerning in 16.16 fractional points.             */
2785  /*                                                                       */
2786  /* <Return>                                                              */
2787  /*    FreeType error code.  0~means success.                             */
2788  /*                                                                       */
2789  FT_EXPORT( FT_Error )
2790  FT_Get_Track_Kerning( FT_Face    face,
2791                        FT_Fixed   point_size,
2792                        FT_Int     degree,
2793                        FT_Fixed*  akerning );
2794
2795
2796  /*************************************************************************/
2797  /*                                                                       */
2798  /* <Function>                                                            */
2799  /*    FT_Get_Glyph_Name                                                  */
2800  /*                                                                       */
2801  /* <Description>                                                         */
2802  /*    Retrieve the ASCII name of a given glyph in a face.  This only     */
2803  /*    works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1.   */
2804  /*                                                                       */
2805  /* <Input>                                                               */
2806  /*    face        :: A handle to a source face object.                   */
2807  /*                                                                       */
2808  /*    glyph_index :: The glyph index.                                    */
2809  /*                                                                       */
2810  /*    buffer_max  :: The maximal number of bytes available in the        */
2811  /*                   buffer.                                             */
2812  /*                                                                       */
2813  /* <Output>                                                              */
2814  /*    buffer      :: A pointer to a target buffer where the name is      */
2815  /*                   copied to.                                          */
2816  /*                                                                       */
2817  /* <Return>                                                              */
2818  /*    FreeType error code.  0~means success.                             */
2819  /*                                                                       */
2820  /* <Note>                                                                */
2821  /*    An error is returned if the face doesn't provide glyph names or if */
2822  /*    the glyph index is invalid.  In all cases of failure, the first    */
2823  /*    byte of `buffer' is set to~0 to indicate an empty name.            */
2824  /*                                                                       */
2825  /*    The glyph name is truncated to fit within the buffer if it is too  */
2826  /*    long.  The returned string is always zero-terminated.              */
2827  /*                                                                       */
2828  /*    This function is not compiled within the library if the config     */
2829  /*    macro `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is defined in              */
2830  /*    `include/freetype/config/ftoptions.h'.                             */
2831  /*                                                                       */
2832  FT_EXPORT( FT_Error )
2833  FT_Get_Glyph_Name( FT_Face     face,
2834                     FT_UInt     glyph_index,
2835                     FT_Pointer  buffer,
2836                     FT_UInt     buffer_max );
2837
2838
2839  /*************************************************************************/
2840  /*                                                                       */
2841  /* <Function>                                                            */
2842  /*    FT_Get_Postscript_Name                                             */
2843  /*                                                                       */
2844  /* <Description>                                                         */
2845  /*    Retrieve the ASCII PostScript name of a given face, if available.  */
2846  /*    This only works with PostScript and TrueType fonts.                */
2847  /*                                                                       */
2848  /* <Input>                                                               */
2849  /*    face :: A handle to the source face object.                        */
2850  /*                                                                       */
2851  /* <Return>                                                              */
2852  /*    A pointer to the face's PostScript name.  NULL if unavailable.     */
2853  /*                                                                       */
2854  /* <Note>                                                                */
2855  /*    The returned pointer is owned by the face and is destroyed with    */
2856  /*    it.                                                                */
2857  /*                                                                       */
2858  FT_EXPORT( const char* )
2859  FT_Get_Postscript_Name( FT_Face  face );
2860
2861
2862  /*************************************************************************/
2863  /*                                                                       */
2864  /* <Function>                                                            */
2865  /*    FT_Select_Charmap                                                  */
2866  /*                                                                       */
2867  /* <Description>                                                         */
2868  /*    Select a given charmap by its encoding tag (as listed in           */
2869  /*    `freetype.h').                                                     */
2870  /*                                                                       */
2871  /* <InOut>                                                               */
2872  /*    face     :: A handle to the source face object.                    */
2873  /*                                                                       */
2874  /* <Input>                                                               */
2875  /*    encoding :: A handle to the selected encoding.                     */
2876  /*                                                                       */
2877  /* <Return>                                                              */
2878  /*    FreeType error code.  0~means success.                             */
2879  /*                                                                       */
2880  /* <Note>                                                                */
2881  /*    This function returns an error if no charmap in the face           */
2882  /*    corresponds to the encoding queried here.                          */
2883  /*                                                                       */
2884  /*    Because many fonts contain more than a single cmap for Unicode     */
2885  /*    encoding, this function has some special code to select the one    */
2886  /*    which covers Unicode best (`best' in the sense that a UCS-4 cmap   */
2887  /*    is preferred to a UCS-2 cmap).  It is thus preferable to           */
2888  /*    @FT_Set_Charmap in this case.                                      */
2889  /*                                                                       */
2890  FT_EXPORT( FT_Error )
2891  FT_Select_Charmap( FT_Face      face,
2892                     FT_Encoding  encoding );
2893
2894
2895  /*************************************************************************/
2896  /*                                                                       */
2897  /* <Function>                                                            */
2898  /*    FT_Set_Charmap                                                     */
2899  /*                                                                       */
2900  /* <Description>                                                         */
2901  /*    Select a given charmap for character code to glyph index mapping.  */
2902  /*                                                                       */
2903  /* <InOut>                                                               */
2904  /*    face    :: A handle to the source face object.                     */
2905  /*                                                                       */
2906  /* <Input>                                                               */
2907  /*    charmap :: A handle to the selected charmap.                       */
2908  /*                                                                       */
2909  /* <Return>                                                              */
2910  /*    FreeType error code.  0~means success.                             */
2911  /*                                                                       */
2912  /* <Note>                                                                */
2913  /*    This function returns an error if the charmap is not part of       */
2914  /*    the face (i.e., if it is not listed in the `face->charmaps'        */
2915  /*    table).                                                            */
2916  /*                                                                       */
2917  /*    It also fails if a type~14 charmap is selected.                    */
2918  /*                                                                       */
2919  FT_EXPORT( FT_Error )
2920  FT_Set_Charmap( FT_Face     face,
2921                  FT_CharMap  charmap );
2922
2923
2924  /*************************************************************************
2925   *
2926   * @function:
2927   *   FT_Get_Charmap_Index
2928   *
2929   * @description:
2930   *   Retrieve index of a given charmap.
2931   *
2932   * @input:
2933   *   charmap ::
2934   *     A handle to a charmap.
2935   *
2936   * @return:
2937   *   The index into the array of character maps within the face to which
2938   *   `charmap' belongs.
2939   *
2940   */
2941  FT_EXPORT( FT_Int )
2942  FT_Get_Charmap_Index( FT_CharMap  charmap );
2943
2944
2945  /*************************************************************************/
2946  /*                                                                       */
2947  /* <Function>                                                            */
2948  /*    FT_Get_Char_Index                                                  */
2949  /*                                                                       */
2950  /* <Description>                                                         */
2951  /*    Return the glyph index of a given character code.  This function   */
2952  /*    uses a charmap object to do the mapping.                           */
2953  /*                                                                       */
2954  /* <Input>                                                               */
2955  /*    face     :: A handle to the source face object.                    */
2956  /*                                                                       */
2957  /*    charcode :: The character code.                                    */
2958  /*                                                                       */
2959  /* <Return>                                                              */
2960  /*    The glyph index.  0~means `undefined character code'.              */
2961  /*                                                                       */
2962  /* <Note>                                                                */
2963  /*    If you use FreeType to manipulate the contents of font files       */
2964  /*    directly, be aware that the glyph index returned by this function  */
2965  /*    doesn't always correspond to the internal indices used within      */
2966  /*    the file.  This is done to ensure that value~0 always corresponds  */
2967  /*    to the `missing glyph'.                                            */
2968  /*                                                                       */
2969  FT_EXPORT( FT_UInt )
2970  FT_Get_Char_Index( FT_Face   face,
2971                     FT_ULong  charcode );
2972
2973
2974  /*************************************************************************/
2975  /*                                                                       */
2976  /* <Function>                                                            */
2977  /*    FT_Get_First_Char                                                  */
2978  /*                                                                       */
2979  /* <Description>                                                         */
2980  /*    This function is used to return the first character code in the    */
2981  /*    current charmap of a given face.  It also returns the              */
2982  /*    corresponding glyph index.                                         */
2983  /*                                                                       */
2984  /* <Input>                                                               */
2985  /*    face    :: A handle to the source face object.                     */
2986  /*                                                                       */
2987  /* <Output>                                                              */
2988  /*    agindex :: Glyph index of first character code.  0~if charmap is   */
2989  /*               empty.                                                  */
2990  /*                                                                       */
2991  /* <Return>                                                              */
2992  /*    The charmap's first character code.                                */
2993  /*                                                                       */
2994  /* <Note>                                                                */
2995  /*    You should use this function with @FT_Get_Next_Char to be able to  */
2996  /*    parse all character codes available in a given charmap.  The code  */
2997  /*    should look like this:                                             */
2998  /*                                                                       */
2999  /*    {                                                                  */
3000  /*      FT_ULong  charcode;                                              */
3001  /*      FT_UInt   gindex;                                                */
3002  /*                                                                       */
3003  /*                                                                       */
3004  /*      charcode = FT_Get_First_Char( face, &gindex );                   */
3005  /*      while ( gindex != 0 )                                            */
3006  /*      {                                                                */
3007  /*        ... do something with (charcode,gindex) pair ...               */
3008  /*                                                                       */
3009  /*        charcode = FT_Get_Next_Char( face, charcode, &gindex );        */
3010  /*      }                                                                */
3011  /*    }                                                                  */
3012  /*                                                                       */
3013  /*    Note that `*agindex' is set to~0 if the charmap is empty.  The     */
3014  /*    result itself can be~0 in two cases: if the charmap is empty or    */
3015  /*    when the value~0 is the first valid character code.                */
3016  /*                                                                       */
3017  FT_EXPORT( FT_ULong )
3018  FT_Get_First_Char( FT_Face   face,
3019                     FT_UInt  *agindex );
3020
3021
3022  /*************************************************************************/
3023  /*                                                                       */
3024  /* <Function>                                                            */
3025  /*    FT_Get_Next_Char                                                   */
3026  /*                                                                       */
3027  /* <Description>                                                         */
3028  /*    This function is used to return the next character code in the     */
3029  /*    current charmap of a given face following the value `char_code',   */
3030  /*    as well as the corresponding glyph index.                          */
3031  /*                                                                       */
3032  /* <Input>                                                               */
3033  /*    face      :: A handle to the source face object.                   */
3034  /*    char_code :: The starting character code.                          */
3035  /*                                                                       */
3036  /* <Output>                                                              */
3037  /*    agindex   :: Glyph index of first character code.  0~if charmap    */
3038  /*                 is empty.                                             */
3039  /*                                                                       */
3040  /* <Return>                                                              */
3041  /*    The charmap's next character code.                                 */
3042  /*                                                                       */
3043  /* <Note>                                                                */
3044  /*    You should use this function with @FT_Get_First_Char to walk       */
3045  /*    over all character codes available in a given charmap.  See the    */
3046  /*    note for this function for a simple code example.                  */
3047  /*                                                                       */
3048  /*    Note that `*agindex' is set to~0 when there are no more codes in   */
3049  /*    the charmap.                                                       */
3050  /*                                                                       */
3051  FT_EXPORT( FT_ULong )
3052  FT_Get_Next_Char( FT_Face    face,
3053                    FT_ULong   char_code,
3054                    FT_UInt   *agindex );
3055
3056
3057  /*************************************************************************/
3058  /*                                                                       */
3059  /* <Function>                                                            */
3060  /*    FT_Get_Name_Index                                                  */
3061  /*                                                                       */
3062  /* <Description>                                                         */
3063  /*    Return the glyph index of a given glyph name.  This function uses  */
3064  /*    driver specific objects to do the translation.                     */
3065  /*                                                                       */
3066  /* <Input>                                                               */
3067  /*    face       :: A handle to the source face object.                  */
3068  /*                                                                       */
3069  /*    glyph_name :: The glyph name.                                      */
3070  /*                                                                       */
3071  /* <Return>                                                              */
3072  /*    The glyph index.  0~means `undefined character code'.              */
3073  /*                                                                       */
3074  FT_EXPORT( FT_UInt )
3075  FT_Get_Name_Index( FT_Face     face,
3076                     FT_String*  glyph_name );
3077
3078
3079  /*************************************************************************
3080   *
3081   * @macro:
3082   *   FT_SUBGLYPH_FLAG_XXX
3083   *
3084   * @description:
3085   *   A list of constants used to describe subglyphs.  Please refer to the
3086   *   TrueType specification for the meaning of the various flags.
3087   *
3088   * @values:
3089   *   FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
3090   *   FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
3091   *   FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
3092   *   FT_SUBGLYPH_FLAG_SCALE ::
3093   *   FT_SUBGLYPH_FLAG_XY_SCALE ::
3094   *   FT_SUBGLYPH_FLAG_2X2 ::
3095   *   FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
3096   *
3097   */
3098#define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS          1
3099#define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES      2
3100#define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID        4
3101#define FT_SUBGLYPH_FLAG_SCALE                   8
3102#define FT_SUBGLYPH_FLAG_XY_SCALE             0x40
3103#define FT_SUBGLYPH_FLAG_2X2                  0x80
3104#define FT_SUBGLYPH_FLAG_USE_MY_METRICS      0x200
3105
3106
3107  /*************************************************************************
3108   *
3109   * @func:
3110   *   FT_Get_SubGlyph_Info
3111   *
3112   * @description:
3113   *   Retrieve a description of a given subglyph.  Only use it if
3114   *   `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE, or an error is
3115   *   returned.
3116   *
3117   * @input:
3118   *   glyph ::
3119   *     The source glyph slot.
3120   *
3121   *   sub_index ::
3122   *     The index of subglyph.  Must be less than `glyph->num_subglyphs'.
3123   *
3124   * @output:
3125   *   p_index ::
3126   *     The glyph index of the subglyph.
3127   *
3128   *   p_flags ::
3129   *     The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
3130   *
3131   *   p_arg1 ::
3132   *     The subglyph's first argument (if any).
3133   *
3134   *   p_arg2 ::
3135   *     The subglyph's second argument (if any).
3136   *
3137   *   p_transform ::
3138   *     The subglyph transformation (if any).
3139   *
3140   * @return:
3141   *   FreeType error code.  0~means success.
3142   *
3143   * @note:
3144   *   The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
3145   *   interpreted depending on the flags returned in `*p_flags'.  See the
3146   *   TrueType specification for details.
3147   *
3148   */
3149  FT_EXPORT( FT_Error )
3150  FT_Get_SubGlyph_Info( FT_GlyphSlot  glyph,
3151                        FT_UInt       sub_index,
3152                        FT_Int       *p_index,
3153                        FT_UInt      *p_flags,
3154                        FT_Int       *p_arg1,
3155                        FT_Int       *p_arg2,
3156                        FT_Matrix    *p_transform );
3157
3158
3159  /*************************************************************************/
3160  /*                                                                       */
3161  /* <Section>                                                             */
3162  /*    glyph_variants                                                     */
3163  /*                                                                       */
3164  /* <Title>                                                               */
3165  /*    Glyph Variants                                                     */
3166  /*                                                                       */
3167  /* <Abstract>                                                            */
3168  /*    The FreeType~2 interface to Unicode Ideographic Variation          */
3169  /*    Sequences (IVS), using the SFNT cmap format~14.                    */
3170  /*                                                                       */
3171  /* <Description>                                                         */
3172  /*    Many CJK characters have variant forms.  They are a sort of grey   */
3173  /*    area somewhere between being totally irrelevant and semantically   */
3174  /*    distinct; for this reason, the Unicode consortium decided to       */
3175  /*    introduce Ideographic Variation Sequences (IVS), consisting of a   */
3176  /*    Unicode base character and one of 240 variant selectors            */
3177  /*    (U+E0100-U+E01EF), instead of further extending the already huge   */
3178  /*    code range for CJK characters.                                     */
3179  /*                                                                       */
3180  /*    An IVS is registered and unique; for further details please refer  */
3181  /*    to Unicode Technical Report #37, the Ideographic Variation         */
3182  /*    Database.  To date (October 2007), the character with the most     */
3183  /*    variants is U+908A, having 8~such IVS.                             */
3184  /*                                                                       */
3185  /*    Adobe and MS decided to support IVS with a new cmap subtable       */
3186  /*    (format~14).  It is an odd subtable because it is not a mapping of */
3187  /*    input code points to glyphs, but contains lists of all variants    */
3188  /*    supported by the font.                                             */
3189  /*                                                                       */
3190  /*    A variant may be either `default' or `non-default'.  A default     */
3191  /*    variant is the one you will get for that code point if you look it */
3192  /*    up in the standard Unicode cmap.  A non-default variant is a       */
3193  /*    different glyph.                                                   */
3194  /*                                                                       */
3195  /*************************************************************************/
3196
3197
3198  /*************************************************************************/
3199  /*                                                                       */
3200  /* <Function>                                                            */
3201  /*    FT_Face_GetCharVariantIndex                                        */
3202  /*                                                                       */
3203  /* <Description>                                                         */
3204  /*    Return the glyph index of a given character code as modified by    */
3205  /*    the variation selector.                                            */
3206  /*                                                                       */
3207  /* <Input>                                                               */
3208  /*    face ::                                                            */
3209  /*      A handle to the source face object.                              */
3210  /*                                                                       */
3211  /*    charcode ::                                                        */
3212  /*      The character code point in Unicode.                             */
3213  /*                                                                       */
3214  /*    variantSelector ::                                                 */
3215  /*      The Unicode code point of the variation selector.                */
3216  /*                                                                       */
3217  /* <Return>                                                              */
3218  /*    The glyph index.  0~means either `undefined character code', or    */
3219  /*    `undefined selector code', or `no variation selector cmap          */
3220  /*    subtable', or `current CharMap is not Unicode'.                    */
3221  /*                                                                       */
3222  /* <Note>                                                                */
3223  /*    If you use FreeType to manipulate the contents of font files       */
3224  /*    directly, be aware that the glyph index returned by this function  */
3225  /*    doesn't always correspond to the internal indices used within      */
3226  /*    the file.  This is done to ensure that value~0 always corresponds  */
3227  /*    to the `missing glyph'.                                            */
3228  /*                                                                       */
3229  /*    This function is only meaningful if                                */
3230  /*      a) the font has a variation selector cmap sub table,             */
3231  /*    and                                                                */
3232  /*      b) the current charmap has a Unicode encoding.                   */
3233  /*                                                                       */
3234  /* <Since>                                                               */
3235  /*    2.3.6                                                              */
3236  /*                                                                       */
3237  FT_EXPORT( FT_UInt )
3238  FT_Face_GetCharVariantIndex( FT_Face   face,
3239                               FT_ULong  charcode,
3240                               FT_ULong  variantSelector );
3241
3242
3243  /*************************************************************************/
3244  /*                                                                       */
3245  /* <Function>                                                            */
3246  /*    FT_Face_GetCharVariantIsDefault                                    */
3247  /*                                                                       */
3248  /* <Description>                                                         */
3249  /*    Check whether this variant of this Unicode character is the one to */
3250  /*    be found in the `cmap'.                                            */
3251  /*                                                                       */
3252  /* <Input>                                                               */
3253  /*    face ::                                                            */
3254  /*      A handle to the source face object.                              */
3255  /*                                                                       */
3256  /*    charcode ::                                                        */
3257  /*      The character codepoint in Unicode.                              */
3258  /*                                                                       */
3259  /*    variantSelector ::                                                 */
3260  /*      The Unicode codepoint of the variation selector.                 */
3261  /*                                                                       */
3262  /* <Return>                                                              */
3263  /*    1~if found in the standard (Unicode) cmap, 0~if found in the       */
3264  /*    variation selector cmap, or -1 if it is not a variant.             */
3265  /*                                                                       */
3266  /* <Note>                                                                */
3267  /*    This function is only meaningful if the font has a variation       */
3268  /*    selector cmap subtable.                                            */
3269  /*                                                                       */
3270  /* <Since>                                                               */
3271  /*    2.3.6                                                              */
3272  /*                                                                       */
3273  FT_EXPORT( FT_Int )
3274  FT_Face_GetCharVariantIsDefault( FT_Face   face,
3275                                   FT_ULong  charcode,
3276                                   FT_ULong  variantSelector );
3277
3278
3279  /*************************************************************************/
3280  /*                                                                       */
3281  /* <Function>                                                            */
3282  /*    FT_Face_GetVariantSelectors                                        */
3283  /*                                                                       */
3284  /* <Description>                                                         */
3285  /*    Return a zero-terminated list of Unicode variant selectors found   */
3286  /*    in the font.                                                       */
3287  /*                                                                       */
3288  /* <Input>                                                               */
3289  /*    face ::                                                            */
3290  /*      A handle to the source face object.                              */
3291  /*                                                                       */
3292  /* <Return>                                                              */
3293  /*    A pointer to an array of selector code points, or NULL if there is */
3294  /*    no valid variant selector cmap subtable.                           */
3295  /*                                                                       */
3296  /* <Note>                                                                */
3297  /*    The last item in the array is~0; the array is owned by the         */
3298  /*    @FT_Face object but can be overwritten or released on the next     */
3299  /*    call to a FreeType function.                                       */
3300  /*                                                                       */
3301  /* <Since>                                                               */
3302  /*    2.3.6                                                              */
3303  /*                                                                       */
3304  FT_EXPORT( FT_UInt32* )
3305  FT_Face_GetVariantSelectors( FT_Face  face );
3306
3307
3308  /*************************************************************************/
3309  /*                                                                       */
3310  /* <Function>                                                            */
3311  /*    FT_Face_GetVariantsOfChar                                          */
3312  /*                                                                       */
3313  /* <Description>                                                         */
3314  /*    Return a zero-terminated list of Unicode variant selectors found   */
3315  /*    for the specified character code.                                  */
3316  /*                                                                       */
3317  /* <Input>                                                               */
3318  /*    face ::                                                            */
3319  /*      A handle to the source face object.                              */
3320  /*                                                                       */
3321  /*    charcode ::                                                        */
3322  /*      The character codepoint in Unicode.                              */
3323  /*                                                                       */
3324  /* <Return>                                                              */
3325  /*    A pointer to an array of variant selector code points which are    */
3326  /*    active for the given character, or NULL if the corresponding list  */
3327  /*    is empty.                                                          */
3328  /*                                                                       */
3329  /* <Note>                                                                */
3330  /*    The last item in the array is~0; the array is owned by the         */
3331  /*    @FT_Face object but can be overwritten or released on the next     */
3332  /*    call to a FreeType function.                                       */
3333  /*                                                                       */
3334  /* <Since>                                                               */
3335  /*    2.3.6                                                              */
3336  /*                                                                       */
3337  FT_EXPORT( FT_UInt32* )
3338  FT_Face_GetVariantsOfChar( FT_Face   face,
3339                             FT_ULong  charcode );
3340
3341
3342  /*************************************************************************/
3343  /*                                                                       */
3344  /* <Function>                                                            */
3345  /*    FT_Face_GetCharsOfVariant                                          */
3346  /*                                                                       */
3347  /* <Description>                                                         */
3348  /*    Return a zero-terminated list of Unicode character codes found for */
3349  /*    the specified variant selector.                                    */
3350  /*                                                                       */
3351  /* <Input>                                                               */
3352  /*    face ::                                                            */
3353  /*      A handle to the source face object.                              */
3354  /*                                                                       */
3355  /*    variantSelector ::                                                 */
3356  /*      The variant selector code point in Unicode.                      */
3357  /*                                                                       */
3358  /* <Return>                                                              */
3359  /*    A list of all the code points which are specified by this selector */
3360  /*    (both default and non-default codes are returned) or NULL if there */
3361  /*    is no valid cmap or the variant selector is invalid.               */
3362  /*                                                                       */
3363  /* <Note>                                                                */
3364  /*    The last item in the array is~0; the array is owned by the         */
3365  /*    @FT_Face object but can be overwritten or released on the next     */
3366  /*    call to a FreeType function.                                       */
3367  /*                                                                       */
3368  /* <Since>                                                               */
3369  /*    2.3.6                                                              */
3370  /*                                                                       */
3371  FT_EXPORT( FT_UInt32* )
3372  FT_Face_GetCharsOfVariant( FT_Face   face,
3373                             FT_ULong  variantSelector );
3374
3375
3376  /*************************************************************************/
3377  /*                                                                       */
3378  /* <Section>                                                             */
3379  /*    computations                                                       */
3380  /*                                                                       */
3381  /* <Title>                                                               */
3382  /*    Computations                                                       */
3383  /*                                                                       */
3384  /* <Abstract>                                                            */
3385  /*    Crunching fixed numbers and vectors.                               */
3386  /*                                                                       */
3387  /* <Description>                                                         */
3388  /*    This section contains various functions used to perform            */
3389  /*    computations on 16.16 fixed-float numbers or 2d vectors.           */
3390  /*                                                                       */
3391  /* <Order>                                                               */
3392  /*    FT_MulDiv                                                          */
3393  /*    FT_MulFix                                                          */
3394  /*    FT_DivFix                                                          */
3395  /*    FT_RoundFix                                                        */
3396  /*    FT_CeilFix                                                         */
3397  /*    FT_FloorFix                                                        */
3398  /*    FT_Vector_Transform                                                */
3399  /*    FT_Matrix_Multiply                                                 */
3400  /*    FT_Matrix_Invert                                                   */
3401  /*                                                                       */
3402  /*************************************************************************/
3403
3404
3405  /*************************************************************************/
3406  /*                                                                       */
3407  /* <Function>                                                            */
3408  /*    FT_MulDiv                                                          */
3409  /*                                                                       */
3410  /* <Description>                                                         */
3411  /*    A very simple function used to perform the computation `(a*b)/c'   */
3412  /*    with maximal accuracy (it uses a 64-bit intermediate integer       */
3413  /*    whenever necessary).                                               */
3414  /*                                                                       */
3415  /*    This function isn't necessarily as fast as some processor specific */
3416  /*    operations, but is at least completely portable.                   */
3417  /*                                                                       */
3418  /* <Input>                                                               */
3419  /*    a :: The first multiplier.                                         */
3420  /*    b :: The second multiplier.                                        */
3421  /*    c :: The divisor.                                                  */
3422  /*                                                                       */
3423  /* <Return>                                                              */
3424  /*    The result of `(a*b)/c'.  This function never traps when trying to */
3425  /*    divide by zero; it simply returns `MaxInt' or `MinInt' depending   */
3426  /*    on the signs of `a' and `b'.                                       */
3427  /*                                                                       */
3428  FT_EXPORT( FT_Long )
3429  FT_MulDiv( FT_Long  a,
3430             FT_Long  b,
3431             FT_Long  c );
3432
3433
3434  /*************************************************************************/
3435  /*                                                                       */
3436  /* <Function>                                                            */
3437  /*    FT_MulFix                                                          */
3438  /*                                                                       */
3439  /* <Description>                                                         */
3440  /*    A very simple function used to perform the computation             */
3441  /*    `(a*b)/0x10000' with maximal accuracy.  Most of the time this is   */
3442  /*    used to multiply a given value by a 16.16 fixed float factor.      */
3443  /*                                                                       */
3444  /* <Input>                                                               */
3445  /*    a :: The first multiplier.                                         */
3446  /*    b :: The second multiplier.  Use a 16.16 factor here whenever      */
3447  /*         possible (see note below).                                    */
3448  /*                                                                       */
3449  /* <Return>                                                              */
3450  /*    The result of `(a*b)/0x10000'.                                     */
3451  /*                                                                       */
3452  /* <Note>                                                                */
3453  /*    This function has been optimized for the case where the absolute   */
3454  /*    value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */
3455  /*    As this happens mainly when scaling from notional units to         */
3456  /*    fractional pixels in FreeType, it resulted in noticeable speed     */
3457  /*    improvements between versions 2.x and 1.x.                         */
3458  /*                                                                       */
3459  /*    As a conclusion, always try to place a 16.16 factor as the         */
3460  /*    _second_ argument of this function; this can make a great          */
3461  /*    difference.                                                        */
3462  /*                                                                       */
3463  FT_EXPORT( FT_Long )
3464  FT_MulFix( FT_Long  a,
3465             FT_Long  b );
3466
3467
3468  /*************************************************************************/
3469  /*                                                                       */
3470  /* <Function>                                                            */
3471  /*    FT_DivFix                                                          */
3472  /*                                                                       */
3473  /* <Description>                                                         */
3474  /*    A very simple function used to perform the computation             */
3475  /*    `(a*0x10000)/b' with maximal accuracy.  Most of the time, this is  */
3476  /*    used to divide a given value by a 16.16 fixed float factor.        */
3477  /*                                                                       */
3478  /* <Input>                                                               */
3479  /*    a :: The first multiplier.                                         */
3480  /*    b :: The second multiplier.  Use a 16.16 factor here whenever      */
3481  /*         possible (see note below).                                    */
3482  /*                                                                       */
3483  /* <Return>                                                              */
3484  /*    The result of `(a*0x10000)/b'.                                     */
3485  /*                                                                       */
3486  /* <Note>                                                                */
3487  /*    The optimization for FT_DivFix() is simple: If (a~<<~16) fits in   */
3488  /*    32~bits, then the division is computed directly.  Otherwise, we    */
3489  /*    use a specialized version of @FT_MulDiv.                           */
3490  /*                                                                       */
3491  FT_EXPORT( FT_Long )
3492  FT_DivFix( FT_Long  a,
3493             FT_Long  b );
3494
3495
3496  /*************************************************************************/
3497  /*                                                                       */
3498  /* <Function>                                                            */
3499  /*    FT_RoundFix                                                        */
3500  /*                                                                       */
3501  /* <Description>                                                         */
3502  /*    A very simple function used to round a 16.16 fixed number.         */
3503  /*                                                                       */
3504  /* <Input>                                                               */
3505  /*    a :: The number to be rounded.                                     */
3506  /*                                                                       */
3507  /* <Return>                                                              */
3508  /*    The result of `(a + 0x8000) & -0x10000'.                           */
3509  /*                                                                       */
3510  FT_EXPORT( FT_Fixed )
3511  FT_RoundFix( FT_Fixed  a );
3512
3513
3514  /*************************************************************************/
3515  /*                                                                       */
3516  /* <Function>                                                            */
3517  /*    FT_CeilFix                                                         */
3518  /*                                                                       */
3519  /* <Description>                                                         */
3520  /*    A very simple function used to compute the ceiling function of a   */
3521  /*    16.16 fixed number.                                                */
3522  /*                                                                       */
3523  /* <Input>                                                               */
3524  /*    a :: The number for which the ceiling function is to be computed.  */
3525  /*                                                                       */
3526  /* <Return>                                                              */
3527  /*    The result of `(a + 0x10000 - 1) & -0x10000'.                      */
3528  /*                                                                       */
3529  FT_EXPORT( FT_Fixed )
3530  FT_CeilFix( FT_Fixed  a );
3531
3532
3533  /*************************************************************************/
3534  /*                                                                       */
3535  /* <Function>                                                            */
3536  /*    FT_FloorFix                                                        */
3537  /*                                                                       */
3538  /* <Description>                                                         */
3539  /*    A very simple function used to compute the floor function of a     */
3540  /*    16.16 fixed number.                                                */
3541  /*                                                                       */
3542  /* <Input>                                                               */
3543  /*    a :: The number for which the floor function is to be computed.    */
3544  /*                                                                       */
3545  /* <Return>                                                              */
3546  /*    The result of `a & -0x10000'.                                      */
3547  /*                                                                       */
3548  FT_EXPORT( FT_Fixed )
3549  FT_FloorFix( FT_Fixed  a );
3550
3551
3552  /*************************************************************************/
3553  /*                                                                       */
3554  /* <Function>                                                            */
3555  /*    FT_Vector_Transform                                                */
3556  /*                                                                       */
3557  /* <Description>                                                         */
3558  /*    Transform a single vector through a 2x2 matrix.                    */
3559  /*                                                                       */
3560  /* <InOut>                                                               */
3561  /*    vector :: The target vector to transform.                          */
3562  /*                                                                       */
3563  /* <Input>                                                               */
3564  /*    matrix :: A pointer to the source 2x2 matrix.                      */
3565  /*                                                                       */
3566  /* <Note>                                                                */
3567  /*    The result is undefined if either `vector' or `matrix' is invalid. */
3568  /*                                                                       */
3569  FT_EXPORT( void )
3570  FT_Vector_Transform( FT_Vector*        vec,
3571                       const FT_Matrix*  matrix );
3572
3573
3574  /*************************************************************************/
3575  /*                                                                       */
3576  /* <Section>                                                             */
3577  /*    version                                                            */
3578  /*                                                                       */
3579  /* <Title>                                                               */
3580  /*    FreeType Version                                                   */
3581  /*                                                                       */
3582  /* <Abstract>                                                            */
3583  /*    Functions and macros related to FreeType versions.                 */
3584  /*                                                                       */
3585  /* <Description>                                                         */
3586  /*    Note that those functions and macros are of limited use because    */
3587  /*    even a new release of FreeType with only documentation changes     */
3588  /*    increases the version number.                                      */
3589  /*                                                                       */
3590  /*************************************************************************/
3591
3592
3593  /*************************************************************************
3594   *
3595   *  @enum:
3596   *    FREETYPE_XXX
3597   *
3598   *  @description:
3599   *    These three macros identify the FreeType source code version.
3600   *    Use @FT_Library_Version to access them at runtime.
3601   *
3602   *  @values:
3603   *    FREETYPE_MAJOR :: The major version number.
3604   *    FREETYPE_MINOR :: The minor version number.
3605   *    FREETYPE_PATCH :: The patch level.
3606   *
3607   *  @note:
3608   *    The version number of FreeType if built as a dynamic link library
3609   *    with the `libtool' package is _not_ controlled by these three
3610   *    macros.
3611   */
3612#define FREETYPE_MAJOR  2
3613#define FREETYPE_MINOR  3
3614#define FREETYPE_PATCH  7
3615
3616
3617  /*************************************************************************/
3618  /*                                                                       */
3619  /* <Function>                                                            */
3620  /*    FT_Library_Version                                                 */
3621  /*                                                                       */
3622  /* <Description>                                                         */
3623  /*    Return the version of the FreeType library being used.  This is    */
3624  /*    useful when dynamically linking to the library, since one cannot   */
3625  /*    use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and               */
3626  /*    @FREETYPE_PATCH.                                                   */
3627  /*                                                                       */
3628  /* <Input>                                                               */
3629  /*    library :: A source library handle.                                */
3630  /*                                                                       */
3631  /* <Output>                                                              */
3632  /*    amajor  :: The major version number.                               */
3633  /*                                                                       */
3634  /*    aminor  :: The minor version number.                               */
3635  /*                                                                       */
3636  /*    apatch  :: The patch version number.                               */
3637  /*                                                                       */
3638  /* <Note>                                                                */
3639  /*    The reason why this function takes a `library' argument is because */
3640  /*    certain programs implement library initialization in a custom way  */
3641  /*    that doesn't use @FT_Init_FreeType.                                */
3642  /*                                                                       */
3643  /*    In such cases, the library version might not be available before   */
3644  /*    the library object has been created.                               */
3645  /*                                                                       */
3646  FT_EXPORT( void )
3647  FT_Library_Version( FT_Library   library,
3648                      FT_Int      *amajor,
3649                      FT_Int      *aminor,
3650                      FT_Int      *apatch );
3651
3652
3653  /*************************************************************************/
3654  /*                                                                       */
3655  /* <Function>                                                            */
3656  /*    FT_Face_CheckTrueTypePatents                                       */
3657  /*                                                                       */
3658  /* <Description>                                                         */
3659  /*    Parse all bytecode instructions of a TrueType font file to check   */
3660  /*    whether any of the patented opcodes are used.  This is only useful */
3661  /*    if you want to be able to use the unpatented hinter with           */
3662  /*    fonts that do *not* use these opcodes.                             */
3663  /*                                                                       */
3664  /*    Note that this function parses *all* glyph instructions in the     */
3665  /*    font file, which may be slow.                                      */
3666  /*                                                                       */
3667  /* <Input>                                                               */
3668  /*    face :: A face handle.                                             */
3669  /*                                                                       */
3670  /* <Return>                                                              */
3671  /*    1~if this is a TrueType font that uses one of the patented         */
3672  /*    opcodes, 0~otherwise.                                              */
3673  /*                                                                       */
3674  /* <Since>                                                               */
3675  /*    2.3.5                                                              */
3676  /*                                                                       */
3677  FT_EXPORT( FT_Bool )
3678  FT_Face_CheckTrueTypePatents( FT_Face  face );
3679
3680
3681  /*************************************************************************/
3682  /*                                                                       */
3683  /* <Function>                                                            */
3684  /*    FT_Face_SetUnpatentedHinting                                       */
3685  /*                                                                       */
3686  /* <Description>                                                         */
3687  /*    Enable or disable the unpatented hinter for a given face.          */
3688  /*    Only enable it if you have determined that the face doesn't        */
3689  /*    use any patented opcodes (see @FT_Face_CheckTrueTypePatents).      */
3690  /*                                                                       */
3691  /* <Input>                                                               */
3692  /*    face  :: A face handle.                                            */
3693  /*                                                                       */
3694  /*    value :: New boolean setting.                                      */
3695  /*                                                                       */
3696  /* <Return>                                                              */
3697  /*    The old setting value.  This will always be false if this is not   */
3698  /*    a SFNT font, or if the unpatented hinter is not compiled in this   */
3699  /*    instance of the library.                                           */
3700  /*                                                                       */
3701  /* <Since>                                                               */
3702  /*    2.3.5                                                              */
3703  /*                                                                       */
3704  FT_EXPORT( FT_Bool )
3705  FT_Face_SetUnpatentedHinting( FT_Face  face,
3706                                FT_Bool  value );
3707
3708  /* */
3709
3710
3711FT_END_HEADER
3712
3713#endif /* __FREETYPE_H__ */
3714
3715
3716/* END */
Note: See TracBrowser for help on using the repository browser.