Imported Upstream version 2.10.4
[platform/upstream/freetype2.git] / docs / reference / ft2-bitmap_handling.html
similarity index 91%
rename from docs/reference/site/ft2-bitmap_handling.html
rename to docs/reference/ft2-bitmap_handling.html
index 6b85128..166bc2b 100644 (file)
@@ -10,7 +10,7 @@
       <meta name="viewport" content="width=device-width,initial-scale=1">
       <meta http-equiv="x-ua-compatible" content="ie=edge">
       
-        <meta name="description" content="API Reference Documentation for FreeType-2.10.1">
+        <meta name="description" content="API Reference Documentation for FreeType-2.10.4">
       
       
       
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="images/favico.ico">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.0.2">
+      <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3">
     
     
       
-        <title>Bitmap Handling - FreeType-2.10.1 API Reference</title>
+        <title>Bitmap Handling - FreeType-2.10.4 API Reference</title>
       
     
     
-      <link rel="stylesheet" href="assets/stylesheets/application.982221ab.css">
+      <link rel="stylesheet" href="assets/stylesheets/application.adb8469c.css">
       
-        <link rel="stylesheet" href="assets/stylesheets/application-palette.224b79ff.css">
+        <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css">
       
       
         
       
     
     
-      <script src="assets/javascripts/modernizr.1f0bcf2b.js"></script>
+      <script src="assets/javascripts/modernizr.86422ebf.js"></script>
     
     
       
         <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700|Roboto+Mono">
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
         <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>
       
     
@@ -89,7 +89,7 @@
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
     
-      <a href="#bitmap-handling" tabindex="1" class="md-skip">
+      <a href="#bitmap-handling" tabindex="0" class="md-skip">
         Skip to content
       </a>
     
@@ -98,9 +98,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="index.html" title="FreeType-2.10.1 API Reference" class="md-header-nav__button md-logo">
+        <a href="." title="FreeType-2.10.4 API Reference" aria-label="FreeType-2.10.4 API Reference" class="md-header-nav__button md-logo">
           
-            <img src="images/favico.ico" width="24" height="24">
+            <img alt="logo" src="images/favico.ico" width="24" height="24">
           
         </a>
       </div>
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
             <span class="md-header-nav__topic">
-              FreeType-2.10.1 API Reference
+              FreeType-2.10.4 API Reference
             </span>
             <span class="md-header-nav__topic">
-              Bitmap Handling
+              
+                Bitmap Handling
+              
             </span>
           
         </div>
   <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" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
+      <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">
       <label class="md-icon md-search__icon" for="__search"></label>
       <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
         &#xE5CD;
         
       
       
-      <main class="md-main">
+      <main class="md-main" role="main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
             
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="index.html" title="FreeType-2.10.1 API Reference" class="md-nav__button md-logo">
+    <a href="." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
       
-        <img src="images/favico.ico" width="48" height="48">
+        <img alt="logo" src="images/favico.ico" width="48" height="48">
       
     </a>
-    FreeType-2.10.1 API Reference
+    FreeType-2.10.4 API Reference
   </label>
   
   <ul class="md-nav__list" data-md-scrollfix>
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#synopsis" title="Synopsis" class="md-nav__link">
+  <a href="#synopsis" class="md-nav__link">
     Synopsis
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_init" title="FT_Bitmap_Init" class="md-nav__link">
+  <a href="#ft_bitmap_init" class="md-nav__link">
     FT_Bitmap_Init
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_copy" title="FT_Bitmap_Copy" class="md-nav__link">
+  <a href="#ft_bitmap_copy" class="md-nav__link">
     FT_Bitmap_Copy
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_embolden" title="FT_Bitmap_Embolden" class="md-nav__link">
+  <a href="#ft_bitmap_embolden" class="md-nav__link">
     FT_Bitmap_Embolden
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_convert" title="FT_Bitmap_Convert" class="md-nav__link">
+  <a href="#ft_bitmap_convert" class="md-nav__link">
     FT_Bitmap_Convert
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_blend" title="FT_Bitmap_Blend" class="md-nav__link">
+  <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" title="FT_GlyphSlot_Own_Bitmap" class="md-nav__link">
+  <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" title="FT_Bitmap_Done" class="md-nav__link">
+  <a href="#ft_bitmap_done" class="md-nav__link">
     FT_Bitmap_Done
   </a>
   
 
 
   <li class="md-nav__item">
-    <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
-      OpenType Validation
+    <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
+      TrueTypeGX/AAT Validation
     </a>
   </li>
 
 
 
   <li class="md-nav__item">
-    <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
-      TrueTypeGX/AAT Validation
+    <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
+      OpenType Validation
     </a>
   </li>
 
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#synopsis" title="Synopsis" class="md-nav__link">
+  <a href="#synopsis" class="md-nav__link">
     Synopsis
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_init" title="FT_Bitmap_Init" class="md-nav__link">
+  <a href="#ft_bitmap_init" class="md-nav__link">
     FT_Bitmap_Init
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_copy" title="FT_Bitmap_Copy" class="md-nav__link">
+  <a href="#ft_bitmap_copy" class="md-nav__link">
     FT_Bitmap_Copy
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_embolden" title="FT_Bitmap_Embolden" class="md-nav__link">
+  <a href="#ft_bitmap_embolden" class="md-nav__link">
     FT_Bitmap_Embolden
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_convert" title="FT_Bitmap_Convert" class="md-nav__link">
+  <a href="#ft_bitmap_convert" class="md-nav__link">
     FT_Bitmap_Convert
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#ft_bitmap_blend" title="FT_Bitmap_Blend" class="md-nav__link">
+  <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" title="FT_GlyphSlot_Own_Bitmap" class="md-nav__link">
+  <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" title="FT_Bitmap_Done" class="md-nav__link">
+  <a href="#ft_bitmap_done" class="md-nav__link">
     FT_Bitmap_Done
   </a>
   
 <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>
-  FT_EXPORT( <span class="keyword">void</span> )
+<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 );
-</pre>
-</div>
+</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>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</code></pre></div>
 
 <p>Copy a bitmap into another one.</p>
 <h4>input</h4>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</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>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</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>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</code></pre></div>
 
 <p>Blend a bitmap onto another bitmap, using a given color.</p>
 <h4>input</h4>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</code></pre></div>
 
 <p>Make sure that a glyph slot owns <code>slot-&gt;bitmap</code>.</p>
 <h4>input</h4>
 
 <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>
-  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
+<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 );
-</pre>
-</div>
+</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>
                 
                   
                 
+                
               
               
                 
       <div class="md-footer-copyright">
         
           <div class="md-footer-copyright__highlight">
-            Copyright 2019 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
+            Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
           </div>
         
         powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
+        <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
         and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
+        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
           Material for MkDocs</a>
       </div>
       
       
     </div>
     
-      <script src="assets/javascripts/application.d9aa80ab.js"></script>
+      <script src="assets/javascripts/application.c33a9706.js"></script>
       
-      <script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
+      <script>app.initialize({version:"1.1",url:{base:"."}})</script>
       
         <script src="javascripts/extra.js"></script>