1 /***************************************************************************/ |
1 /**************************************************************************** |
2 /* */ |
2 * |
3 /* ftcid.h */ |
3 * ftcid.h |
4 /* */ |
4 * |
5 /* FreeType API for accessing CID font information (specification). */ |
5 * FreeType API for accessing CID font information (specification). |
6 /* */ |
6 * |
7 /* Copyright 2007-2018 by */ |
7 * Copyright (C) 2007-2019 by |
8 /* Dereg Clegg and Michael Toftdal. */ |
8 * Dereg Clegg and Michael Toftdal. |
9 /* */ |
9 * |
10 /* This file is part of the FreeType project, and may only be used, */ |
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 */ |
11 * modified, and distributed under the terms of the FreeType project |
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ |
12 * license, LICENSE.TXT. By continuing to use, modify, or distribute |
13 /* this file you indicate that you have read the license and */ |
13 * this file you indicate that you have read the license and |
14 /* understand and accept it fully. */ |
14 * understand and accept it fully. |
15 /* */ |
15 * |
16 /***************************************************************************/ |
16 */ |
17 |
17 |
18 |
18 |
19 #ifndef FTCID_H_ |
19 #ifndef FTCID_H_ |
20 #define FTCID_H_ |
20 #define FTCID_H_ |
21 |
21 |
30 |
30 |
31 |
31 |
32 FT_BEGIN_HEADER |
32 FT_BEGIN_HEADER |
33 |
33 |
34 |
34 |
35 /*************************************************************************/ |
35 /************************************************************************** |
36 /* */ |
36 * |
37 /* <Section> */ |
37 * @section: |
38 /* cid_fonts */ |
38 * cid_fonts |
39 /* */ |
39 * |
40 /* <Title> */ |
40 * @title: |
41 /* CID Fonts */ |
41 * CID Fonts |
42 /* */ |
42 * |
43 /* <Abstract> */ |
43 * @abstract: |
44 /* CID-keyed font specific API. */ |
44 * CID-keyed font-specific API. |
45 /* */ |
45 * |
46 /* <Description> */ |
46 * @description: |
47 /* This section contains the declaration of CID-keyed font specific */ |
47 * This section contains the declaration of CID-keyed font-specific |
48 /* functions. */ |
48 * functions. |
49 /* */ |
49 * |
50 /*************************************************************************/ |
50 */ |
51 |
51 |
52 |
52 |
53 /********************************************************************** |
53 /************************************************************************** |
54 * |
54 * |
55 * @function: |
55 * @function: |
56 * FT_Get_CID_Registry_Ordering_Supplement |
56 * FT_Get_CID_Registry_Ordering_Supplement |
57 * |
57 * |
58 * @description: |
58 * @description: |
59 * Retrieve the Registry/Ordering/Supplement triple (also known as the |
59 * Retrieve the Registry/Ordering/Supplement triple (also known as the |
60 * "R/O/S") from a CID-keyed font. |
60 * "R/O/S") from a CID-keyed font. |
61 * |
61 * |
62 * @input: |
62 * @input: |
63 * face :: |
63 * face :: |
64 * A handle to the input face. |
64 * A handle to the input face. |
65 * |
65 * |
66 * @output: |
66 * @output: |
67 * registry :: |
67 * registry :: |
68 * The registry, as a C~string, owned by the face. |
68 * The registry, as a C~string, owned by the face. |
69 * |
69 * |
70 * ordering :: |
70 * ordering :: |
71 * The ordering, as a C~string, owned by the face. |
71 * The ordering, as a C~string, owned by the face. |
72 * |
72 * |
73 * supplement :: |
73 * supplement :: |
74 * The supplement. |
74 * The supplement. |
75 * |
75 * |
76 * @return: |
76 * @return: |
77 * FreeType error code. 0~means success. |
77 * FreeType error code. 0~means success. |
78 * |
78 * |
79 * @note: |
79 * @note: |
88 const char* *registry, |
88 const char* *registry, |
89 const char* *ordering, |
89 const char* *ordering, |
90 FT_Int *supplement ); |
90 FT_Int *supplement ); |
91 |
91 |
92 |
92 |
93 /********************************************************************** |
93 /************************************************************************** |
94 * |
94 * |
95 * @function: |
95 * @function: |
96 * FT_Get_CID_Is_Internally_CID_Keyed |
96 * FT_Get_CID_Is_Internally_CID_Keyed |
97 * |
97 * |
98 * @description: |
98 * @description: |
99 * Retrieve the type of the input face, CID keyed or not. In |
99 * Retrieve the type of the input face, CID keyed or not. In contrast |
100 * contrast to the @FT_IS_CID_KEYED macro this function returns |
100 * to the @FT_IS_CID_KEYED macro this function returns successfully also |
101 * successfully also for CID-keyed fonts in an SFNT wrapper. |
101 * for CID-keyed fonts in an SFNT wrapper. |
102 * |
102 * |
103 * @input: |
103 * @input: |
104 * face :: |
104 * face :: |
105 * A handle to the input face. |
105 * A handle to the input face. |
106 * |
106 * |
107 * @output: |
107 * @output: |
108 * is_cid :: |
108 * is_cid :: |
109 * The type of the face as an @FT_Bool. |
109 * The type of the face as an @FT_Bool. |
110 * |
110 * |
111 * @return: |
111 * @return: |
112 * FreeType error code. 0~means success. |
112 * FreeType error code. 0~means success. |
113 * |
113 * |
114 * @note: |
114 * @note: |
115 * This function only works with CID faces and OpenType fonts, |
115 * This function only works with CID faces and OpenType fonts, returning |
116 * returning an error otherwise. |
116 * an error otherwise. |
117 * |
117 * |
118 * @since: |
118 * @since: |
119 * 2.3.9 |
119 * 2.3.9 |
120 */ |
120 */ |
121 FT_EXPORT( FT_Error ) |
121 FT_EXPORT( FT_Error ) |
122 FT_Get_CID_Is_Internally_CID_Keyed( FT_Face face, |
122 FT_Get_CID_Is_Internally_CID_Keyed( FT_Face face, |
123 FT_Bool *is_cid ); |
123 FT_Bool *is_cid ); |
124 |
124 |
125 |
125 |
126 /********************************************************************** |
126 /************************************************************************** |
127 * |
127 * |
128 * @function: |
128 * @function: |
129 * FT_Get_CID_From_Glyph_Index |
129 * FT_Get_CID_From_Glyph_Index |
130 * |
130 * |
131 * @description: |
131 * @description: |
132 * Retrieve the CID of the input glyph index. |
132 * Retrieve the CID of the input glyph index. |
133 * |
133 * |
134 * @input: |
134 * @input: |
135 * face :: |
135 * face :: |
136 * A handle to the input face. |
136 * A handle to the input face. |
137 * |
137 * |
138 * glyph_index :: |
138 * glyph_index :: |
139 * The input glyph index. |
139 * The input glyph index. |
140 * |
140 * |
141 * @output: |
141 * @output: |
142 * cid :: |
142 * cid :: |
143 * The CID as an @FT_UInt. |
143 * The CID as an @FT_UInt. |
144 * |
144 * |
145 * @return: |
145 * @return: |
146 * FreeType error code. 0~means success. |
146 * FreeType error code. 0~means success. |
147 * |
147 * |
148 * @note: |
148 * @note: |
149 * This function only works with CID faces and OpenType fonts, |
149 * This function only works with CID faces and OpenType fonts, returning |
150 * returning an error otherwise. |
150 * an error otherwise. |
151 * |
151 * |
152 * @since: |
152 * @since: |
153 * 2.3.9 |
153 * 2.3.9 |
154 */ |
154 */ |
155 FT_EXPORT( FT_Error ) |
155 FT_EXPORT( FT_Error ) |