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>Incremental Loading - 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="#incremental-loading" 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">
402 <li class="md-nav__item md-nav__item--nested">
404 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
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">
481 <li class="md-nav__item">
482 <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
493 <li class="md-nav__item">
494 <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
505 <li class="md-nav__item">
506 <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
517 <li class="md-nav__item">
518 <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
529 <li class="md-nav__item">
530 <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
546 <li class="md-nav__item md-nav__item--nested">
548 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
550 <label class="md-nav__link" for="nav-6">
551 Controlling FreeType Modules
553 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
554 <label class="md-nav__title" for="nav-6">
555 Controlling FreeType Modules
557 <ul class="md-nav__list" data-md-scrollfix>
565 <li class="md-nav__item">
566 <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
577 <li class="md-nav__item">
578 <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
589 <li class="md-nav__item">
590 <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
591 The Type 1 and CID drivers
601 <li class="md-nav__item">
602 <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
613 <li class="md-nav__item">
614 <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
625 <li class="md-nav__item">
626 <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
637 <li class="md-nav__item">
638 <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
649 <li class="md-nav__item">
650 <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
666 <li class="md-nav__item md-nav__item--nested">
668 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
670 <label class="md-nav__link" for="nav-7">
673 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
674 <label class="md-nav__title" for="nav-7">
677 <ul class="md-nav__list" data-md-scrollfix>
685 <li class="md-nav__item">
686 <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
702 <li class="md-nav__item md-nav__item--nested">
704 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
706 <label class="md-nav__link" for="nav-8">
709 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
710 <label class="md-nav__title" for="nav-8">
713 <ul class="md-nav__list" data-md-scrollfix>
721 <li class="md-nav__item">
722 <a href="ft2-computations.html" title="Computations" class="md-nav__link">
733 <li class="md-nav__item">
734 <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
745 <li class="md-nav__item">
746 <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
757 <li class="md-nav__item">
758 <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
759 Quick retrieval of advance values
769 <li class="md-nav__item">
770 <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
781 <li class="md-nav__item">
782 <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
793 <li class="md-nav__item">
794 <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
805 <li class="md-nav__item">
806 <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
817 <li class="md-nav__item">
818 <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
829 <li class="md-nav__item">
830 <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
841 <li class="md-nav__item">
842 <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
853 <li class="md-nav__item">
854 <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
870 <li class="md-nav__item md-nav__item--nested">
872 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
874 <label class="md-nav__link" for="nav-9">
877 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
878 <label class="md-nav__title" for="nav-9">
881 <ul class="md-nav__list" data-md-scrollfix>
889 <li class="md-nav__item">
890 <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
901 <li class="md-nav__item">
902 <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
920 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
922 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10" checked>
924 <label class="md-nav__link" for="nav-10">
927 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
928 <label class="md-nav__title" for="nav-10">
931 <ul class="md-nav__list" data-md-scrollfix>
939 <li class="md-nav__item">
940 <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
941 TrueTypeGX/AAT Validation
953 <li class="md-nav__item md-nav__item--active">
955 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
960 <label class="md-nav__link md-nav__link--active" for="__toc">
964 <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link md-nav__link--active">
969 <nav class="md-nav md-nav--secondary">
975 <label class="md-nav__title" for="__toc">Table of contents</label>
976 <ul class="md-nav__list" data-md-scrollfix>
978 <li class="md-nav__item">
979 <a href="#synopsis" class="md-nav__link">
985 <li class="md-nav__item">
986 <a href="#ft_incremental" class="md-nav__link">
992 <li class="md-nav__item">
993 <a href="#ft_incremental_metricsrec" class="md-nav__link">
994 FT_Incremental_MetricsRec
999 <li class="md-nav__item">
1000 <a href="#ft_incremental_metrics" class="md-nav__link">
1001 FT_Incremental_Metrics
1006 <li class="md-nav__item">
1007 <a href="#ft_incremental_getglyphdatafunc" class="md-nav__link">
1008 FT_Incremental_GetGlyphDataFunc
1013 <li class="md-nav__item">
1014 <a href="#ft_incremental_freeglyphdatafunc" class="md-nav__link">
1015 FT_Incremental_FreeGlyphDataFunc
1020 <li class="md-nav__item">
1021 <a href="#ft_incremental_getglyphmetricsfunc" class="md-nav__link">
1022 FT_Incremental_GetGlyphMetricsFunc
1027 <li class="md-nav__item">
1028 <a href="#ft_incremental_funcsrec" class="md-nav__link">
1029 FT_Incremental_FuncsRec
1034 <li class="md-nav__item">
1035 <a href="#ft_incremental_interfacerec" class="md-nav__link">
1036 FT_Incremental_InterfaceRec
1041 <li class="md-nav__item">
1042 <a href="#ft_incremental_interface" class="md-nav__link">
1043 FT_Incremental_Interface
1064 <li class="md-nav__item">
1065 <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1076 <li class="md-nav__item">
1077 <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1095 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1096 <div class="md-sidebar__scrollwrap">
1097 <div class="md-sidebar__inner">
1099 <nav class="md-nav md-nav--secondary">
1105 <label class="md-nav__title" for="__toc">Table of contents</label>
1106 <ul class="md-nav__list" data-md-scrollfix>
1108 <li class="md-nav__item">
1109 <a href="#synopsis" class="md-nav__link">
1115 <li class="md-nav__item">
1116 <a href="#ft_incremental" class="md-nav__link">
1122 <li class="md-nav__item">
1123 <a href="#ft_incremental_metricsrec" class="md-nav__link">
1124 FT_Incremental_MetricsRec
1129 <li class="md-nav__item">
1130 <a href="#ft_incremental_metrics" class="md-nav__link">
1131 FT_Incremental_Metrics
1136 <li class="md-nav__item">
1137 <a href="#ft_incremental_getglyphdatafunc" class="md-nav__link">
1138 FT_Incremental_GetGlyphDataFunc
1143 <li class="md-nav__item">
1144 <a href="#ft_incremental_freeglyphdatafunc" class="md-nav__link">
1145 FT_Incremental_FreeGlyphDataFunc
1150 <li class="md-nav__item">
1151 <a href="#ft_incremental_getglyphmetricsfunc" class="md-nav__link">
1152 FT_Incremental_GetGlyphMetricsFunc
1157 <li class="md-nav__item">
1158 <a href="#ft_incremental_funcsrec" class="md-nav__link">
1159 FT_Incremental_FuncsRec
1164 <li class="md-nav__item">
1165 <a href="#ft_incremental_interfacerec" class="md-nav__link">
1166 FT_Incremental_InterfaceRec
1171 <li class="md-nav__item">
1172 <a href="#ft_incremental_interface" class="md-nav__link">
1173 FT_Incremental_Interface
1190 <div class="md-content">
1191 <article class="md-content__inner md-typeset">
1195 <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#miscellaneous">Miscellaneous</a> » Incremental Loading</p>
1197 <h1 id="incremental-loading">Incremental Loading<a class="headerlink" href="#incremental-loading" title="Permanent link">¶</a></h1>
1198 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2>
1199 <p>This section contains various functions used to perform so-called ‘incremental’ glyph loading. This is a mode where all glyphs loaded from a given <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> are provided by the client application.</p>
1200 <p>Apart from that, all other tables are loaded normally from the font file. This mode is useful when FreeType is used within another engine, e.g., a PostScript Imaging Processor.</p>
1201 <p>To enable this mode, you must use <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code>, passing an <code><a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a></code> with the <code><a href="ft2-parameter_tags.html#ft_param_tag_incremental">FT_PARAM_TAG_INCREMENTAL</a></code> tag and an <code><a href="ft2-incremental.html#ft_incremental_interface">FT_Incremental_Interface</a></code> value. See the comments for <code><a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a></code> for an example.</p>
1202 <h2 id="ft_incremental">FT_Incremental<a class="headerlink" href="#ft_incremental" title="Permanent link">¶</a></h2>
1203 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1204 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_IncrementalRec_* <b>FT_Incremental</b>;
1207 <p>An opaque type describing a user-provided object used to implement ‘incremental’ glyph loading within FreeType. This is used to support embedded fonts in certain environments (e.g., PostScript interpreters), where the glyph data isn't in the font file, or must be overridden by different values.</p>
1210 <p>It is up to client applications to create and implement <code><a href="ft2-incremental.html#ft_incremental">FT_Incremental</a></code> objects, as long as they provide implementations for the methods <code><a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a></code>, <code><a href="ft2-incremental.html#ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc</a></code> and <code><a href="ft2-incremental.html#ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc</a></code>.</p>
1211 <p>See the description of <code><a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a></code> to understand how to use incremental objects with FreeType.</p>
1214 <h2 id="ft_incremental_metricsrec">FT_Incremental_MetricsRec<a class="headerlink" href="#ft_incremental_metricsrec" title="Permanent link">¶</a></h2>
1215 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1216 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Incremental_MetricsRec_
1218 <a href="ft2-basic_types.html#ft_long">FT_Long</a> bearing_x;
1219 <a href="ft2-basic_types.html#ft_long">FT_Long</a> bearing_y;
1220 <a href="ft2-basic_types.html#ft_long">FT_Long</a> advance;
1221 <a href="ft2-basic_types.html#ft_long">FT_Long</a> advance_v; /* since 2.3.12 */
1223 } <b>FT_Incremental_MetricsRec</b>;
1226 <p>A small structure used to contain the basic glyph metrics returned by the <code><a href="ft2-incremental.html#ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc</a></code> method.</p>
1229 <table class="fields">
1230 <tr><td class="val" id="bearing_x">bearing_x</td><td class="desc">
1231 <p>Left bearing, in font units.</p>
1233 <tr><td class="val" id="bearing_y">bearing_y</td><td class="desc">
1234 <p>Top bearing, in font units.</p>
1236 <tr><td class="val" id="advance">advance</td><td class="desc">
1237 <p>Horizontal component of glyph advance, in font units.</p>
1239 <tr><td class="val" id="advance_v">advance_v</td><td class="desc">
1240 <p>Vertical component of glyph advance, in font units.</p>
1246 <p>These correspond to horizontal or vertical metrics depending on the value of the <code>vertical</code> argument to the function <code><a href="ft2-incremental.html#ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc</a></code>.</p>
1249 <h2 id="ft_incremental_metrics">FT_Incremental_Metrics<a class="headerlink" href="#ft_incremental_metrics" title="Permanent link">¶</a></h2>
1250 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1251 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Incremental_MetricsRec_* <b>FT_Incremental_Metrics</b>;
1254 <p>A handle to an <code><a href="ft2-incremental.html#ft_incremental_metricsrec">FT_Incremental_MetricsRec</a></code> structure.</p>
1257 <h2 id="ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc<a class="headerlink" href="#ft_incremental_getglyphdatafunc" title="Permanent link">¶</a></h2>
1258 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1259 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_error">FT_Error</a>
1260 (*<b>FT_Incremental_GetGlyphDataFunc</b>)( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a> incremental,
1261 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> glyph_index,
1262 <a href="ft2-basic_types.html#ft_data">FT_Data</a>* adata );
1265 <p>A function called by FreeType to access a given glyph's data bytes during <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> or <code><a href="ft2-base_interface.html#ft_load_char">FT_Load_Char</a></code> if incremental loading is enabled.</p>
1266 <p>Note that the format of the glyph's data bytes depends on the font file format. For TrueType, it must correspond to the raw bytes within the ‘glyf’ table. For PostScript formats, it must correspond to the <strong>unencrypted</strong> charstring bytes, without any <code>lenIV</code> header. It is undefined for any other format.</p>
1269 <table class="fields">
1270 <tr><td class="val" id="incremental">incremental</td><td class="desc">
1271 <p>Handle to an opaque <code><a href="ft2-incremental.html#ft_incremental">FT_Incremental</a></code> handle provided by the client application.</p>
1273 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
1274 <p>Index of relevant glyph.</p>
1280 <table class="fields">
1281 <tr><td class="val" id="adata">adata</td><td class="desc">
1282 <p>A structure describing the returned glyph data bytes (which will be accessed as a read-only byte block).</p>
1288 <p>FreeType error code. 0 means success.</p>
1291 <p>If this function returns successfully the method <code><a href="ft2-incremental.html#ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc</a></code> will be called later to release the data bytes.</p>
1292 <p>Nested calls to <code><a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a></code> can happen for compound glyphs.</p>
1295 <h2 id="ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc<a class="headerlink" href="#ft_incremental_freeglyphdatafunc" title="Permanent link">¶</a></h2>
1296 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1297 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">void</span>
1298 (*<b>FT_Incremental_FreeGlyphDataFunc</b>)( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a> incremental,
1299 <a href="ft2-basic_types.html#ft_data">FT_Data</a>* data );
1302 <p>A function used to release the glyph data bytes returned by a successful call to <code><a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a></code>.</p>
1305 <table class="fields">
1306 <tr><td class="val" id="incremental">incremental</td><td class="desc">
1307 <p>A handle to an opaque <code><a href="ft2-incremental.html#ft_incremental">FT_Incremental</a></code> handle provided by the client application.</p>
1309 <tr><td class="val" id="data">data</td><td class="desc">
1310 <p>A structure describing the glyph data bytes (which will be accessed as a read-only byte block).</p>
1316 <h2 id="ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc<a class="headerlink" href="#ft_incremental_getglyphmetricsfunc" title="Permanent link">¶</a></h2>
1317 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1318 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_error">FT_Error</a>
1319 (*<b>FT_Incremental_GetGlyphMetricsFunc</b>)
1320 ( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a> incremental,
1321 <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> glyph_index,
1322 <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> vertical,
1323 <a href="ft2-incremental.html#ft_incremental_metricsrec">FT_Incremental_MetricsRec</a> *ametrics );
1326 <p>A function used to retrieve the basic metrics of a given glyph index before accessing its data. This is necessary because, in certain formats like TrueType, the metrics are stored in a different place from the glyph images proper.</p>
1329 <table class="fields">
1330 <tr><td class="val" id="incremental">incremental</td><td class="desc">
1331 <p>A handle to an opaque <code><a href="ft2-incremental.html#ft_incremental">FT_Incremental</a></code> handle provided by the client application.</p>
1333 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
1334 <p>Index of relevant glyph.</p>
1336 <tr><td class="val" id="vertical">vertical</td><td class="desc">
1337 <p>If true, return vertical metrics.</p>
1339 <tr><td class="val" id="ametrics">ametrics</td><td class="desc">
1340 <p>This parameter is used for both input and output. The original glyph metrics, if any, in font units. If metrics are not available all the values must be set to zero.</p>
1346 <table class="fields">
1347 <tr><td class="val" id="ametrics">ametrics</td><td class="desc">
1348 <p>The replacement glyph metrics in font units.</p>
1354 <h2 id="ft_incremental_funcsrec">FT_Incremental_FuncsRec<a class="headerlink" href="#ft_incremental_funcsrec" title="Permanent link">¶</a></h2>
1355 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1356 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Incremental_FuncsRec_
1358 <a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a> get_glyph_data;
1359 <a href="ft2-incremental.html#ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc</a> free_glyph_data;
1360 <a href="ft2-incremental.html#ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc</a> get_glyph_metrics;
1362 } <b>FT_Incremental_FuncsRec</b>;
1365 <p>A table of functions for accessing fonts that load data incrementally. Used in <code><a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a></code>.</p>
1368 <table class="fields">
1369 <tr><td class="val" id="get_glyph_data">get_glyph_data</td><td class="desc">
1370 <p>The function to get glyph data. Must not be null.</p>
1372 <tr><td class="val" id="free_glyph_data">free_glyph_data</td><td class="desc">
1373 <p>The function to release glyph data. Must not be null.</p>
1375 <tr><td class="val" id="get_glyph_metrics">get_glyph_metrics</td><td class="desc">
1376 <p>The function to get glyph metrics. May be null if the font does not provide overriding glyph metrics.</p>
1382 <h2 id="ft_incremental_interfacerec">FT_Incremental_InterfaceRec<a class="headerlink" href="#ft_incremental_interfacerec" title="Permanent link">¶</a></h2>
1383 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1384 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Incremental_InterfaceRec_
1386 <span class="keyword">const</span> <a href="ft2-incremental.html#ft_incremental_funcsrec">FT_Incremental_FuncsRec</a>* funcs;
1387 <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a> object;
1389 } <b>FT_Incremental_InterfaceRec</b>;
1392 <p>A structure to be used with <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> to indicate that the user wants to support incremental glyph loading. You should use it with <code><a href="ft2-parameter_tags.html#ft_param_tag_incremental">FT_PARAM_TAG_INCREMENTAL</a></code> as in the following example:
1393 <div class="highlight"><pre><span></span><code> FT_Incremental_InterfaceRec inc_int;
1394 FT_Parameter parameter;
1395 FT_Open_Args open_args;
1398 // set up incremental descriptor
1399 inc_int.funcs = my_funcs;
1400 inc_int.object = my_object;
1402 // set up optional parameter
1403 parameter.tag = FT_PARAM_TAG_INCREMENTAL;
1404 parameter.data = &inc_int;
1406 // set up FT_Open_Args structure
1407 open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS;
1408 open_args.pathname = my_font_pathname;
1409 open_args.num_params = 1;
1410 open_args.params = &parameter; // we use one optional argument
1413 error = FT_Open_Face( library, &open_args, index, &face );
1415 </code></pre></div></p>
1418 <h2 id="ft_incremental_interface">FT_Incremental_Interface<a class="headerlink" href="#ft_incremental_interface" title="Permanent link">¶</a></h2>
1419 <p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p>
1420 <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a>* <b>FT_Incremental_Interface</b>;
1423 <p>A pointer to an <code><a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a></code> structure.</p>
1441 <footer class="md-footer">
1443 <div class="md-footer-nav">
1444 <nav class="md-footer-nav__inner md-grid">
1446 <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1447 <div class="md-flex__cell md-flex__cell--shrink">
1448 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1450 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1451 <span class="md-flex__ellipsis">
1452 <span class="md-footer-nav__direction">
1455 TrueTypeGX/AAT Validation
1461 <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1462 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1463 <span class="md-flex__ellipsis">
1464 <span class="md-footer-nav__direction">
1470 <div class="md-flex__cell md-flex__cell--shrink">
1471 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1478 <div class="md-footer-meta md-typeset">
1479 <div class="md-footer-meta__inner md-grid">
1480 <div class="md-footer-copyright">
1482 <div class="md-footer-copyright__highlight">
1483 Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1487 <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1489 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1490 Material for MkDocs</a>
1499 <script src="assets/javascripts/application.c33a9706.js"></script>
1501 <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1503 <script src="javascripts/extra.js"></script>