antkeeper
/
superbuild


<!doctype html><html lang="en" class="no-js">  <head>          <meta charset="utf-8">      <meta name="viewport" content="width=device-width,initial-scale=1">              <meta name="description" content="API Reference Documentation for FreeType-2.11.0">                          <meta name="author" content="FreeType Contributors">                  <link rel="icon" href="images/favico.ico">      <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9">                      <title>Incremental Loading - FreeType-2.11.0 API Reference</title>                    <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css">                      <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css">                                      <meta name="theme-color" content="#4cae4f">                                                <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">        <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style>                        <link rel="stylesheet" href="stylesheets/extra.css">              

          </head>                            <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green">          <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>        <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">    <label class="md-overlay" for="__drawer"></label>    <div data-md-component="skip">                      <a href="#incremental-loading" class="md-skip">          Skip to content        </a>          </div>    <div data-md-component="announce">          </div>          <header class="md-header" data-md-component="header">  <nav class="md-header__inner md-grid" aria-label="Header">    <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">        <img src="images/favico.ico" alt="logo">
    </a>    <label class="md-header__button md-icon" for="__drawer">      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>    </label>    <div class="md-header__title" data-md-component="header-title">      <div class="md-header__ellipsis">        <div class="md-header__topic">          <span class="md-ellipsis">            FreeType-2.11.0 API Reference          </span>        </div>        <div class="md-header__topic" data-md-component="header-topic">          <span class="md-ellipsis">                          Incremental Loading                      </span>        </div>      </div>    </div>                  <label class="md-header__button md-icon" for="__search">        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>      </label>      <div class="md-search" data-md-component="search" role="dialog">  <label class="md-search__overlay" for="__search"></label>  <div class="md-search__inner" role="search">    <form class="md-search__form" name="search">      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>      <label class="md-search__icon md-icon" for="__search">        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>      </label>      <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>      </button>    </form>    <div class="md-search__output">      <div class="md-search__scrollwrap" data-md-scrollfix>        <div class="md-search-result" data-md-component="search-result">          <div class="md-search-result__meta">            Initializing search          </div>          <ol class="md-search-result__list"></ol>        </div>      </div>    </div>  </div></div>          </nav></header>        <div class="md-container" data-md-component="container">                                <main class="md-main" data-md-component="main">        <div class="md-main__inner md-grid">                                                  <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >                <div class="md-sidebar__scrollwrap">                  <div class="md-sidebar__inner">                    

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">  <label class="md-nav__title" for="__drawer">    <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">        <img src="images/favico.ico" alt="logo">
    </a>    FreeType-2.11.0 API Reference  </label>    <ul class="md-nav__list" data-md-scrollfix>                      
          <li class="md-nav__item">      <a href="index.html" class="md-nav__link">        TOC      </a>    </li>  
                      
          <li class="md-nav__item">      <a href="ft2-index.html" class="md-nav__link">        Index      </a>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >            <label class="md-nav__link" for="__nav_3">        General Remarks        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="General Remarks" data-md-level="1">        <label class="md-nav__title" for="__nav_3">          <span class="md-nav__icon md-icon"></span>          General Remarks        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-preamble.html" class="md-nav__link">        Preamble      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-header_inclusion.html" class="md-nav__link">        FreeType's header inclusion scheme      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-user_allocation.html" class="md-nav__link">        User allocation      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >            <label class="md-nav__link" for="__nav_4">        Core API        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Core API" data-md-level="1">        <label class="md-nav__title" for="__nav_4">          <span class="md-nav__icon md-icon"></span>          Core API        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-version.html" class="md-nav__link">        FreeType Version      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-basic_types.html" class="md-nav__link">        Basic Data Types      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-base_interface.html" class="md-nav__link">        Base Interface      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-glyph_variants.html" class="md-nav__link">        Unicode Variation Sequences      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-color_management.html" class="md-nav__link">        Glyph Color Management      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-layer_management.html" class="md-nav__link">        Glyph Layer Management      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-glyph_management.html" class="md-nav__link">        Glyph Management      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-mac_specific.html" class="md-nav__link">        Mac Specific Interface      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-sizes_management.html" class="md-nav__link">        Size Management      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-header_file_macros.html" class="md-nav__link">        Header File Macros      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >            <label class="md-nav__link" for="__nav_5">        Format-Specific API        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">        <label class="md-nav__title" for="__nav_5">          <span class="md-nav__icon md-icon"></span>          Format-Specific API        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-multiple_masters.html" class="md-nav__link">        Multiple Masters      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-truetype_tables.html" class="md-nav__link">        TrueType Tables      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-type1_tables.html" class="md-nav__link">        Type 1 Tables      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-sfnt_names.html" class="md-nav__link">        SFNT Names      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-bdf_fonts.html" class="md-nav__link">        BDF and PCF Files      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-cid_fonts.html" class="md-nav__link">        CID Fonts      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-pfr_fonts.html" class="md-nav__link">        PFR Fonts      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-winfnt_fonts.html" class="md-nav__link">        Window FNT Files      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-font_formats.html" class="md-nav__link">        Font Formats      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-gasp_table.html" class="md-nav__link">        Gasp Table      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >            <label class="md-nav__link" for="__nav_6">        Controlling FreeType Modules        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">        <label class="md-nav__title" for="__nav_6">          <span class="md-nav__icon md-icon"></span>          Controlling FreeType Modules        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-auto_hinter.html" class="md-nav__link">        The auto-hinter      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-cff_driver.html" class="md-nav__link">        The CFF driver      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-t1_cid_driver.html" class="md-nav__link">        The Type 1 and CID drivers      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-tt_driver.html" class="md-nav__link">        The TrueType driver      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-pcf_driver.html" class="md-nav__link">        The PCF driver      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-properties.html" class="md-nav__link">        Driver properties      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-parameter_tags.html" class="md-nav__link">        Parameter Tags      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-lcd_rendering.html" class="md-nav__link">        Subpixel Rendering      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >            <label class="md-nav__link" for="__nav_7">        Cache Sub-System        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">        <label class="md-nav__title" for="__nav_7">          <span class="md-nav__icon md-icon"></span>          Cache Sub-System        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-cache_subsystem.html" class="md-nav__link">        Cache Sub-System      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >            <label class="md-nav__link" for="__nav_8">        Support API        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Support API" data-md-level="1">        <label class="md-nav__title" for="__nav_8">          <span class="md-nav__icon md-icon"></span>          Support API        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-computations.html" class="md-nav__link">        Computations      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-list_processing.html" class="md-nav__link">        List Processing      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-outline_processing.html" class="md-nav__link">        Outline Processing      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-quick_advance.html" class="md-nav__link">        Quick retrieval of advance values      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-bitmap_handling.html" class="md-nav__link">        Bitmap Handling      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-raster.html" class="md-nav__link">        Scanline Converter      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-glyph_stroker.html" class="md-nav__link">        Glyph Stroker      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-system_interface.html" class="md-nav__link">        System Interface      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-module_management.html" class="md-nav__link">        Module Management      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-gzip.html" class="md-nav__link">        GZIP Streams      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-lzw.html" class="md-nav__link">        LZW Streams      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-bzip2.html" class="md-nav__link">        BZIP2 Streams      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-debugging_apis.html" class="md-nav__link">        External Debugging APIs      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
              <li class="md-nav__item md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >            <label class="md-nav__link" for="__nav_9">        Error Codes        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Error Codes" data-md-level="1">        <label class="md-nav__title" for="__nav_9">          <span class="md-nav__icon md-icon"></span>          Error Codes        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-error_enumerations.html" class="md-nav__link">        Error Enumerations      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-error_code_values.html" class="md-nav__link">        Error Code Values      </a>    </li>  
                  </ul>      </nav>    </li>  
                      
                    <li class="md-nav__item md-nav__item--active md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" checked>            <label class="md-nav__link" for="__nav_10">        Miscellaneous        <span class="md-nav__icon md-icon"></span>      </label>      <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">        <label class="md-nav__title" for="__nav_10">          <span class="md-nav__icon md-icon"></span>          Miscellaneous        </label>        <ul class="md-nav__list" data-md-scrollfix>                                <li class="md-nav__item">      <a href="ft2-gx_validation.html" class="md-nav__link">        TrueTypeGX/AAT Validation      </a>    </li>  
                                      <li class="md-nav__item md-nav__item--active">            <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">                                        <label class="md-nav__link md-nav__link--active" for="__toc">          Incremental Loading          <span class="md-nav__icon md-icon"></span>        </label>            <a href="ft2-incremental.html" class="md-nav__link md-nav__link--active">        Incremental Loading      </a>              <nav class="md-nav md-nav--secondary" aria-label="Table of contents">                  <label class="md-nav__title" for="__toc">      <span class="md-nav__icon md-icon"></span>      Table of contents    </label>    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>              <li class="md-nav__item">  <a href="#synopsis" class="md-nav__link">    Synopsis  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental" class="md-nav__link">    FT_Incremental  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_metricsrec" class="md-nav__link">    FT_Incremental_MetricsRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_metrics" class="md-nav__link">    FT_Incremental_Metrics  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_getglyphdatafunc" class="md-nav__link">    FT_Incremental_GetGlyphDataFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_freeglyphdatafunc" class="md-nav__link">    FT_Incremental_FreeGlyphDataFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_getglyphmetricsfunc" class="md-nav__link">    FT_Incremental_GetGlyphMetricsFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_funcsrec" class="md-nav__link">    FT_Incremental_FuncsRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_interfacerec" class="md-nav__link">    FT_Incremental_InterfaceRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_interface" class="md-nav__link">    FT_Incremental_Interface  </a>  </li>          </ul>  </nav>          </li>  
                                <li class="md-nav__item">      <a href="ft2-truetype_engine.html" class="md-nav__link">        The TrueType Engine      </a>    </li>  
                                <li class="md-nav__item">      <a href="ft2-ot_validation.html" class="md-nav__link">        OpenType Validation      </a>    </li>  
                  </ul>      </nav>    </li>  
      </ul></nav>                  </div>                </div>              </div>                                                    <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >                <div class="md-sidebar__scrollwrap">                  <div class="md-sidebar__inner">                    <nav class="md-nav md-nav--secondary" aria-label="Table of contents">                  <label class="md-nav__title" for="__toc">      <span class="md-nav__icon md-icon"></span>      Table of contents    </label>    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>              <li class="md-nav__item">  <a href="#synopsis" class="md-nav__link">    Synopsis  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental" class="md-nav__link">    FT_Incremental  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_metricsrec" class="md-nav__link">    FT_Incremental_MetricsRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_metrics" class="md-nav__link">    FT_Incremental_Metrics  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_getglyphdatafunc" class="md-nav__link">    FT_Incremental_GetGlyphDataFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_freeglyphdatafunc" class="md-nav__link">    FT_Incremental_FreeGlyphDataFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_getglyphmetricsfunc" class="md-nav__link">    FT_Incremental_GetGlyphMetricsFunc  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_funcsrec" class="md-nav__link">    FT_Incremental_FuncsRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_interfacerec" class="md-nav__link">    FT_Incremental_InterfaceRec  </a>  </li>              <li class="md-nav__item">  <a href="#ft_incremental_interface" class="md-nav__link">    FT_Incremental_Interface  </a>  </li>          </ul>  </nav>                  </div>                </div>              </div>                                <div class="md-content" data-md-component="content">            <article class="md-content__inner md-typeset">                                                              <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#miscellaneous">Miscellaneous</a> &raquo; Incremental Loading</p><hr /><h1 id="incremental-loading">Incremental Loading<a class="headerlink" href="#incremental-loading" title="Permanent link">&para;</a></h1><h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2><p>This section contains various functions used to perform so-called &lsquo;incremental&rsquo; 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><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><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><h2 id="ft_incremental">FT_Incremental<a class="headerlink" href="#ft_incremental" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_IncrementalRec_*  <b>FT_Incremental</b>;</code></pre></div>
<p>An opaque type describing a user-provided object used to implement &lsquo;incremental&rsquo; 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><h4>note</h4>
<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><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><hr>
<h2 id="ft_incremental_metricsrec">FT_Incremental_MetricsRec<a class="headerlink" href="#ft_incremental_metricsrec" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Incremental_MetricsRec_  {    <a href="ft2-basic_types.html#ft_long">FT_Long</a>  bearing_x;    <a href="ft2-basic_types.html#ft_long">FT_Long</a>  bearing_y;    <a href="ft2-basic_types.html#ft_long">FT_Long</a>  advance;    <a href="ft2-basic_types.html#ft_long">FT_Long</a>  advance_v;     /* since 2.3.12 */
  } <b>FT_Incremental_MetricsRec</b>;</code></pre></div>
<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><h4>fields</h4><table class="fields"><tr><td class="val" id="bearing_x">bearing_x</td><td class="desc"><p>Left bearing, in font units.</p></td></tr><tr><td class="val" id="bearing_y">bearing_y</td><td class="desc"><p>Top bearing, in font units.</p></td></tr><tr><td class="val" id="advance">advance</td><td class="desc"><p>Horizontal component of glyph advance, in font units.</p></td></tr><tr><td class="val" id="advance_v">advance_v</td><td class="desc"><p>Vertical component of glyph advance, in font units.</p></td></tr></table>
<h4>note</h4>
<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><hr>
<h2 id="ft_incremental_metrics">FT_Incremental_Metrics<a class="headerlink" href="#ft_incremental_metrics" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>   <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Incremental_MetricsRec_*  <b>FT_Incremental_Metrics</b>;</code></pre></div>
<p>A handle to an <code><a href="ft2-incremental.html#ft_incremental_metricsrec">FT_Incremental_MetricsRec</a></code> structure.</p><hr>
<h2 id="ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc<a class="headerlink" href="#ft_incremental_getglyphdatafunc" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_error">FT_Error</a>  (*<b>FT_Incremental_GetGlyphDataFunc</b>)( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a>  incremental,                                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>         glyph_index,                                      <a href="ft2-basic_types.html#ft_data">FT_Data</a>*        adata );</code></pre></div>
<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><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 &lsquo;glyf&rsquo; 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><h4>input</h4><table class="fields"><tr><td class="val" id="incremental">incremental</td><td class="desc"><p>Handle to an opaque <code><a href="ft2-incremental.html#ft_incremental">FT_Incremental</a></code> handle provided by the client application.</p></td></tr><tr><td class="val" id="glyph_index">glyph_index</td><td class="desc"><p>Index of relevant glyph.</p></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="adata">adata</td><td class="desc"><p>A structure describing the returned glyph data bytes (which will be accessed as a read-only byte block).</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<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><p>Nested calls to <code><a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a></code> can happen for compound glyphs.</p><hr>
<h2 id="ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc<a class="headerlink" href="#ft_incremental_freeglyphdatafunc" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">void</span>  (*<b>FT_Incremental_FreeGlyphDataFunc</b>)( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a>  incremental,                                       <a href="ft2-basic_types.html#ft_data">FT_Data</a>*        data );</code></pre></div>
<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><h4>input</h4><table class="fields"><tr><td class="val" id="incremental">incremental</td><td class="desc"><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></td></tr><tr><td class="val" id="data">data</td><td class="desc"><p>A structure describing the glyph data bytes (which will be accessed as a read-only byte block).</p></td></tr></table>
<hr>
<h2 id="ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc<a class="headerlink" href="#ft_incremental_getglyphmetricsfunc" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_error">FT_Error</a>  (*<b>FT_Incremental_GetGlyphMetricsFunc</b>)                      ( <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a>              incremental,                        <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>                     glyph_index,                        <a href="ft2-basic_types.html#ft_bool">FT_Bool</a>                     vertical,                        <a href="ft2-incremental.html#ft_incremental_metricsrec">FT_Incremental_MetricsRec</a>  *ametrics );</code></pre></div>
<p>A function used to retrieve the basic metrics of a given glyph index before accessing its data. This allows for handling font types such as PCL&nbsp;XL Format&nbsp;1, Class&nbsp;2 downloaded TrueType fonts, where the glyph metrics (<code>hmtx</code> and <code>vmtx</code> tables) are permitted to be omitted from the font, and the relevant metrics included in the header of the glyph outline data. Importantly, this is not intended to allow custom glyph metrics (for example, Postscript Metrics dictionaries), because that conflicts with the requirements of outline hinting. Such custom metrics must be handled separately, by the calling application.</p><h4>input</h4><table class="fields"><tr><td class="val" id="incremental">incremental</td><td class="desc"><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></td></tr><tr><td class="val" id="glyph_index">glyph_index</td><td class="desc"><p>Index of relevant glyph.</p></td></tr><tr><td class="val" id="vertical">vertical</td><td class="desc"><p>If true, return vertical metrics.</p></td></tr><tr><td class="val" id="ametrics">ametrics</td><td class="desc"><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></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="ametrics">ametrics</td><td class="desc"><p>The glyph metrics in font units.</p></td></tr></table>
<hr>
<h2 id="ft_incremental_funcsrec">FT_Incremental_FuncsRec<a class="headerlink" href="#ft_incremental_funcsrec" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Incremental_FuncsRec_  {    <a href="ft2-incremental.html#ft_incremental_getglyphdatafunc">FT_Incremental_GetGlyphDataFunc</a>     get_glyph_data;    <a href="ft2-incremental.html#ft_incremental_freeglyphdatafunc">FT_Incremental_FreeGlyphDataFunc</a>    free_glyph_data;    <a href="ft2-incremental.html#ft_incremental_getglyphmetricsfunc">FT_Incremental_GetGlyphMetricsFunc</a>  get_glyph_metrics;
  } <b>FT_Incremental_FuncsRec</b>;</code></pre></div>
<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><h4>fields</h4><table class="fields"><tr><td class="val" id="get_glyph_data">get_glyph_data</td><td class="desc"><p>The function to get glyph data. Must not be null.</p></td></tr><tr><td class="val" id="free_glyph_data">free_glyph_data</td><td class="desc"><p>The function to release glyph data. Must not be null.</p></td></tr><tr><td class="val" id="get_glyph_metrics">get_glyph_metrics</td><td class="desc"><p>The function to get glyph metrics. May be null if the font does not require it.</p></td></tr></table>
<hr>
<h2 id="ft_incremental_interfacerec">FT_Incremental_InterfaceRec<a class="headerlink" href="#ft_incremental_interfacerec" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Incremental_InterfaceRec_  {    <span class="keyword">const</span> <a href="ft2-incremental.html#ft_incremental_funcsrec">FT_Incremental_FuncsRec</a>*  funcs;    <a href="ft2-incremental.html#ft_incremental">FT_Incremental</a>                  object;
  } <b>FT_Incremental_InterfaceRec</b>;</code></pre></div>
<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:<div class="highlight"><pre><span></span><code>  FT_Incremental_InterfaceRec  inc_int;  FT_Parameter                 parameter;  FT_Open_Args                 open_args;

  // set up incremental descriptor  inc_int.funcs  = my_funcs;  inc_int.object = my_object;
  // set up optional parameter  parameter.tag  = FT_PARAM_TAG_INCREMENTAL;  parameter.data = &amp;inc_int;
  // set up FT_Open_Args structure  open_args.flags      = FT_OPEN_PATHNAME | FT_OPEN_PARAMS;  open_args.pathname   = my_font_pathname;  open_args.num_params = 1;  open_args.params     = &amp;parameter; // we use one optional argument
  // open the font  error = FT_Open_Face( library, &amp;open_args, index, &amp;face );  ...</code></pre></div></p><hr>
<h2 id="ft_incremental_interface">FT_Incremental_Interface<a class="headerlink" href="#ft_incremental_interface" title="Permanent link">&para;</a></h2><p>Defined in FT_INCREMENTAL_H (freetype/ftincrem.h).</p><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>;</code></pre></div>
<p>A pointer to an <code><a href="ft2-incremental.html#ft_incremental_interfacerec">FT_Incremental_InterfaceRec</a></code> structure.</p><hr>                                                            

                          </article>          </div>        </div>              </main>              <footer class="md-footer">      <nav class="md-footer__inner md-grid" aria-label="Footer">                      <a href="ft2-gx_validation.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: TrueTypeGX/AAT Validation" rel="prev">          <div class="md-footer__button md-icon">            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>          </div>          <div class="md-footer__title">            <div class="md-ellipsis">              <span class="md-footer__direction">                Previous              </span>              TrueTypeGX/AAT Validation            </div>          </div>        </a>                            <a href="ft2-truetype_engine.html" class="md-footer__link md-footer__link--next" aria-label="Next: The TrueType Engine" rel="next">          <div class="md-footer__title">            <div class="md-ellipsis">              <span class="md-footer__direction">                Next              </span>              The TrueType Engine            </div>          </div>          <div class="md-footer__button md-icon">            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>          </div>        </a>          </nav>    <div class="md-footer-meta md-typeset">    <div class="md-footer-meta__inner md-grid">      <div class="md-footer-copyright">                  <div class="md-footer-copyright__highlight">            Copyright 2021 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.          </div>                Made with        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">          Material for MkDocs        </a>              </div>          </div>  </div></footer>          </div>    <div class="md-dialog" data-md-component="dialog">      <div class="md-dialog__inner md-typeset"></div>    </div>    <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script>              <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>              <script src="javascripts/extra.js"></script>            </body></html>