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

Last change on this file since 274 was 274, checked in by rbri, 12 years ago

PDF plugin: freetype library updated to version 2.3.11

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