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>Glyph Color Management - 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="#glyph-color-management" 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">                          Glyph Color Management                      </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--active md-nav__item--nested">                    <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>            <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 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">          Glyph Color Management          <span class="md-nav__icon md-icon"></span>        </label>            <a href="ft2-color_management.html" class="md-nav__link md-nav__link--active">        Glyph Color Management      </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_color" class="md-nav__link">    FT_Color  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_xxx" class="md-nav__link">    FT_PALETTE_XXX  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_data" class="md-nav__link">    FT_Palette_Data  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_data_get" class="md-nav__link">    FT_Palette_Data_Get  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_select" class="md-nav__link">    FT_Palette_Select  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_set_foreground_color" class="md-nav__link">    FT_Palette_Set_Foreground_Color  </a>  </li>          </ul>  </nav>          </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--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_color" class="md-nav__link">    FT_Color  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_xxx" class="md-nav__link">    FT_PALETTE_XXX  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_data" class="md-nav__link">    FT_Palette_Data  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_data_get" class="md-nav__link">    FT_Palette_Data_Get  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_select" class="md-nav__link">    FT_Palette_Select  </a>  </li>              <li class="md-nav__item">  <a href="#ft_palette_set_foreground_color" class="md-nav__link">    FT_Palette_Set_Foreground_Color  </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#core-api">Core API</a> &raquo; Glyph Color Management</p><hr /><h1 id="glyph-color-management">Glyph Color Management<a class="headerlink" href="#glyph-color-management" title="Permanent link">&para;</a></h1><h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2><p>The functions described here allow access and manipulation of color palette entries in OpenType's &lsquo;CPAL&rsquo; tables.</p><h2 id="ft_color">FT_Color<a class="headerlink" href="#ft_color" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Color_  {    <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  blue;    <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  green;    <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  red;    <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  alpha;
  } <b>FT_Color</b>;</code></pre></div>
<p>This structure models a BGRA color value of a &lsquo;CPAL&rsquo; palette entry.</p><p>The used color space is sRGB; the colors are not pre-multiplied, and alpha values must be explicitly set.</p><h4>fields</h4><table class="fields"><tr><td class="val" id="blue">blue</td><td class="desc"><p>Blue value.</p></td></tr><tr><td class="val" id="green">green</td><td class="desc"><p>Green value.</p></td></tr><tr><td class="val" id="red">red</td><td class="desc"><p>Red value.</p></td></tr><tr><td class="val" id="alpha">alpha</td><td class="desc"><p>Alpha value, giving the red, green, and blue color's opacity.</p></td></tr></table>
<h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_palette_xxx">FT_PALETTE_XXX<a class="headerlink" href="#ft_palette_xxx" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-color_management.html#ft_palette_for_light_background">FT_PALETTE_FOR_LIGHT_BACKGROUND</a>  0x01#<span class="keyword">define</span> <a href="ft2-color_management.html#ft_palette_for_dark_background">FT_PALETTE_FOR_DARK_BACKGROUND</a>   0x02</code></pre></div>
<p>A list of bit field constants used in the <code>palette_flags</code> array of the <code><a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a></code> structure to indicate for which background a palette with a given index is usable.</p><h4>values</h4><table class="fields long"><tr><td class="val" id="ft_palette_for_light_background">FT_PALETTE_FOR_LIGHT_BACKGROUND</td><td class="desc"><p>The palette is appropriate to use when displaying the font on a light background such as white.</p></td></tr><tr><td class="val" id="ft_palette_for_dark_background">FT_PALETTE_FOR_DARK_BACKGROUND</td><td class="desc"><p>The palette is appropriate to use when displaying the font on a dark background such as black.</p></td></tr></table>
<h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_palette_data">FT_Palette_Data<a class="headerlink" href="#ft_palette_data" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Palette_Data_ {    <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>         num_palettes;    <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_name_ids;    <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_flags;
    <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>         num_palette_entries;    <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_entry_name_ids;
  } <b>FT_Palette_Data</b>;</code></pre></div>
<p>This structure holds the data of the &lsquo;CPAL&rsquo; table.</p><h4>fields</h4><table class="fields"><tr><td class="val" id="num_palettes">num_palettes</td><td class="desc"><p>The number of palettes.</p></td></tr><tr><td class="val" id="palette_name_ids">palette_name_ids</td><td class="desc"><p>An optional read-only array of palette name IDs with <code>num_palettes</code> elements, corresponding to entries like &lsquo;dark&rsquo; or &lsquo;light&rsquo; in the font's &lsquo;name&rsquo; table.</p><p>An empty name ID in the &lsquo;CPAL&rsquo; table gets represented as value 0xFFFF.</p><p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p></td></tr><tr><td class="val" id="palette_flags">palette_flags</td><td class="desc"><p>An optional read-only array of palette flags with <code>num_palettes</code> elements. Possible values are an ORed combination of <code><a href="ft2-color_management.html#ft_palette_xxx">FT_PALETTE_FOR_LIGHT_BACKGROUND</a></code> and <code><a href="ft2-color_management.html#ft_palette_xxx">FT_PALETTE_FOR_DARK_BACKGROUND</a></code>.</p><p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p></td></tr><tr><td class="val" id="num_palette_entries">num_palette_entries</td><td class="desc"><p>The number of entries in a single palette. All palettes have the same size.</p></td></tr><tr><td class="val" id="palette_entry_name_ids">palette_entry_name_ids</td><td class="desc"><p>An optional read-only array of palette entry name IDs with <code>num_palette_entries</code>. In each palette, entries with the same index have the same function. For example, index&nbsp;0 might correspond to string &lsquo;outline&rsquo; in the font's &lsquo;name&rsquo; table to indicate that this palette entry is used for outlines, index&nbsp;1 might correspond to &lsquo;fill&rsquo; to indicate the filling color palette entry, etc.</p><p>An empty entry name ID in the &lsquo;CPAL&rsquo; table gets represented as value 0xFFFF.</p><p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p></td></tr></table>
<h4>note</h4>
<p>Use function <code><a href="ft2-sfnt_names.html#ft_get_sfnt_name">FT_Get_Sfnt_Name</a></code> to map name IDs and entry name IDs to name strings.</p><p>Use function <code><a href="ft2-color_management.html#ft_palette_select">FT_Palette_Select</a></code> to get the colors associated with a palette entry.</p><h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_palette_data_get">FT_Palette_Data_Get<a class="headerlink" href="#ft_palette_data_get" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Palette_Data_Get</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face,                       <a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a>  *apalette );</code></pre></div>
<p>Retrieve the face's color palette data.</p><h4>input</h4><table class="fields"><tr><td class="val" id="face">face</td><td class="desc"><p>The source face handle.</p></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="apalette">apalette</td><td class="desc"><p>A pointer to an <code><a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a></code> structure.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>All arrays in the returned <code><a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a></code> structure are read-only.</p><p>This function always returns an error if the config macro <code>TT_CONFIG_OPTION_COLOR_LAYERS</code> is not defined in <code>ftoption.h</code>.</p><h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_palette_select">FT_Palette_Select<a class="headerlink" href="#ft_palette_select" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Palette_Select</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,                     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>   palette_index,                     <a href="ft2-color_management.html#ft_color">FT_Color</a>*  *apalette );</code></pre></div>
<p>This function has two purposes.</p><p>(1) It activates a palette for rendering color glyphs, and</p><p>(2) it retrieves all (unmodified) color entries of this palette. This function returns a read-write array, which means that a calling application can modify the palette entries on demand.</p><p>A corollary of (2) is that calling the function, then modifying some values, then calling the function again with the same arguments resets all color entries to the original &lsquo;CPAL&rsquo; values; all user modifications are lost.</p><h4>input</h4><table class="fields"><tr><td class="val" id="face">face</td><td class="desc"><p>The source face handle.</p></td></tr><tr><td class="val" id="palette_index">palette_index</td><td class="desc"><p>The palette index.</p></td></tr></table>
<h4>output</h4><table class="fields"><tr><td class="val" id="apalette">apalette</td><td class="desc"><p>An array of color entries for a palette with index <code>palette_index</code>, having <code>num_palette_entries</code> elements (as found in the <code>FT_Palette_Data</code> structure). If <code>apalette</code> is set to <code>NULL</code>, no array gets returned (and no color entries can be modified).</p><p>In case the font doesn't support color palettes, <code>NULL</code> is returned.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>The array pointed to by <code>apalette_entries</code> is owned and managed by FreeType.</p><p>This function always returns an error if the config macro <code>TT_CONFIG_OPTION_COLOR_LAYERS</code> is not defined in <code>ftoption.h</code>.</p><h4>since</h4>
<p>2.10</p><hr>
<h2 id="ft_palette_set_foreground_color">FT_Palette_Set_Foreground_Color<a class="headerlink" href="#ft_palette_set_foreground_color" title="Permanent link">&para;</a></h2><p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p><div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )  <b>FT_Palette_Set_Foreground_Color</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,                                   <a href="ft2-color_management.html#ft_color">FT_Color</a>  foreground_color );</code></pre></div>
<p>&lsquo;COLR&rsquo; uses palette index 0xFFFF to indicate a &lsquo;text foreground color&rsquo;. This function sets this value.</p><h4>input</h4><table class="fields"><tr><td class="val" id="face">face</td><td class="desc"><p>The source face handle.</p></td></tr><tr><td class="val" id="foreground_color">foreground_color</td><td class="desc"><p>An <code>FT_Color</code> structure to define the text foreground color.</p></td></tr></table>
<h4>return</h4>
<p>FreeType error code. 0&nbsp;means success.</p><h4>note</h4>
<p>If this function isn't called, the text foreground color is set to white opaque (BGRA value 0xFFFFFFFF) if <code><a href="ft2-color_management.html#ft_palette_xxx">FT_PALETTE_FOR_DARK_BACKGROUND</a></code> is present for the current palette, and black opaque (BGRA value 0x000000FF) otherwise, including the case that no palette types are available in the &lsquo;CPAL&rsquo; table.</p><p>This function always returns an error if the config macro <code>TT_CONFIG_OPTION_COLOR_LAYERS</code> is not defined in <code>ftoption.h</code>.</p><h4>since</h4>
<p>2.10</p><hr>                                                            

                          </article>          </div>        </div>              </main>              <footer class="md-footer">      <nav class="md-footer__inner md-grid" aria-label="Footer">                      <a href="ft2-glyph_variants.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Unicode Variation Sequences" 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>              Unicode Variation Sequences            </div>          </div>        </a>                            <a href="ft2-layer_management.html" class="md-footer__link md-footer__link--next" aria-label="Next: Glyph Layer Management" rel="next">          <div class="md-footer__title">            <div class="md-ellipsis">              <span class="md-footer__direction">                Next              </span>              Glyph Layer Management            </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>