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.1">
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.0.4, mkdocs-material-4.0.2">
43 <title>CID Fonts - FreeType-2.10.1 API Reference</title>
47 <link rel="stylesheet" href="assets/stylesheets/application.982221ab.css">
49 <link rel="stylesheet" href="assets/stylesheets/application-palette.224b79ff.css">
54 <meta name="theme-color" content="#4caf50">
58 <script src="assets/javascripts/modernizr.1f0bcf2b.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|Roboto+Mono">
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="1" 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="index.html" title="FreeType-2.10.1 API Reference" class="md-header-nav__button md-logo">
103 <img 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.1 API Reference
116 <span class="md-header-nav__topic">
122 <div class="md-flex__cell md-flex__cell--shrink">
124 <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
126 <div class="md-search" data-md-component="search" role="dialog">
127 <label class="md-search__overlay" for="__search"></label>
128 <div class="md-search__inner" role="search">
129 <form class="md-search__form" name="search">
130 <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
131 <label class="md-icon md-search__icon" for="__search"></label>
132 <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
136 <div class="md-search__output">
137 <div class="md-search__scrollwrap" data-md-scrollfix>
138 <div class="md-search-result" data-md-component="result">
139 <div class="md-search-result__meta">
140 Type to start searching
142 <ol class="md-search-result__list"></ol>
155 <div class="md-container">
160 <main class="md-main">
161 <div class="md-main__inner md-grid" data-md-component="container">
164 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
165 <div class="md-sidebar__scrollwrap">
166 <div class="md-sidebar__inner">
167 <nav class="md-nav md-nav--primary" data-md-level="0">
168 <label class="md-nav__title md-nav__title--site" for="__drawer">
169 <a href="index.html" title="FreeType-2.10.1 API Reference" class="md-nav__button md-logo">
171 <img src="images/favico.ico" width="48" height="48">
174 FreeType-2.10.1 API Reference
177 <ul class="md-nav__list" data-md-scrollfix>
184 <li class="md-nav__item">
185 <a href="index.html" title="TOC" class="md-nav__link">
196 <li class="md-nav__item">
197 <a href="ft2-index.html" title="Index" class="md-nav__link">
208 <li class="md-nav__item md-nav__item--nested">
210 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
212 <label class="md-nav__link" for="nav-3">
215 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
216 <label class="md-nav__title" for="nav-3">
219 <ul class="md-nav__list" data-md-scrollfix>
227 <li class="md-nav__item">
228 <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
229 FreeType's header inclusion scheme
239 <li class="md-nav__item">
240 <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link">
256 <li class="md-nav__item md-nav__item--nested">
258 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
260 <label class="md-nav__link" for="nav-4">
263 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
264 <label class="md-nav__title" for="nav-4">
267 <ul class="md-nav__list" data-md-scrollfix>
275 <li class="md-nav__item">
276 <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
287 <li class="md-nav__item">
288 <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
299 <li class="md-nav__item">
300 <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link">
311 <li class="md-nav__item">
312 <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
313 Unicode Variation Sequences
323 <li class="md-nav__item">
324 <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
325 Glyph Color Management
335 <li class="md-nav__item">
336 <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
337 Glyph Layer Management
347 <li class="md-nav__item">
348 <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
359 <li class="md-nav__item">
360 <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
361 Mac Specific Interface
371 <li class="md-nav__item">
372 <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
383 <li class="md-nav__item">
384 <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
402 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
404 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
406 <label class="md-nav__link" for="nav-5">
409 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
410 <label class="md-nav__title" for="nav-5">
413 <ul class="md-nav__list" data-md-scrollfix>
421 <li class="md-nav__item">
422 <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
433 <li class="md-nav__item">
434 <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
445 <li class="md-nav__item">
446 <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
457 <li class="md-nav__item">
458 <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
469 <li class="md-nav__item">
470 <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
483 <li class="md-nav__item md-nav__item--active">
485 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
490 <label class="md-nav__link md-nav__link--active" for="__toc">
494 <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link md-nav__link--active">
499 <nav class="md-nav md-nav--secondary">
505 <label class="md-nav__title" for="__toc">Table of contents</label>
506 <ul class="md-nav__list" data-md-scrollfix>
508 <li class="md-nav__item">
509 <a href="#synopsis" title="Synopsis" class="md-nav__link">
515 <li class="md-nav__item">
516 <a href="#ft_get_cid_registry_ordering_supplement" title="FT_Get_CID_Registry_Ordering_Supplement" class="md-nav__link">
517 FT_Get_CID_Registry_Ordering_Supplement
522 <li class="md-nav__item">
523 <a href="#ft_get_cid_is_internally_cid_keyed" title="FT_Get_CID_Is_Internally_CID_Keyed" class="md-nav__link">
524 FT_Get_CID_Is_Internally_CID_Keyed
529 <li class="md-nav__item">
530 <a href="#ft_get_cid_from_glyph_index" title="FT_Get_CID_From_Glyph_Index" class="md-nav__link">
531 FT_Get_CID_From_Glyph_Index
552 <li class="md-nav__item">
553 <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
564 <li class="md-nav__item">
565 <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
576 <li class="md-nav__item">
577 <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
588 <li class="md-nav__item">
589 <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
605 <li class="md-nav__item md-nav__item--nested">
607 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
609 <label class="md-nav__link" for="nav-6">
610 Controlling FreeType Modules
612 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
613 <label class="md-nav__title" for="nav-6">
614 Controlling FreeType Modules
616 <ul class="md-nav__list" data-md-scrollfix>
624 <li class="md-nav__item">
625 <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
636 <li class="md-nav__item">
637 <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
648 <li class="md-nav__item">
649 <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
650 The Type 1 and CID drivers
660 <li class="md-nav__item">
661 <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
672 <li class="md-nav__item">
673 <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
684 <li class="md-nav__item">
685 <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
696 <li class="md-nav__item">
697 <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
708 <li class="md-nav__item">
709 <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
725 <li class="md-nav__item md-nav__item--nested">
727 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
729 <label class="md-nav__link" for="nav-7">
732 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
733 <label class="md-nav__title" for="nav-7">
736 <ul class="md-nav__list" data-md-scrollfix>
744 <li class="md-nav__item">
745 <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
761 <li class="md-nav__item md-nav__item--nested">
763 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
765 <label class="md-nav__link" for="nav-8">
768 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
769 <label class="md-nav__title" for="nav-8">
772 <ul class="md-nav__list" data-md-scrollfix>
780 <li class="md-nav__item">
781 <a href="ft2-computations.html" title="Computations" class="md-nav__link">
792 <li class="md-nav__item">
793 <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
804 <li class="md-nav__item">
805 <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
816 <li class="md-nav__item">
817 <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
818 Quick retrieval of advance values
828 <li class="md-nav__item">
829 <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
840 <li class="md-nav__item">
841 <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
852 <li class="md-nav__item">
853 <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
864 <li class="md-nav__item">
865 <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
876 <li class="md-nav__item">
877 <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
888 <li class="md-nav__item">
889 <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
900 <li class="md-nav__item">
901 <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
912 <li class="md-nav__item">
913 <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
929 <li class="md-nav__item md-nav__item--nested">
931 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
933 <label class="md-nav__link" for="nav-9">
936 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
937 <label class="md-nav__title" for="nav-9">
940 <ul class="md-nav__list" data-md-scrollfix>
948 <li class="md-nav__item">
949 <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
960 <li class="md-nav__item">
961 <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
977 <li class="md-nav__item md-nav__item--nested">
979 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
981 <label class="md-nav__link" for="nav-10">
984 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
985 <label class="md-nav__title" for="nav-10">
988 <ul class="md-nav__list" data-md-scrollfix>
996 <li class="md-nav__item">
997 <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1008 <li class="md-nav__item">
1009 <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1020 <li class="md-nav__item">
1021 <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1032 <li class="md-nav__item">
1033 <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1034 TrueTypeGX/AAT Validation
1051 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1052 <div class="md-sidebar__scrollwrap">
1053 <div class="md-sidebar__inner">
1055 <nav class="md-nav md-nav--secondary">
1061 <label class="md-nav__title" for="__toc">Table of contents</label>
1062 <ul class="md-nav__list" data-md-scrollfix>
1064 <li class="md-nav__item">
1065 <a href="#synopsis" title="Synopsis" class="md-nav__link">
1071 <li class="md-nav__item">
1072 <a href="#ft_get_cid_registry_ordering_supplement" title="FT_Get_CID_Registry_Ordering_Supplement" class="md-nav__link">
1073 FT_Get_CID_Registry_Ordering_Supplement
1078 <li class="md-nav__item">
1079 <a href="#ft_get_cid_is_internally_cid_keyed" title="FT_Get_CID_Is_Internally_CID_Keyed" class="md-nav__link">
1080 FT_Get_CID_Is_Internally_CID_Keyed
1085 <li class="md-nav__item">
1086 <a href="#ft_get_cid_from_glyph_index" title="FT_Get_CID_From_Glyph_Index" class="md-nav__link">
1087 FT_Get_CID_From_Glyph_Index
1104 <div class="md-content">
1105 <article class="md-content__inner md-typeset">
1109 <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>
1111 <h1 id="cid-fonts">CID Fonts<a class="headerlink" href="#cid-fonts" title="Permanent link">¶</a></h1>
1112 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2>
1113 <p>This section contains the declaration of CID-keyed font-specific functions.</p>
1114 <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>
1115 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1116 <div class = "codehilite">
1118 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 );
1126 <p>Retrieve the Registry/Ordering/Supplement triple (also known as the "R/O/S") from a CID-keyed font.</p>
1129 <table class="fields">
1130 <tr><td class="val" id="face">face</td><td class="desc">
1131 <p>A handle to the input face.</p>
1137 <table class="fields">
1138 <tr><td class="val" id="registry">registry</td><td class="desc">
1139 <p>The registry, as a C string, owned by the face.</p>
1141 <tr><td class="val" id="ordering">ordering</td><td class="desc">
1142 <p>The ordering, as a C string, owned by the face.</p>
1144 <tr><td class="val" id="supplement">supplement</td><td class="desc">
1145 <p>The supplement.</p>
1151 <p>FreeType error code. 0 means success.</p>
1154 <p>This function only works with CID faces, returning an error otherwise.</p>
1160 <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>
1161 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1162 <div class = "codehilite">
1164 FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1165 <b>FT_Get_CID_Is_Internally_CID_Keyed</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
1166 <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> *is_cid );
1170 <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>
1173 <table class="fields">
1174 <tr><td class="val" id="face">face</td><td class="desc">
1175 <p>A handle to the input face.</p>
1181 <table class="fields">
1182 <tr><td class="val" id="is_cid">is_cid</td><td class="desc">
1183 <p>The type of the face as an <code><a href="ft2-basic_types.html#ft_bool">FT_Bool</a></code>.</p>
1189 <p>FreeType error code. 0 means success.</p>
1192 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
1198 <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>
1199 <p>Defined in FT_CID_H (freetype/ftcid.h).</p>
1200 <div class = "codehilite">
1202 FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1203 <b>FT_Get_CID_From_Glyph_Index</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
1204 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> glyph_index,
1205 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> *cid );
1209 <p>Retrieve the CID of the input glyph index.</p>
1212 <table class="fields">
1213 <tr><td class="val" id="face">face</td><td class="desc">
1214 <p>A handle to the input face.</p>
1216 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
1217 <p>The input glyph index.</p>
1223 <table class="fields">
1224 <tr><td class="val" id="cid">cid</td><td class="desc">
1225 <p>The CID as an <code><a href="ft2-basic_types.html#ft_uint">FT_UInt</a></code>.</p>
1231 <p>FreeType error code. 0 means success.</p>
1234 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
1254 <footer class="md-footer">
1256 <div class="md-footer-nav">
1257 <nav class="md-footer-nav__inner md-grid">
1259 <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">
1260 <div class="md-flex__cell md-flex__cell--shrink">
1261 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1263 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1264 <span class="md-flex__ellipsis">
1265 <span class="md-footer-nav__direction">
1274 <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1275 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1276 <span class="md-flex__ellipsis">
1277 <span class="md-footer-nav__direction">
1283 <div class="md-flex__cell md-flex__cell--shrink">
1284 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1291 <div class="md-footer-meta md-typeset">
1292 <div class="md-footer-meta__inner md-grid">
1293 <div class="md-footer-copyright">
1295 <div class="md-footer-copyright__highlight">
1296 Copyright 2019 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1300 <a href="https://www.mkdocs.org">MkDocs</a>
1302 <a href="https://squidfunk.github.io/mkdocs-material/">
1303 Material for MkDocs</a>
1312 <script src="assets/javascripts/application.d9aa80ab.js"></script>
1314 <script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
1316 <script src="javascripts/extra.js"></script>