6 <html lang="en" class="no-js">
10 <meta name="viewport" content="width=device-width,initial-scale=1">
11 <meta http-equiv="x-ua-compatible" content="ie=edge">
13 <meta name="description" content="API Reference Documentation for FreeType-2.10.4">
17 <meta name="author" content="FreeType Contributors">
20 <meta name="lang:clipboard.copy" content="Copy to clipboard">
22 <meta name="lang:clipboard.copied" content="Copied to clipboard">
24 <meta name="lang:search.language" content="en">
26 <meta name="lang:search.pipeline.stopwords" content="True">
28 <meta name="lang:search.pipeline.trimmer" content="True">
30 <meta name="lang:search.result.none" content="No matching documents">
32 <meta name="lang:search.result.one" content="1 matching document">
34 <meta name="lang:search.result.other" content="# matching documents">
36 <meta name="lang:search.tokenizer" content="[\s\-]+">
38 <link rel="shortcut icon" href="images/favico.ico">
39 <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3">
43 <title>CID Fonts - FreeType-2.10.4 API Reference</title>
47 <link rel="stylesheet" href="assets/stylesheets/application.adb8469c.css">
49 <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css">
54 <meta name="theme-color" content="#4caf50">
58 <script src="assets/javascripts/modernizr.86422ebf.js"></script>
62 <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
63 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
64 <style>body,input{font-family:"Noto Serif","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
67 <link rel="stylesheet" href="assets/fonts/material-icons.css">
70 <link rel="stylesheet" href="stylesheets/extra.css">
80 <body dir="ltr" data-md-color-primary="green" data-md-color-accent="green">
88 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
89 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
90 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
92 <a href="#cid-fonts" tabindex="0" class="md-skip">
97 <header class="md-header" data-md-component="header">
98 <nav class="md-header-nav md-grid">
100 <div class="md-flex__cell md-flex__cell--shrink">
101 <a href="." title="FreeType-2.10.4 API Reference" aria-label="FreeType-2.10.4 API Reference" class="md-header-nav__button md-logo">
103 <img alt="logo" src="images/favico.ico" width="24" height="24">
107 <div class="md-flex__cell md-flex__cell--shrink">
108 <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
110 <div class="md-flex__cell md-flex__cell--stretch">
111 <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
113 <span class="md-header-nav__topic">
114 FreeType-2.10.4 API Reference
116 <span class="md-header-nav__topic">
124 <div class="md-flex__cell md-flex__cell--shrink">
126 <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
128 <div class="md-search" data-md-component="search" role="dialog">
129 <label class="md-search__overlay" for="__search"></label>
130 <div class="md-search__inner" role="search">
131 <form class="md-search__form" name="search">
132 <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
133 <label class="md-icon md-search__icon" for="__search"></label>
134 <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
138 <div class="md-search__output">
139 <div class="md-search__scrollwrap" data-md-scrollfix>
140 <div class="md-search-result" data-md-component="result">
141 <div class="md-search-result__meta">
142 Type to start searching
144 <ol class="md-search-result__list"></ol>
157 <div class="md-container">
162 <main class="md-main" role="main">
163 <div class="md-main__inner md-grid" data-md-component="container">
166 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
167 <div class="md-sidebar__scrollwrap">
168 <div class="md-sidebar__inner">
169 <nav class="md-nav md-nav--primary" data-md-level="0">
170 <label class="md-nav__title md-nav__title--site" for="__drawer">
171 <a href="." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
173 <img alt="logo" src="images/favico.ico" width="48" height="48">
176 FreeType-2.10.4 API Reference
179 <ul class="md-nav__list" data-md-scrollfix>
186 <li class="md-nav__item">
187 <a href="index.html" title="TOC" class="md-nav__link">
198 <li class="md-nav__item">
199 <a href="ft2-index.html" title="Index" class="md-nav__link">
210 <li class="md-nav__item md-nav__item--nested">
212 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
214 <label class="md-nav__link" for="nav-3">
217 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
218 <label class="md-nav__title" for="nav-3">
221 <ul class="md-nav__list" data-md-scrollfix>
229 <li class="md-nav__item">
230 <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
231 FreeType's header inclusion scheme
241 <li class="md-nav__item">
242 <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link">
258 <li class="md-nav__item md-nav__item--nested">
260 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
262 <label class="md-nav__link" for="nav-4">
265 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
266 <label class="md-nav__title" for="nav-4">
269 <ul class="md-nav__list" data-md-scrollfix>
277 <li class="md-nav__item">
278 <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
289 <li class="md-nav__item">
290 <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
301 <li class="md-nav__item">
302 <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link">
313 <li class="md-nav__item">
314 <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
315 Unicode Variation Sequences
325 <li class="md-nav__item">
326 <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
327 Glyph Color Management
337 <li class="md-nav__item">
338 <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
339 Glyph Layer Management
349 <li class="md-nav__item">
350 <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
361 <li class="md-nav__item">
362 <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
363 Mac Specific Interface
373 <li class="md-nav__item">
374 <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
385 <li class="md-nav__item">
386 <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
404 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
406 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
408 <label class="md-nav__link" for="nav-5">
411 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
412 <label class="md-nav__title" for="nav-5">
415 <ul class="md-nav__list" data-md-scrollfix>
423 <li class="md-nav__item">
424 <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
435 <li class="md-nav__item">
436 <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
447 <li class="md-nav__item">
448 <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
459 <li class="md-nav__item">
460 <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
471 <li class="md-nav__item">
472 <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
485 <li class="md-nav__item md-nav__item--active">
487 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
492 <label class="md-nav__link md-nav__link--active" for="__toc">
496 <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link md-nav__link--active">
501 <nav class="md-nav md-nav--secondary">
507 <label class="md-nav__title" for="__toc">Table of contents</label>
508 <ul class="md-nav__list" data-md-scrollfix>
510 <li class="md-nav__item">
511 <a href="#synopsis" class="md-nav__link">
517 <li class="md-nav__item">
518 <a href="#ft_get_cid_registry_ordering_supplement" class="md-nav__link">
519 FT_Get_CID_Registry_Ordering_Supplement
524 <li class="md-nav__item">
525 <a href="#ft_get_cid_is_internally_cid_keyed" class="md-nav__link">
526 FT_Get_CID_Is_Internally_CID_Keyed
531 <li class="md-nav__item">
532 <a href="#ft_get_cid_from_glyph_index" class="md-nav__link">
533 FT_Get_CID_From_Glyph_Index
554 <li class="md-nav__item">
555 <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
566 <li class="md-nav__item">
567 <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
578 <li class="md-nav__item">
579 <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
590 <li class="md-nav__item">
591 <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
607 <li class="md-nav__item md-nav__item--nested">
609 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
611 <label class="md-nav__link" for="nav-6">
612 Controlling FreeType Modules
614 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
615 <label class="md-nav__title" for="nav-6">
616 Controlling FreeType Modules
618 <ul class="md-nav__list" data-md-scrollfix>
626 <li class="md-nav__item">
627 <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
638 <li class="md-nav__item">
639 <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
650 <li class="md-nav__item">
651 <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
652 The Type 1 and CID drivers
662 <li class="md-nav__item">
663 <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
674 <li class="md-nav__item">
675 <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
686 <li class="md-nav__item">
687 <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
698 <li class="md-nav__item">
699 <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
710 <li class="md-nav__item">
711 <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
727 <li class="md-nav__item md-nav__item--nested">
729 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
731 <label class="md-nav__link" for="nav-7">
734 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
735 <label class="md-nav__title" for="nav-7">
738 <ul class="md-nav__list" data-md-scrollfix>
746 <li class="md-nav__item">
747 <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
763 <li class="md-nav__item md-nav__item--nested">
765 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
767 <label class="md-nav__link" for="nav-8">
770 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
771 <label class="md-nav__title" for="nav-8">
774 <ul class="md-nav__list" data-md-scrollfix>
782 <li class="md-nav__item">
783 <a href="ft2-computations.html" title="Computations" class="md-nav__link">
794 <li class="md-nav__item">
795 <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
806 <li class="md-nav__item">
807 <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
818 <li class="md-nav__item">
819 <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
820 Quick retrieval of advance values
830 <li class="md-nav__item">
831 <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
842 <li class="md-nav__item">
843 <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
854 <li class="md-nav__item">
855 <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
866 <li class="md-nav__item">
867 <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
878 <li class="md-nav__item">
879 <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
890 <li class="md-nav__item">
891 <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
902 <li class="md-nav__item">
903 <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
914 <li class="md-nav__item">
915 <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
931 <li class="md-nav__item md-nav__item--nested">
933 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
935 <label class="md-nav__link" for="nav-9">
938 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
939 <label class="md-nav__title" for="nav-9">
942 <ul class="md-nav__list" data-md-scrollfix>
950 <li class="md-nav__item">
951 <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
962 <li class="md-nav__item">
963 <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
979 <li class="md-nav__item md-nav__item--nested">
981 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
983 <label class="md-nav__link" for="nav-10">
986 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
987 <label class="md-nav__title" for="nav-10">
990 <ul class="md-nav__list" data-md-scrollfix>
998 <li class="md-nav__item">
999 <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1000 TrueTypeGX/AAT Validation
1010 <li class="md-nav__item">
1011 <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1022 <li class="md-nav__item">
1023 <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1034 <li class="md-nav__item">
1035 <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1053 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1054 <div class="md-sidebar__scrollwrap">
1055 <div class="md-sidebar__inner">
1057 <nav class="md-nav md-nav--secondary">
1063 <label class="md-nav__title" for="__toc">Table of contents</label>
1064 <ul class="md-nav__list" data-md-scrollfix>
1066 <li class="md-nav__item">
1067 <a href="#synopsis" class="md-nav__link">
1073 <li class="md-nav__item">
1074 <a href="#ft_get_cid_registry_ordering_supplement" class="md-nav__link">
1075 FT_Get_CID_Registry_Ordering_Supplement
1080 <li class="md-nav__item">
1081 <a href="#ft_get_cid_is_internally_cid_keyed" class="md-nav__link">
1082 FT_Get_CID_Is_Internally_CID_Keyed
1087 <li class="md-nav__item">
1088 <a href="#ft_get_cid_from_glyph_index" class="md-nav__link">
1089 FT_Get_CID_From_Glyph_Index
1106 <div class="md-content">
1107 <article class="md-content__inner md-typeset">
1111 <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#format-specific-api">Format-Specific API</a> » CID Fonts</p>
1113 <h1 id="cid-fonts">CID Fonts<a class="headerlink" href="#cid-fonts" title="Permanent link">¶</a></h1>
1114 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2>
1115 <p>This section contains the declaration of CID-keyed font-specific functions.</p>
1116 <h2 id="ft_get_cid_registry_ordering_supplement">FT_Get_CID_Registry_Ordering_Supplement<a class="headerlink" href="#ft_get_cid_registry_ordering_supplement" title="Permanent link">¶</a></h2>
1117 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1118 <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1119 <b>FT_Get_CID_Registry_Ordering_Supplement</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
1120 <span class="keyword">const</span> <span class="keyword">char</span>* *registry,
1121 <span class="keyword">const</span> <span class="keyword">char</span>* *ordering,
1122 <a href="ft2-basic_types.html#ft_int">FT_Int</a> *supplement );
1125 <p>Retrieve the Registry/Ordering/Supplement triple (also known as the "R/O/S") from a CID-keyed font.</p>
1128 <table class="fields">
1129 <tr><td class="val" id="face">face</td><td class="desc">
1130 <p>A handle to the input face.</p>
1136 <table class="fields">
1137 <tr><td class="val" id="registry">registry</td><td class="desc">
1138 <p>The registry, as a C string, owned by the face.</p>
1140 <tr><td class="val" id="ordering">ordering</td><td class="desc">
1141 <p>The ordering, as a C string, owned by the face.</p>
1143 <tr><td class="val" id="supplement">supplement</td><td class="desc">
1144 <p>The supplement.</p>
1150 <p>FreeType error code. 0 means success.</p>
1153 <p>This function only works with CID faces, returning an error otherwise.</p>
1159 <h2 id="ft_get_cid_is_internally_cid_keyed">FT_Get_CID_Is_Internally_CID_Keyed<a class="headerlink" href="#ft_get_cid_is_internally_cid_keyed" title="Permanent link">¶</a></h2>
1160 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1161 <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1162 <b>FT_Get_CID_Is_Internally_CID_Keyed</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
1163 <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> *is_cid );
1166 <p>Retrieve the type of the input face, CID keyed or not. In contrast to the <code><a href="ft2-base_interface.html#ft_is_cid_keyed">FT_IS_CID_KEYED</a></code> macro this function returns successfully also for CID-keyed fonts in an SFNT wrapper.</p>
1169 <table class="fields">
1170 <tr><td class="val" id="face">face</td><td class="desc">
1171 <p>A handle to the input face.</p>
1177 <table class="fields">
1178 <tr><td class="val" id="is_cid">is_cid</td><td class="desc">
1179 <p>The type of the face as an <code><a href="ft2-basic_types.html#ft_bool">FT_Bool</a></code>.</p>
1185 <p>FreeType error code. 0 means success.</p>
1188 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
1194 <h2 id="ft_get_cid_from_glyph_index">FT_Get_CID_From_Glyph_Index<a class="headerlink" href="#ft_get_cid_from_glyph_index" title="Permanent link">¶</a></h2>
1195 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1196 <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1197 <b>FT_Get_CID_From_Glyph_Index</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
1198 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> glyph_index,
1199 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> *cid );
1202 <p>Retrieve the CID of the input glyph index.</p>
1205 <table class="fields">
1206 <tr><td class="val" id="face">face</td><td class="desc">
1207 <p>A handle to the input face.</p>
1209 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
1210 <p>The input glyph index.</p>
1216 <table class="fields">
1217 <tr><td class="val" id="cid">cid</td><td class="desc">
1218 <p>The CID as an <code><a href="ft2-basic_types.html#ft_uint">FT_UInt</a></code>.</p>
1224 <p>FreeType error code. 0 means success.</p>
1227 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
1248 <footer class="md-footer">
1250 <div class="md-footer-nav">
1251 <nav class="md-footer-nav__inner md-grid">
1253 <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1254 <div class="md-flex__cell md-flex__cell--shrink">
1255 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1257 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1258 <span class="md-flex__ellipsis">
1259 <span class="md-footer-nav__direction">
1268 <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1269 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1270 <span class="md-flex__ellipsis">
1271 <span class="md-footer-nav__direction">
1277 <div class="md-flex__cell md-flex__cell--shrink">
1278 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1285 <div class="md-footer-meta md-typeset">
1286 <div class="md-footer-meta__inner md-grid">
1287 <div class="md-footer-copyright">
1289 <div class="md-footer-copyright__highlight">
1290 Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1294 <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1296 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1297 Material for MkDocs</a>
1306 <script src="assets/javascripts/application.c33a9706.js"></script>
1308 <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1310 <script src="javascripts/extra.js"></script>