1 /****************************************************************************
2  *
3  * ftfntfmt.h
4  *
5  *   Support functions for font formats.
6  *
7  * Copyright (C) 2002-2019 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 FTFNTFMT_H_
20 #define FTFNTFMT_H_
21 
22 #include <ft2build.h>
23 #include FT_FREETYPE_H
24 
25 #ifdef FREETYPE_H
26 #error "freetype.h of FreeType 1 has been loaded!"
27 #error "Please fix the directory search order for header files"
28 #error "so that freetype.h of FreeType 2 is found first."
29 #endif
30 
31 
32 FT_BEGIN_HEADER
33 
34 
35   /**************************************************************************
36    *
37    * @section:
38    *  font_formats
39    *
40    * @title:
41    *  Font Formats
42    *
43    * @abstract:
44    *  Getting the font format.
45    *
46    * @description:
47    *  The single function in this section can be used to get the font format.
48    *  Note that this information is not needed normally; however, there are
49    *  special cases (like in PDF devices) where it is important to
50    *  differentiate, in spite of FreeType's uniform API.
51    *
52    */
53 
54 
55   /**************************************************************************
56    *
57    * @function:
58    *  FT_Get_Font_Format
59    *
60    * @description:
61    *  Return a string describing the format of a given face.  Possible values
62    *  are 'TrueType', 'Type~1', 'BDF', 'PCF', 'Type~42', 'CID~Type~1', 'CFF',
63    *  'PFR', and 'Windows~FNT'.
64    *
65    *  The return value is suitable to be used as an X11 FONT_PROPERTY.
66    *
67    * @input:
68    *  face ::
69    *    Input face handle.
70    *
71    * @return:
72    *  Font format string.  `NULL` in case of error.
73    *
74    * @note:
75    *  A deprecated name for the same function is `FT_Get_X11_Font_Format`.
76    */
77   FT_EXPORT( const char* )
78   FT_Get_Font_Format( FT_Face  face );
79 
80 
81   /* deprecated */
82   FT_EXPORT( const char* )
83   FT_Get_X11_Font_Format( FT_Face  face );
84 
85 
86   /* */
87 
88 
89 FT_END_HEADER
90 
91 #endif /* FTFNTFMT_H_ */
92 
93 
94 /* END */
95