docs/reference/ft2-color_management.html

   1
   2
   3
   4
   5 <!doctype html>
   6 <html lang="en" class="no-js">
   7   <head>
   8
   9       <meta charset="utf-8">
  10       <meta name="viewport" content="width=device-width,initial-scale=1">
  11       <meta http-equiv="x-ua-compatible" content="ie=edge">
  12
  13         <meta name="description" content="API Reference Documentation for FreeType-2.10.4">
  14
  15
  16
  17         <meta name="author" content="FreeType Contributors">
  18
  19
  20         <meta name="lang:clipboard.copy" content="Copy to clipboard">
  21
  22         <meta name="lang:clipboard.copied" content="Copied to clipboard">
  23
  24         <meta name="lang:search.language" content="en">
  25
  26         <meta name="lang:search.pipeline.stopwords" content="True">
  27
  28         <meta name="lang:search.pipeline.trimmer" content="True">
  29
  30         <meta name="lang:search.result.none" content="No matching documents">
  31
  32         <meta name="lang:search.result.one" content="1 matching document">
  33
  34         <meta name="lang:search.result.other" content="# matching documents">
  35
  36         <meta name="lang:search.tokenizer" content="[\s\-]+">
  37
  38       <link rel="shortcut icon" href="images/favico.ico">
  39       <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3">
  40
  41
  42
  43         <title>Glyph Color Management - FreeType-2.10.4 API Reference</title>
  44
  45
  46
  47       <link rel="stylesheet" href="assets/stylesheets/application.adb8469c.css">
  48
  49         <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css">
  50
  51
  52
  53
  54         <meta name="theme-color" content="#4caf50">
  55
  56
  57
  58       <script src="assets/javascripts/modernizr.86422ebf.js"></script>
  59
  60
  61
  62         <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  63         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
  64         <style>body,input{font-family:"Noto Serif","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  65
  66
  67     <link rel="stylesheet" href="assets/fonts/material-icons.css">
  68
  69
  70       <link rel="stylesheet" href="stylesheets/extra.css">
  71
  72
  73
  74
  75
  76   </head>
  77
  78
  79
  80     <body dir="ltr" data-md-color-primary="green" data-md-color-accent="green">
  81
  82     <svg class="md-svg">
  83       <defs>
  84
  85
  86       </defs>
  87     </svg>
  88     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  89     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  90     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  91
  92       <a href="#glyph-color-management" tabindex="0" class="md-skip">
  93         Skip to content
  94       </a>
  95
  96
  97       <header class="md-header" data-md-component="header">
  98   <nav class="md-header-nav md-grid">
  99     <div class="md-flex">
 100       <div class="md-flex__cell md-flex__cell--shrink">
 101         <a href="." title="FreeType-2.10.4 API Reference" aria-label="FreeType-2.10.4 API Reference" class="md-header-nav__button md-logo">
 102
 103             <img alt="logo" src="images/favico.ico" width="24" height="24">
 104
 105         </a>
 106       </div>
 107       <div class="md-flex__cell md-flex__cell--shrink">
 108         <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
 109       </div>
 110       <div class="md-flex__cell md-flex__cell--stretch">
 111         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
 112
 113             <span class="md-header-nav__topic">
 114               FreeType-2.10.4 API Reference
 115             </span>
 116             <span class="md-header-nav__topic">
 117
 118                 Glyph Color Management
 119
 120             </span>
 121
 122         </div>
 123       </div>
 124       <div class="md-flex__cell md-flex__cell--shrink">
 125
 126           <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
 127
 128 <div class="md-search" data-md-component="search" role="dialog">
 129   <label class="md-search__overlay" for="__search"></label>
 130   <div class="md-search__inner" role="search">
 131     <form class="md-search__form" name="search">
 132       <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
 133       <label class="md-icon md-search__icon" for="__search"></label>
 134       <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
 135         &#xE5CD;
 136       </button>
 137     </form>
 138     <div class="md-search__output">
 139       <div class="md-search__scrollwrap" data-md-scrollfix>
 140         <div class="md-search-result" data-md-component="result">
 141           <div class="md-search-result__meta">
 142             Type to start searching
 143           </div>
 144           <ol class="md-search-result__list"></ol>
 145         </div>
 146       </div>
 147     </div>
 148   </div>
 149 </div>
 150
 151       </div>
 152
 153     </div>
 154   </nav>
 155 </header>
 156
 157     <div class="md-container">
 158
 159
 160
 161
 162       <main class="md-main" role="main">
 163         <div class="md-main__inner md-grid" data-md-component="container">
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169                     <nav class="md-nav md-nav--primary" data-md-level="0">
 170   <label class="md-nav__title md-nav__title--site" for="__drawer">
 171     <a href="." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
 172
 173         <img alt="logo" src="images/favico.ico" width="48" height="48">
 174
 175     </a>
 176     FreeType-2.10.4 API Reference
 177   </label>
 178
 179   <ul class="md-nav__list" data-md-scrollfix>
 180
 181
 182
 183
 184
 185
 186   <li class="md-nav__item">
 187     <a href="index.html" title="TOC" class="md-nav__link">
 188       TOC
 189     </a>
 190   </li>
 191
 192
 193
 194
 195
 196
 197
 198   <li class="md-nav__item">
 199     <a href="ft2-index.html" title="Index" class="md-nav__link">
 200       Index
 201     </a>
 202   </li>
 203
 204
 205
 206
 207
 208
 209
 210   <li class="md-nav__item md-nav__item--nested">
 211
 212       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
 213
 214     <label class="md-nav__link" for="nav-3">
 215       General Remarks
 216     </label>
 217     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 218       <label class="md-nav__title" for="nav-3">
 219         General Remarks
 220       </label>
 221       <ul class="md-nav__list" data-md-scrollfix>
 222
 223
 224
 225
 226
 227
 228
 229   <li class="md-nav__item">
 230     <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
 231       FreeType's header inclusion scheme
 232     </a>
 233   </li>
 234
 235
 236
 237
 238
 239
 240
 241   <li class="md-nav__item">
 242     <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link">
 243       User allocation
 244     </a>
 245   </li>
 246
 247
 248       </ul>
 249     </nav>
 250   </li>
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 261
 262       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
 263
 264     <label class="md-nav__link" for="nav-4">
 265       Core API
 266     </label>
 267     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 268       <label class="md-nav__title" for="nav-4">
 269         Core API
 270       </label>
 271       <ul class="md-nav__list" data-md-scrollfix>
 272
 273
 274
 275
 276
 277
 278
 279   <li class="md-nav__item">
 280     <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
 281       FreeType Version
 282     </a>
 283   </li>
 284
 285
 286
 287
 288
 289
 290
 291   <li class="md-nav__item">
 292     <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
 293       Basic Data Types
 294     </a>
 295   </li>
 296
 297
 298
 299
 300
 301
 302
 303   <li class="md-nav__item">
 304     <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link">
 305       Base Interface
 306     </a>
 307   </li>
 308
 309
 310
 311
 312
 313
 314
 315   <li class="md-nav__item">
 316     <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
 317       Unicode Variation Sequences
 318     </a>
 319   </li>
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329   <li class="md-nav__item md-nav__item--active">
 330
 331     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 332
 333
 334
 335
 336       <label class="md-nav__link md-nav__link--active" for="__toc">
 337         Glyph Color Management
 338       </label>
 339
 340     <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link md-nav__link--active">
 341       Glyph Color Management
 342     </a>
 343
 344
 345 <nav class="md-nav md-nav--secondary">
 346
 347
 348
 349
 350
 351     <label class="md-nav__title" for="__toc">Table of contents</label>
 352     <ul class="md-nav__list" data-md-scrollfix>
 353
 354         <li class="md-nav__item">
 355   <a href="#synopsis" class="md-nav__link">
 356     Synopsis
 357   </a>
 358
 359 </li>
 360
 361         <li class="md-nav__item">
 362   <a href="#ft_color" class="md-nav__link">
 363     FT_Color
 364   </a>
 365
 366 </li>
 367
 368         <li class="md-nav__item">
 369   <a href="#ft_palette_xxx" class="md-nav__link">
 370     FT_PALETTE_XXX
 371   </a>
 372
 373 </li>
 374
 375         <li class="md-nav__item">
 376   <a href="#ft_palette_data" class="md-nav__link">
 377     FT_Palette_Data
 378   </a>
 379
 380 </li>
 381
 382         <li class="md-nav__item">
 383   <a href="#ft_palette_data_get" class="md-nav__link">
 384     FT_Palette_Data_Get
 385   </a>
 386
 387 </li>
 388
 389         <li class="md-nav__item">
 390   <a href="#ft_palette_select" class="md-nav__link">
 391     FT_Palette_Select
 392   </a>
 393
 394 </li>
 395
 396         <li class="md-nav__item">
 397   <a href="#ft_palette_set_foreground_color" class="md-nav__link">
 398     FT_Palette_Set_Foreground_Color
 399   </a>
 400
 401 </li>
 402
 403
 404
 405
 406
 407     </ul>
 408
 409 </nav>
 410
 411   </li>
 412
 413
 414
 415
 416
 417
 418
 419   <li class="md-nav__item">
 420     <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
 421       Glyph Layer Management
 422     </a>
 423   </li>
 424
 425
 426
 427
 428
 429
 430
 431   <li class="md-nav__item">
 432     <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
 433       Glyph Management
 434     </a>
 435   </li>
 436
 437
 438
 439
 440
 441
 442
 443   <li class="md-nav__item">
 444     <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
 445       Mac Specific Interface
 446     </a>
 447   </li>
 448
 449
 450
 451
 452
 453
 454
 455   <li class="md-nav__item">
 456     <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
 457       Size Management
 458     </a>
 459   </li>
 460
 461
 462
 463
 464
 465
 466
 467   <li class="md-nav__item">
 468     <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
 469       Header File Macros
 470     </a>
 471   </li>
 472
 473
 474       </ul>
 475     </nav>
 476   </li>
 477
 478
 479
 480
 481
 482
 483
 484   <li class="md-nav__item md-nav__item--nested">
 485
 486       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
 487
 488     <label class="md-nav__link" for="nav-5">
 489       Format-Specific API
 490     </label>
 491     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 492       <label class="md-nav__title" for="nav-5">
 493         Format-Specific API
 494       </label>
 495       <ul class="md-nav__list" data-md-scrollfix>
 496
 497
 498
 499
 500
 501
 502
 503   <li class="md-nav__item">
 504     <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
 505       Multiple Masters
 506     </a>
 507   </li>
 508
 509
 510
 511
 512
 513
 514
 515   <li class="md-nav__item">
 516     <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
 517       TrueType Tables
 518     </a>
 519   </li>
 520
 521
 522
 523
 524
 525
 526
 527   <li class="md-nav__item">
 528     <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
 529       Type 1 Tables
 530     </a>
 531   </li>
 532
 533
 534
 535
 536
 537
 538
 539   <li class="md-nav__item">
 540     <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
 541       SFNT Names
 542     </a>
 543   </li>
 544
 545
 546
 547
 548
 549
 550
 551   <li class="md-nav__item">
 552     <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
 553       BDF and PCF Files
 554     </a>
 555   </li>
 556
 557
 558
 559
 560
 561
 562
 563   <li class="md-nav__item">
 564     <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
 565       CID Fonts
 566     </a>
 567   </li>
 568
 569
 570
 571
 572
 573
 574
 575   <li class="md-nav__item">
 576     <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
 577       PFR Fonts
 578     </a>
 579   </li>
 580
 581
 582
 583
 584
 585
 586
 587   <li class="md-nav__item">
 588     <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
 589       Window FNT Files
 590     </a>
 591   </li>
 592
 593
 594
 595
 596
 597
 598
 599   <li class="md-nav__item">
 600     <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
 601       Font Formats
 602     </a>
 603   </li>
 604
 605
 606
 607
 608
 609
 610
 611   <li class="md-nav__item">
 612     <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
 613       Gasp Table
 614     </a>
 615   </li>
 616
 617
 618       </ul>
 619     </nav>
 620   </li>
 621
 622
 623
 624
 625
 626
 627
 628   <li class="md-nav__item md-nav__item--nested">
 629
 630       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
 631
 632     <label class="md-nav__link" for="nav-6">
 633       Controlling FreeType Modules
 634     </label>
 635     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 636       <label class="md-nav__title" for="nav-6">
 637         Controlling FreeType Modules
 638       </label>
 639       <ul class="md-nav__list" data-md-scrollfix>
 640
 641
 642
 643
 644
 645
 646
 647   <li class="md-nav__item">
 648     <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
 649       The auto-hinter
 650     </a>
 651   </li>
 652
 653
 654
 655
 656
 657
 658
 659   <li class="md-nav__item">
 660     <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
 661       The CFF driver
 662     </a>
 663   </li>
 664
 665
 666
 667
 668
 669
 670
 671   <li class="md-nav__item">
 672     <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
 673       The Type 1 and CID drivers
 674     </a>
 675   </li>
 676
 677
 678
 679
 680
 681
 682
 683   <li class="md-nav__item">
 684     <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
 685       The TrueType driver
 686     </a>
 687   </li>
 688
 689
 690
 691
 692
 693
 694
 695   <li class="md-nav__item">
 696     <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
 697       The PCF driver
 698     </a>
 699   </li>
 700
 701
 702
 703
 704
 705
 706
 707   <li class="md-nav__item">
 708     <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
 709       Driver properties
 710     </a>
 711   </li>
 712
 713
 714
 715
 716
 717
 718
 719   <li class="md-nav__item">
 720     <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
 721       Parameter Tags
 722     </a>
 723   </li>
 724
 725
 726
 727
 728
 729
 730
 731   <li class="md-nav__item">
 732     <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
 733       Subpixel Rendering
 734     </a>
 735   </li>
 736
 737
 738       </ul>
 739     </nav>
 740   </li>
 741
 742
 743
 744
 745
 746
 747
 748   <li class="md-nav__item md-nav__item--nested">
 749
 750       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
 751
 752     <label class="md-nav__link" for="nav-7">
 753       Cache Sub-System
 754     </label>
 755     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 756       <label class="md-nav__title" for="nav-7">
 757         Cache Sub-System
 758       </label>
 759       <ul class="md-nav__list" data-md-scrollfix>
 760
 761
 762
 763
 764
 765
 766
 767   <li class="md-nav__item">
 768     <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
 769       Cache Sub-System
 770     </a>
 771   </li>
 772
 773
 774       </ul>
 775     </nav>
 776   </li>
 777
 778
 779
 780
 781
 782
 783
 784   <li class="md-nav__item md-nav__item--nested">
 785
 786       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
 787
 788     <label class="md-nav__link" for="nav-8">
 789       Support API
 790     </label>
 791     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 792       <label class="md-nav__title" for="nav-8">
 793         Support API
 794       </label>
 795       <ul class="md-nav__list" data-md-scrollfix>
 796
 797
 798
 799
 800
 801
 802
 803   <li class="md-nav__item">
 804     <a href="ft2-computations.html" title="Computations" class="md-nav__link">
 805       Computations
 806     </a>
 807   </li>
 808
 809
 810
 811
 812
 813
 814
 815   <li class="md-nav__item">
 816     <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
 817       List Processing
 818     </a>
 819   </li>
 820
 821
 822
 823
 824
 825
 826
 827   <li class="md-nav__item">
 828     <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
 829       Outline Processing
 830     </a>
 831   </li>
 832
 833
 834
 835
 836
 837
 838
 839   <li class="md-nav__item">
 840     <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
 841       Quick retrieval of advance values
 842     </a>
 843   </li>
 844
 845
 846
 847
 848
 849
 850
 851   <li class="md-nav__item">
 852     <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
 853       Bitmap Handling
 854     </a>
 855   </li>
 856
 857
 858
 859
 860
 861
 862
 863   <li class="md-nav__item">
 864     <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
 865       Scanline Converter
 866     </a>
 867   </li>
 868
 869
 870
 871
 872
 873
 874
 875   <li class="md-nav__item">
 876     <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
 877       Glyph Stroker
 878     </a>
 879   </li>
 880
 881
 882
 883
 884
 885
 886
 887   <li class="md-nav__item">
 888     <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
 889       System Interface
 890     </a>
 891   </li>
 892
 893
 894
 895
 896
 897
 898
 899   <li class="md-nav__item">
 900     <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
 901       Module Management
 902     </a>
 903   </li>
 904
 905
 906
 907
 908
 909
 910
 911   <li class="md-nav__item">
 912     <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
 913       GZIP Streams
 914     </a>
 915   </li>
 916
 917
 918
 919
 920
 921
 922
 923   <li class="md-nav__item">
 924     <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
 925       LZW Streams
 926     </a>
 927   </li>
 928
 929
 930
 931
 932
 933
 934
 935   <li class="md-nav__item">
 936     <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
 937       BZIP2 Streams
 938     </a>
 939   </li>
 940
 941
 942       </ul>
 943     </nav>
 944   </li>
 945
 946
 947
 948
 949
 950
 951
 952   <li class="md-nav__item md-nav__item--nested">
 953
 954       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
 955
 956     <label class="md-nav__link" for="nav-9">
 957       Error Codes
 958     </label>
 959     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 960       <label class="md-nav__title" for="nav-9">
 961         Error Codes
 962       </label>
 963       <ul class="md-nav__list" data-md-scrollfix>
 964
 965
 966
 967
 968
 969
 970
 971   <li class="md-nav__item">
 972     <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
 973       Error Enumerations
 974     </a>
 975   </li>
 976
 977
 978
 979
 980
 981
 982
 983   <li class="md-nav__item">
 984     <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
 985       Error Code Values
 986     </a>
 987   </li>
 988
 989
 990       </ul>
 991     </nav>
 992   </li>
 993
 994
 995
 996
 997
 998
 999
1000   <li class="md-nav__item md-nav__item--nested">
1001
1002       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
1003
1004     <label class="md-nav__link" for="nav-10">
1005       Miscellaneous
1006     </label>
1007     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1008       <label class="md-nav__title" for="nav-10">
1009         Miscellaneous
1010       </label>
1011       <ul class="md-nav__list" data-md-scrollfix>
1012
1013
1014
1015
1016
1017
1018
1019   <li class="md-nav__item">
1020     <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1021       TrueTypeGX/AAT Validation
1022     </a>
1023   </li>
1024
1025
1026
1027
1028
1029
1030
1031   <li class="md-nav__item">
1032     <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1033       Incremental Loading
1034     </a>
1035   </li>
1036
1037
1038
1039
1040
1041
1042
1043   <li class="md-nav__item">
1044     <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1045       The TrueType Engine
1046     </a>
1047   </li>
1048
1049
1050
1051
1052
1053
1054
1055   <li class="md-nav__item">
1056     <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1057       OpenType Validation
1058     </a>
1059   </li>
1060
1061
1062       </ul>
1063     </nav>
1064   </li>
1065
1066
1067   </ul>
1068 </nav>
1069                   </div>
1070                 </div>
1071               </div>
1072
1073
1074               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1075                 <div class="md-sidebar__scrollwrap">
1076                   <div class="md-sidebar__inner">
1077
1078 <nav class="md-nav md-nav--secondary">
1079
1080
1081
1082
1083
1084     <label class="md-nav__title" for="__toc">Table of contents</label>
1085     <ul class="md-nav__list" data-md-scrollfix>
1086
1087         <li class="md-nav__item">
1088   <a href="#synopsis" class="md-nav__link">
1089     Synopsis
1090   </a>
1091
1092 </li>
1093
1094         <li class="md-nav__item">
1095   <a href="#ft_color" class="md-nav__link">
1096     FT_Color
1097   </a>
1098
1099 </li>
1100
1101         <li class="md-nav__item">
1102   <a href="#ft_palette_xxx" class="md-nav__link">
1103     FT_PALETTE_XXX
1104   </a>
1105
1106 </li>
1107
1108         <li class="md-nav__item">
1109   <a href="#ft_palette_data" class="md-nav__link">
1110     FT_Palette_Data
1111   </a>
1112
1113 </li>
1114
1115         <li class="md-nav__item">
1116   <a href="#ft_palette_data_get" class="md-nav__link">
1117     FT_Palette_Data_Get
1118   </a>
1119
1120 </li>
1121
1122         <li class="md-nav__item">
1123   <a href="#ft_palette_select" class="md-nav__link">
1124     FT_Palette_Select
1125   </a>
1126
1127 </li>
1128
1129         <li class="md-nav__item">
1130   <a href="#ft_palette_set_foreground_color" class="md-nav__link">
1131     FT_Palette_Set_Foreground_Color
1132   </a>
1133
1134 </li>
1135
1136
1137
1138
1139
1140     </ul>
1141
1142 </nav>
1143                   </div>
1144                 </div>
1145               </div>
1146
1147
1148           <div class="md-content">
1149             <article class="md-content__inner md-typeset">
1150
1151
1152
1153                 <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>
1154 <hr />
1155 <h1 id="glyph-color-management">Glyph Color Management<a class="headerlink" href="#glyph-color-management" title="Permanent link">&para;</a></h1>
1156 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1157 <p>The functions described here allow access and manipulation of color palette entries in OpenType's &lsquo;CPAL&rsquo; tables.</p>
1158 <h2 id="ft_color">FT_Color<a class="headerlink" href="#ft_color" title="Permanent link">&para;</a></h2>
1159 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1160 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Color_
1161   {
1162     <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  blue;
1163     <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  green;
1164     <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  red;
1165     <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>  alpha;
1166
1167   } <b>FT_Color</b>;
1168 </code></pre></div>
1169
1170 <p>This structure models a BGRA color value of a &lsquo;CPAL&rsquo; palette entry.</p>
1171 <p>The used color space is sRGB; the colors are not pre-multiplied, and alpha values must be explicitly set.</p>
1172 <h4>fields</h4>
1173
1174 <table class="fields">
1175 <tr><td class="val" id="blue">blue</td><td class="desc">
1176 <p>Blue value.</p>
1177 </td></tr>
1178 <tr><td class="val" id="green">green</td><td class="desc">
1179 <p>Green value.</p>
1180 </td></tr>
1181 <tr><td class="val" id="red">red</td><td class="desc">
1182 <p>Red value.</p>
1183 </td></tr>
1184 <tr><td class="val" id="alpha">alpha</td><td class="desc">
1185 <p>Alpha value, giving the red, green, and blue color's opacity.</p>
1186 </td></tr>
1187 </table>
1188
1189 <h4>since</h4>
1190
1191 <p>2.10</p>
1192 <hr>
1193
1194 <h2 id="ft_palette_xxx">FT_PALETTE_XXX<a class="headerlink" href="#ft_palette_xxx" title="Permanent link">&para;</a></h2>
1195 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1196 <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
1197 #<span class="keyword">define</span> <a href="ft2-color_management.html#ft_palette_for_dark_background">FT_PALETTE_FOR_DARK_BACKGROUND</a>   0x02
1198 </code></pre></div>
1199
1200 <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>
1201 <h4>values</h4>
1202
1203 <table class="fields long">
1204 <tr><td class="val" id="ft_palette_for_light_background">FT_PALETTE_FOR_LIGHT_BACKGROUND</td><td class="desc">
1205 <p>The palette is appropriate to use when displaying the font on a light background such as white.</p>
1206 </td></tr>
1207 <tr><td class="val" id="ft_palette_for_dark_background">FT_PALETTE_FOR_DARK_BACKGROUND</td><td class="desc">
1208 <p>The palette is appropriate to use when displaying the font on a dark background such as black.</p>
1209 </td></tr>
1210 </table>
1211
1212 <h4>since</h4>
1213
1214 <p>2.10</p>
1215 <hr>
1216
1217 <h2 id="ft_palette_data">FT_Palette_Data<a class="headerlink" href="#ft_palette_data" title="Permanent link">&para;</a></h2>
1218 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1219 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Palette_Data_ {
1220     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>         num_palettes;
1221     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_name_ids;
1222     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_flags;
1223
1224     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>         num_palette_entries;
1225     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  palette_entry_name_ids;
1226
1227   } <b>FT_Palette_Data</b>;
1228 </code></pre></div>
1229
1230 <p>This structure holds the data of the &lsquo;CPAL&rsquo; table.</p>
1231 <h4>fields</h4>
1232
1233 <table class="fields">
1234 <tr><td class="val" id="num_palettes">num_palettes</td><td class="desc">
1235 <p>The number of palettes.</p>
1236 </td></tr>
1237 <tr><td class="val" id="palette_name_ids">palette_name_ids</td><td class="desc">
1238 <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>
1239 <p>An empty name ID in the &lsquo;CPAL&rsquo; table gets represented as value 0xFFFF.</p>
1240 <p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p>
1241 </td></tr>
1242 <tr><td class="val" id="palette_flags">palette_flags</td><td class="desc">
1243 <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>
1244 <p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p>
1245 </td></tr>
1246 <tr><td class="val" id="num_palette_entries">num_palette_entries</td><td class="desc">
1247 <p>The number of entries in a single palette. All palettes have the same size.</p>
1248 </td></tr>
1249 <tr><td class="val" id="palette_entry_name_ids">palette_entry_name_ids</td><td class="desc">
1250 <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>
1251 <p>An empty entry name ID in the &lsquo;CPAL&rsquo; table gets represented as value 0xFFFF.</p>
1252 <p><code>NULL</code> if the font's &lsquo;CPAL&rsquo; table doesn't contain appropriate data.</p>
1253 </td></tr>
1254 </table>
1255
1256 <h4>note</h4>
1257
1258 <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>
1259 <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>
1260 <h4>since</h4>
1261
1262 <p>2.10</p>
1263 <hr>
1264
1265 <h2 id="ft_palette_data_get">FT_Palette_Data_Get<a class="headerlink" href="#ft_palette_data_get" title="Permanent link">&para;</a></h2>
1266 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1267 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1268   <b>FT_Palette_Data_Get</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face,
1269                        <a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a>  *apalette );
1270 </code></pre></div>
1271
1272 <p>Retrieve the face's color palette data.</p>
1273 <h4>input</h4>
1274
1275 <table class="fields">
1276 <tr><td class="val" id="face">face</td><td class="desc">
1277 <p>The source face handle.</p>
1278 </td></tr>
1279 </table>
1280
1281 <h4>output</h4>
1282
1283 <table class="fields">
1284 <tr><td class="val" id="apalette">apalette</td><td class="desc">
1285 <p>A pointer to an <code><a href="ft2-color_management.html#ft_palette_data">FT_Palette_Data</a></code> structure.</p>
1286 </td></tr>
1287 </table>
1288
1289 <h4>return</h4>
1290
1291 <p>FreeType error code. 0&nbsp;means success.</p>
1292 <h4>note</h4>
1293
1294 <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>
1295 <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>
1296 <h4>since</h4>
1297
1298 <p>2.10</p>
1299 <hr>
1300
1301 <h2 id="ft_palette_select">FT_Palette_Select<a class="headerlink" href="#ft_palette_select" title="Permanent link">&para;</a></h2>
1302 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1303 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1304   <b>FT_Palette_Select</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
1305                      <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>   palette_index,
1306                      <a href="ft2-color_management.html#ft_color">FT_Color</a>*  *apalette );
1307 </code></pre></div>
1308
1309 <p>This function has two purposes.</p>
1310 <p>(1) It activates a palette for rendering color glyphs, and</p>
1311 <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>
1312 <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>
1313 <h4>input</h4>
1314
1315 <table class="fields">
1316 <tr><td class="val" id="face">face</td><td class="desc">
1317 <p>The source face handle.</p>
1318 </td></tr>
1319 <tr><td class="val" id="palette_index">palette_index</td><td class="desc">
1320 <p>The palette index.</p>
1321 </td></tr>
1322 </table>
1323
1324 <h4>output</h4>
1325
1326 <table class="fields">
1327 <tr><td class="val" id="apalette">apalette</td><td class="desc">
1328 <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>
1329 <p>In case the font doesn't support color palettes, <code>NULL</code> is returned.</p>
1330 </td></tr>
1331 </table>
1332
1333 <h4>return</h4>
1334
1335 <p>FreeType error code. 0&nbsp;means success.</p>
1336 <h4>note</h4>
1337
1338 <p>The array pointed to by <code>apalette_entries</code> is owned and managed by FreeType.</p>
1339 <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>
1340 <h4>since</h4>
1341
1342 <p>2.10</p>
1343 <hr>
1344
1345 <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>
1346 <p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
1347 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1348   <b>FT_Palette_Set_Foreground_Color</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
1349                                    <a href="ft2-color_management.html#ft_color">FT_Color</a>  foreground_color );
1350 </code></pre></div>
1351
1352 <p>&lsquo;COLR&rsquo; uses palette index 0xFFFF to indicate a &lsquo;text foreground color&rsquo;. This function sets this value.</p>
1353 <h4>input</h4>
1354
1355 <table class="fields">
1356 <tr><td class="val" id="face">face</td><td class="desc">
1357 <p>The source face handle.</p>
1358 </td></tr>
1359 <tr><td class="val" id="foreground_color">foreground_color</td><td class="desc">
1360 <p>An <code>FT_Color</code> structure to define the text foreground color.</p>
1361 </td></tr>
1362 </table>
1363
1364 <h4>return</h4>
1365
1366 <p>FreeType error code. 0&nbsp;means success.</p>
1367 <h4>note</h4>
1368
1369 <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>
1370 <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>
1371 <h4>since</h4>
1372
1373 <p>2.10</p>
1374 <hr>
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385             </article>
1386           </div>
1387         </div>
1388       </main>
1389
1390
1391 <footer class="md-footer">
1392
1393     <div class="md-footer-nav">
1394       <nav class="md-footer-nav__inner md-grid">
1395
1396           <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1397             <div class="md-flex__cell md-flex__cell--shrink">
1398               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1399             </div>
1400             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1401               <span class="md-flex__ellipsis">
1402                 <span class="md-footer-nav__direction">
1403                   Previous
1404                 </span>
1405                 Unicode Variation Sequences
1406               </span>
1407             </div>
1408           </a>
1409
1410
1411           <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1412             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1413               <span class="md-flex__ellipsis">
1414                 <span class="md-footer-nav__direction">
1415                   Next
1416                 </span>
1417                 Glyph Layer Management
1418               </span>
1419             </div>
1420             <div class="md-flex__cell md-flex__cell--shrink">
1421               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1422             </div>
1423           </a>
1424
1425       </nav>
1426     </div>
1427
1428   <div class="md-footer-meta md-typeset">
1429     <div class="md-footer-meta__inner md-grid">
1430       <div class="md-footer-copyright">
1431
1432           <div class="md-footer-copyright__highlight">
1433             Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1434           </div>
1435
1436         powered by
1437         <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1438         and
1439         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1440           Material for MkDocs</a>
1441       </div>
1442
1443     </div>
1444   </div>
1445 </footer>
1446
1447     </div>
1448
1449       <script src="assets/javascripts/application.c33a9706.js"></script>
1450
1451       <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1452
1453         <script src="javascripts/extra.js"></script>
1454
1455
1456   </body>
1457 </html>