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>Bitmap Handling - 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="#bitmap-handling" 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">                          Bitmap Handling                      </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--active md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>            <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 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">          Bitmap Handling          <span class="md-nav__icon md-icon"></span>        </label>            <a href="ft2-bitmap_handling.html" class="md-nav__link md-nav__link--active">        Bitmap Handling      </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_bitmap_init" class="md-nav__link">    FT_Bitmap_Init  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_copy" class="md-nav__link">    FT_Bitmap_Copy  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_embolden" class="md-nav__link">    FT_Bitmap_Embolden  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_convert" class="md-nav__link">    FT_Bitmap_Convert  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_blend" class="md-nav__link">    FT_Bitmap_Blend  </a>  </li>              <li class="md-nav__item">  <a href="#ft_glyphslot_own_bitmap" class="md-nav__link">    FT_GlyphSlot_Own_Bitmap  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_done" class="md-nav__link">    FT_Bitmap_Done  </a>  </li>          </ul>  </nav>          </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--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >            <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">      <a href="ft2-incremental.html" class="md-nav__link">        Incremental Loading      </a>    </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_bitmap_init" class="md-nav__link">    FT_Bitmap_Init  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_copy" class="md-nav__link">    FT_Bitmap_Copy  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_embolden" class="md-nav__link">    FT_Bitmap_Embolden  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_convert" class="md-nav__link">    FT_Bitmap_Convert  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_blend" class="md-nav__link">    FT_Bitmap_Blend  </a>  </li>              <li class="md-nav__item">  <a href="#ft_glyphslot_own_bitmap" class="md-nav__link">    FT_GlyphSlot_Own_Bitmap  </a>  </li>              <li class="md-nav__item">  <a href="#ft_bitmap_done" class="md-nav__link">    FT_Bitmap_Done  </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#support-api">Support API</a> &raquo; Bitmap Handling</p><hr /><h1 id="bitmap-handling">Bitmap Handling<a class="headerlink" href="#bitmap-handling" 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 functions for handling <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code> objects, automatically adjusting the target's bitmap buffer size as needed.</p><p>Note that none of the functions changes the bitmap's &lsquo;flow&rsquo; (as indicated by the sign of the <code>pitch</code> field in <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code>).</p><p>To set the flow, assign an appropriate positive or negative value to the <code>pitch</code> field of the target <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code> object after calling <code><a href="ft2-bitmap_handling.html#ft_bitmap_init">FT_Bitmap_Init</a></code> but before calling any of the other functions described here.</p><h2 id="ft_bitmap_init">FT_Bitmap_Init<a class="headerlink" href="#ft_bitmap_init" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <span class="keyword">void</span> )  <b>FT_Bitmap_Init</b>( <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>  *abitmap );

  /* deprecated */  FT_EXPORT( <span class="keyword">void</span> )  FT_Bitmap_New( <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>  *abitmap );</code></pre></div>
<p>Initialize a pointer to an <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code> structure.</p><h4>inout</h4><table class="fields"><tr><td class="val" id="abitmap">abitmap</td><td class="desc"><p>A pointer to the bitmap structure.</p></td></tr></table>
<h4>note</h4>
<p>A deprecated name for the same function is <code>FT_Bitmap_New</code>.</p><hr>
<h2 id="ft_bitmap_copy">FT_Bitmap_Copy<a class="headerlink" href="#ft_bitmap_copy" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Bitmap_Copy</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>        library,                  <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>  *source,                  <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>        *target );</code></pre></div>
<p>Copy a bitmap into another one.</p><h4>input</h4><table class="fields"><tr><td class="val" id="library">library</td><td class="desc"><p>A handle to a library object.</p></td></tr><tr><td class="val" id="source">source</td><td class="desc"><p>A handle to the source bitmap.</p></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="target">target</td><td class="desc"><p>A handle to the target bitmap.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p><code>source-&gt;buffer</code> and <code>target-&gt;buffer</code> must neither be equal nor overlap.</p><hr>
<h2 id="ft_bitmap_embolden">FT_Bitmap_Embolden<a class="headerlink" href="#ft_bitmap_embolden" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Bitmap_Embolden</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>  library,                      <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>*  bitmap,                      <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>      xStrength,                      <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>      yStrength );</code></pre></div>
<p>Embolden a bitmap. The new bitmap will be about <code>xStrength</code> pixels wider and <code>yStrength</code> pixels higher. The left and bottom borders are kept unchanged.</p><h4>input</h4><table class="fields"><tr><td class="val" id="library">library</td><td class="desc"><p>A handle to a library object.</p></td></tr><tr><td class="val" id="xstrength">xStrength</td><td class="desc"><p>How strong the glyph is emboldened horizontally. Expressed in 26.6 pixel format.</p></td></tr><tr><td class="val" id="ystrength">yStrength</td><td class="desc"><p>How strong the glyph is emboldened vertically. Expressed in 26.6 pixel format.</p></td></tr></table>
<h4>inout</h4><table class="fields"><tr><td class="val" id="bitmap">bitmap</td><td class="desc"><p>A handle to the target bitmap.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>The current implementation restricts <code>xStrength</code> to be less than or equal to&nbsp;8 if bitmap is of pixel_mode <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_MONO</a></code>.</p><p>If you want to embolden the bitmap owned by a <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code>, you should call <code><a href="ft2-bitmap_handling.html#ft_glyphslot_own_bitmap">FT_GlyphSlot_Own_Bitmap</a></code> on the slot first.</p><p>Bitmaps in <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY2</a></code> and <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY</a></code>@ format are converted to <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY</a></code> format (i.e., 8bpp).</p><hr>
<h2 id="ft_bitmap_convert">FT_Bitmap_Convert<a class="headerlink" href="#ft_bitmap_convert" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Bitmap_Convert</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>        library,                     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>  *source,                     <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>        *target,                     <a href="ft2-basic_types.html#ft_int">FT_Int</a>            alignment );</code></pre></div>
<p>Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp to a bitmap object with depth 8bpp, making the number of used bytes per line (a.k.a. the &lsquo;pitch&rsquo;) a multiple of <code>alignment</code>.</p><h4>input</h4><table class="fields"><tr><td class="val" id="library">library</td><td class="desc"><p>A handle to a library object.</p></td></tr><tr><td class="val" id="source">source</td><td class="desc"><p>The source bitmap.</p></td></tr><tr><td class="val" id="alignment">alignment</td><td class="desc"><p>The pitch of the bitmap is a multiple of this argument. Common values are 1, 2, or 4.</p></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="target">target</td><td class="desc"><p>The target bitmap.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>It is possible to call <code><a href="ft2-bitmap_handling.html#ft_bitmap_convert">FT_Bitmap_Convert</a></code> multiple times without calling <code><a href="ft2-bitmap_handling.html#ft_bitmap_done">FT_Bitmap_Done</a></code> (the memory is simply reallocated).</p><p>Use <code><a href="ft2-bitmap_handling.html#ft_bitmap_done">FT_Bitmap_Done</a></code> to finally remove the bitmap object.</p><p>The <code>library</code> argument is taken to have access to FreeType's memory handling functions.</p><p><code>source-&gt;buffer</code> and <code>target-&gt;buffer</code> must neither be equal nor overlap.</p><hr>
<h2 id="ft_bitmap_blend">FT_Bitmap_Blend<a class="headerlink" href="#ft_bitmap_blend" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Bitmap_Blend</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>         library,                   <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>*   source,                   <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>    source_offset,                   <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>*         target,                   <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>         *atarget_offset,                   <a href="ft2-color_management.html#ft_color">FT_Color</a>           color );</code></pre></div>
<p>Blend a bitmap onto another bitmap, using a given color.</p><h4>input</h4><table class="fields"><tr><td class="val" id="library">library</td><td class="desc"><p>A handle to a library object.</p></td></tr><tr><td class="val" id="source">source</td><td class="desc"><p>The source bitmap, which can have any <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_Pixel_Mode</a></code> format.</p></td></tr><tr><td class="val" id="source_offset">source_offset</td><td class="desc"><p>The offset vector to the upper left corner of the source bitmap in 26.6 pixel format. It should represent an integer offset; the function will set the lowest six bits to zero to enforce that.</p></td></tr><tr><td class="val" id="color">color</td><td class="desc"><p>The color used to draw <code>source</code> onto <code>target</code>.</p></td></tr></table>
<h4>inout</h4><table class="fields"><tr><td class="val" id="target">target</td><td class="desc"><p>A handle to an <code>FT_Bitmap</code> object. It should be either initialized as empty with a call to <code><a href="ft2-bitmap_handling.html#ft_bitmap_init">FT_Bitmap_Init</a></code>, or it should be of type <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_BGRA</a></code>.</p></td></tr><tr><td class="val" id="atarget_offset">atarget_offset</td><td class="desc"><p>The offset vector to the upper left corner of the target bitmap in 26.6 pixel format. It should represent an integer offset; the function will set the lowest six bits to zero to enforce that.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>This function doesn't perform clipping.</p><p>The bitmap in <code>target</code> gets allocated or reallocated as needed; the vector <code>atarget_offset</code> is updated accordingly.</p><p>In case of allocation or reallocation, the bitmap's pitch is set to <code>4 * width</code>. Both <code>source</code> and <code>target</code> must have the same bitmap flow (as indicated by the sign of the <code>pitch</code> field).</p><p><code>source-&gt;buffer</code> and <code>target-&gt;buffer</code> must neither be equal nor overlap.</p><h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_glyphslot_own_bitmap">FT_GlyphSlot_Own_Bitmap<a class="headerlink" href="#ft_glyphslot_own_bitmap" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_GlyphSlot_Own_Bitmap</b>( <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a>  slot );</code></pre></div>
<p>Make sure that a glyph slot owns <code>slot-&gt;bitmap</code>.</p><h4>input</h4><table class="fields"><tr><td class="val" id="slot">slot</td><td class="desc"><p>The glyph slot.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>This function is to be used in combination with <code><a href="ft2-bitmap_handling.html#ft_bitmap_embolden">FT_Bitmap_Embolden</a></code>.</p><hr>
<h2 id="ft_bitmap_done">FT_Bitmap_Done<a class="headerlink" href="#ft_bitmap_done" title="Permanent link">&para;</a></h2><p>Defined in FT_BITMAP_H (freetype/ftbitmap.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Bitmap_Done</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>  library,                  <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>  *bitmap );</code></pre></div>
<p>Destroy a bitmap object initialized with <code><a href="ft2-bitmap_handling.html#ft_bitmap_init">FT_Bitmap_Init</a></code>.</p><h4>input</h4><table class="fields"><tr><td class="val" id="library">library</td><td class="desc"><p>A handle to a library object.</p></td></tr><tr><td class="val" id="bitmap">bitmap</td><td class="desc"><p>The bitmap object to be freed.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>The <code>library</code> argument is taken to have access to FreeType's memory handling functions.</p><hr>                                                            

                          </article>          </div>        </div>              </main>              <footer class="md-footer">      <nav class="md-footer__inner md-grid" aria-label="Footer">                      <a href="ft2-quick_advance.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Quick retrieval of advance values" 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>              Quick retrieval of advance values            </div>          </div>        </a>                            <a href="ft2-raster.html" class="md-footer__link md-footer__link--next" aria-label="Next: Scanline Converter" rel="next">          <div class="md-footer__title">            <div class="md-ellipsis">              <span class="md-footer__direction">                Next              </span>              Scanline Converter            </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>