1 2<!doctype html> 3<html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 <meta name="description" content="API Reference Documentation for FreeType-2.12.1"> 10 11 12 13 <meta name="author" content="FreeType Contributors"> 14 15 16 <link rel="icon" href="images/favico.ico"> 17 <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9"> 18 19 20 21 <title>FreeType-2.12.1 API Reference</title> 22 23 24 25 <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css"> 26 27 28 <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css"> 29 30 31 32 <meta name="theme-color" content="#4cae4f"> 33 34 35 36 37 38 39 40 <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> 41 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback"> 42 <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style> 43 44 45 46 47 <link rel="stylesheet" href="stylesheets/extra.css"> 48 49 50 51 52 53 54 55 </head> 56 57 58 59 60 61 62 63 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green"> 64 65 66 <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> 67 68 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> 69 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> 70 <label class="md-overlay" for="__drawer"></label> 71 <div data-md-component="skip"> 72 73 74 <a href="#freetype-2121-api-reference" class="md-skip"> 75 Skip to content 76 </a> 77 78 </div> 79 <div data-md-component="announce"> 80 81 </div> 82 83 <header class="md-header" data-md-component="header"> 84 <nav class="md-header__inner md-grid" aria-label="Header"> 85 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 86 87 <img src="images/favico.ico" alt="logo"> 88 89 </a> 90 <label class="md-header__button md-icon" for="__drawer"> 91 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> 92 </label> 93 <div class="md-header__title" data-md-component="header-title"> 94 <div class="md-header__ellipsis"> 95 <div class="md-header__topic"> 96 <span class="md-ellipsis"> 97 FreeType-2.12.1 API Reference 98 </span> 99 </div> 100 <div class="md-header__topic" data-md-component="header-topic"> 101 <span class="md-ellipsis"> 102 103 TOC 104 105 </span> 106 </div> 107 </div> 108 </div> 109 110 111 112 <label class="md-header__button md-icon" for="__search"> 113 <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> 114 </label> 115 116<div class="md-search" data-md-component="search" role="dialog"> 117 <label class="md-search__overlay" for="__search"></label> 118 <div class="md-search__inner" role="search"> 119 <form class="md-search__form" name="search"> 120 <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> 121 <label class="md-search__icon md-icon" for="__search"> 122 <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> 123 <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> 124 </label> 125 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> 126 <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> 127 </button> 128 </form> 129 <div class="md-search__output"> 130 <div class="md-search__scrollwrap" data-md-scrollfix> 131 <div class="md-search-result" data-md-component="search-result"> 132 <div class="md-search-result__meta"> 133 Initializing search 134 </div> 135 <ol class="md-search-result__list"></ol> 136 </div> 137 </div> 138 </div> 139 </div> 140</div> 141 142 143 </nav> 144</header> 145 146 <div class="md-container" data-md-component="container"> 147 148 149 150 151 <main class="md-main" data-md-component="main"> 152 <div class="md-main__inner md-grid"> 153 154 155 156 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > 157 <div class="md-sidebar__scrollwrap"> 158 <div class="md-sidebar__inner"> 159 160 161 162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> 163 <label class="md-nav__title" for="__drawer"> 164 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 165 166 <img src="images/favico.ico" alt="logo"> 167 168 </a> 169 FreeType-2.12.1 API Reference 170 </label> 171 172 <ul class="md-nav__list" data-md-scrollfix> 173 174 175 176 177 178 179 180 181 182 183 <li class="md-nav__item md-nav__item--active"> 184 185 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> 186 187 188 189 190 191 <a href="index.html" class="md-nav__link md-nav__link--active"> 192 TOC 193 </a> 194 195 </li> 196 197 198 199 200 201 202 203 204 205 206 <li class="md-nav__item"> 207 <a href="ft2-index.html" class="md-nav__link"> 208 Index 209 </a> 210 </li> 211 212 213 214 215 216 217 218 219 220 221 222 <li class="md-nav__item md-nav__item--nested"> 223 224 225 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > 226 227 <label class="md-nav__link" for="__nav_3"> 228 General Remarks 229 <span class="md-nav__icon md-icon"></span> 230 </label> 231 <nav class="md-nav" aria-label="General Remarks" data-md-level="1"> 232 <label class="md-nav__title" for="__nav_3"> 233 <span class="md-nav__icon md-icon"></span> 234 General Remarks 235 </label> 236 <ul class="md-nav__list" data-md-scrollfix> 237 238 239 240 241 242 <li class="md-nav__item"> 243 <a href="ft2-preamble.html" class="md-nav__link"> 244 Preamble 245 </a> 246 </li> 247 248 249 250 251 252 253 254 <li class="md-nav__item"> 255 <a href="ft2-header_inclusion.html" class="md-nav__link"> 256 FreeType's header inclusion scheme 257 </a> 258 </li> 259 260 261 262 263 264 265 266 <li class="md-nav__item"> 267 <a href="ft2-user_allocation.html" class="md-nav__link"> 268 User allocation 269 </a> 270 </li> 271 272 273 274 </ul> 275 </nav> 276 </li> 277 278 279 280 281 282 283 284 285 286 287 288 <li class="md-nav__item md-nav__item--nested"> 289 290 291 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > 292 293 <label class="md-nav__link" for="__nav_4"> 294 Core API 295 <span class="md-nav__icon md-icon"></span> 296 </label> 297 <nav class="md-nav" aria-label="Core API" data-md-level="1"> 298 <label class="md-nav__title" for="__nav_4"> 299 <span class="md-nav__icon md-icon"></span> 300 Core API 301 </label> 302 <ul class="md-nav__list" data-md-scrollfix> 303 304 305 306 307 308 <li class="md-nav__item"> 309 <a href="ft2-version.html" class="md-nav__link"> 310 FreeType Version 311 </a> 312 </li> 313 314 315 316 317 318 319 320 <li class="md-nav__item"> 321 <a href="ft2-basic_types.html" class="md-nav__link"> 322 Basic Data Types 323 </a> 324 </li> 325 326 327 328 329 330 331 332 <li class="md-nav__item"> 333 <a href="ft2-base_interface.html" class="md-nav__link"> 334 Base Interface 335 </a> 336 </li> 337 338 339 340 341 342 343 344 <li class="md-nav__item"> 345 <a href="ft2-glyph_variants.html" class="md-nav__link"> 346 Unicode Variation Sequences 347 </a> 348 </li> 349 350 351 352 353 354 355 356 <li class="md-nav__item"> 357 <a href="ft2-color_management.html" class="md-nav__link"> 358 Glyph Color Management 359 </a> 360 </li> 361 362 363 364 365 366 367 368 <li class="md-nav__item"> 369 <a href="ft2-layer_management.html" class="md-nav__link"> 370 Glyph Layer Management 371 </a> 372 </li> 373 374 375 376 377 378 379 380 <li class="md-nav__item"> 381 <a href="ft2-glyph_management.html" class="md-nav__link"> 382 Glyph Management 383 </a> 384 </li> 385 386 387 388 389 390 391 392 <li class="md-nav__item"> 393 <a href="ft2-mac_specific.html" class="md-nav__link"> 394 Mac Specific Interface 395 </a> 396 </li> 397 398 399 400 401 402 403 404 <li class="md-nav__item"> 405 <a href="ft2-sizes_management.html" class="md-nav__link"> 406 Size Management 407 </a> 408 </li> 409 410 411 412 413 414 415 416 <li class="md-nav__item"> 417 <a href="ft2-header_file_macros.html" class="md-nav__link"> 418 Header File Macros 419 </a> 420 </li> 421 422 423 424 </ul> 425 </nav> 426 </li> 427 428 429 430 431 432 433 434 435 436 437 438 <li class="md-nav__item md-nav__item--nested"> 439 440 441 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > 442 443 <label class="md-nav__link" for="__nav_5"> 444 Format-Specific API 445 <span class="md-nav__icon md-icon"></span> 446 </label> 447 <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1"> 448 <label class="md-nav__title" for="__nav_5"> 449 <span class="md-nav__icon md-icon"></span> 450 Format-Specific API 451 </label> 452 <ul class="md-nav__list" data-md-scrollfix> 453 454 455 456 457 458 <li class="md-nav__item"> 459 <a href="ft2-multiple_masters.html" class="md-nav__link"> 460 Multiple Masters 461 </a> 462 </li> 463 464 465 466 467 468 469 470 <li class="md-nav__item"> 471 <a href="ft2-truetype_tables.html" class="md-nav__link"> 472 TrueType Tables 473 </a> 474 </li> 475 476 477 478 479 480 481 482 <li class="md-nav__item"> 483 <a href="ft2-type1_tables.html" class="md-nav__link"> 484 Type 1 Tables 485 </a> 486 </li> 487 488 489 490 491 492 493 494 <li class="md-nav__item"> 495 <a href="ft2-sfnt_names.html" class="md-nav__link"> 496 SFNT Names 497 </a> 498 </li> 499 500 501 502 503 504 505 506 <li class="md-nav__item"> 507 <a href="ft2-bdf_fonts.html" class="md-nav__link"> 508 BDF and PCF Files 509 </a> 510 </li> 511 512 513 514 515 516 517 518 <li class="md-nav__item"> 519 <a href="ft2-cid_fonts.html" class="md-nav__link"> 520 CID Fonts 521 </a> 522 </li> 523 524 525 526 527 528 529 530 <li class="md-nav__item"> 531 <a href="ft2-pfr_fonts.html" class="md-nav__link"> 532 PFR Fonts 533 </a> 534 </li> 535 536 537 538 539 540 541 542 <li class="md-nav__item"> 543 <a href="ft2-winfnt_fonts.html" class="md-nav__link"> 544 Window FNT Files 545 </a> 546 </li> 547 548 549 550 551 552 553 554 <li class="md-nav__item"> 555 <a href="ft2-svg_fonts.html" class="md-nav__link"> 556 OpenType SVG Fonts 557 </a> 558 </li> 559 560 561 562 563 564 565 566 <li class="md-nav__item"> 567 <a href="ft2-font_formats.html" class="md-nav__link"> 568 Font Formats 569 </a> 570 </li> 571 572 573 574 575 576 577 578 <li class="md-nav__item"> 579 <a href="ft2-gasp_table.html" class="md-nav__link"> 580 Gasp Table 581 </a> 582 </li> 583 584 585 586 </ul> 587 </nav> 588 </li> 589 590 591 592 593 594 595 596 597 598 599 600 <li class="md-nav__item md-nav__item--nested"> 601 602 603 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > 604 605 <label class="md-nav__link" for="__nav_6"> 606 Controlling FreeType Modules 607 <span class="md-nav__icon md-icon"></span> 608 </label> 609 <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1"> 610 <label class="md-nav__title" for="__nav_6"> 611 <span class="md-nav__icon md-icon"></span> 612 Controlling FreeType Modules 613 </label> 614 <ul class="md-nav__list" data-md-scrollfix> 615 616 617 618 619 620 <li class="md-nav__item"> 621 <a href="ft2-auto_hinter.html" class="md-nav__link"> 622 The auto-hinter 623 </a> 624 </li> 625 626 627 628 629 630 631 632 <li class="md-nav__item"> 633 <a href="ft2-cff_driver.html" class="md-nav__link"> 634 The CFF driver 635 </a> 636 </li> 637 638 639 640 641 642 643 644 <li class="md-nav__item"> 645 <a href="ft2-t1_cid_driver.html" class="md-nav__link"> 646 The Type 1 and CID drivers 647 </a> 648 </li> 649 650 651 652 653 654 655 656 <li class="md-nav__item"> 657 <a href="ft2-tt_driver.html" class="md-nav__link"> 658 The TrueType driver 659 </a> 660 </li> 661 662 663 664 665 666 667 668 <li class="md-nav__item"> 669 <a href="ft2-pcf_driver.html" class="md-nav__link"> 670 The PCF driver 671 </a> 672 </li> 673 674 675 676 677 678 679 680 <li class="md-nav__item"> 681 <a href="ft2-ot_svg_driver.html" class="md-nav__link"> 682 The SVG driver 683 </a> 684 </li> 685 686 687 688 689 690 691 692 <li class="md-nav__item"> 693 <a href="ft2-properties.html" class="md-nav__link"> 694 Driver properties 695 </a> 696 </li> 697 698 699 700 701 702 703 704 <li class="md-nav__item"> 705 <a href="ft2-parameter_tags.html" class="md-nav__link"> 706 Parameter Tags 707 </a> 708 </li> 709 710 711 712 713 714 715 716 <li class="md-nav__item"> 717 <a href="ft2-lcd_rendering.html" class="md-nav__link"> 718 Subpixel Rendering 719 </a> 720 </li> 721 722 723 724 </ul> 725 </nav> 726 </li> 727 728 729 730 731 732 733 734 735 736 737 738 <li class="md-nav__item md-nav__item--nested"> 739 740 741 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > 742 743 <label class="md-nav__link" for="__nav_7"> 744 Cache Sub-System 745 <span class="md-nav__icon md-icon"></span> 746 </label> 747 <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1"> 748 <label class="md-nav__title" for="__nav_7"> 749 <span class="md-nav__icon md-icon"></span> 750 Cache Sub-System 751 </label> 752 <ul class="md-nav__list" data-md-scrollfix> 753 754 755 756 757 758 <li class="md-nav__item"> 759 <a href="ft2-cache_subsystem.html" class="md-nav__link"> 760 Cache Sub-System 761 </a> 762 </li> 763 764 765 766 </ul> 767 </nav> 768 </li> 769 770 771 772 773 774 775 776 777 778 779 780 <li class="md-nav__item md-nav__item--nested"> 781 782 783 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > 784 785 <label class="md-nav__link" for="__nav_8"> 786 Support API 787 <span class="md-nav__icon md-icon"></span> 788 </label> 789 <nav class="md-nav" aria-label="Support API" data-md-level="1"> 790 <label class="md-nav__title" for="__nav_8"> 791 <span class="md-nav__icon md-icon"></span> 792 Support API 793 </label> 794 <ul class="md-nav__list" data-md-scrollfix> 795 796 797 798 799 800 <li class="md-nav__item"> 801 <a href="ft2-computations.html" class="md-nav__link"> 802 Computations 803 </a> 804 </li> 805 806 807 808 809 810 811 812 <li class="md-nav__item"> 813 <a href="ft2-list_processing.html" class="md-nav__link"> 814 List Processing 815 </a> 816 </li> 817 818 819 820 821 822 823 824 <li class="md-nav__item"> 825 <a href="ft2-outline_processing.html" class="md-nav__link"> 826 Outline Processing 827 </a> 828 </li> 829 830 831 832 833 834 835 836 <li class="md-nav__item"> 837 <a href="ft2-quick_advance.html" class="md-nav__link"> 838 Quick retrieval of advance values 839 </a> 840 </li> 841 842 843 844 845 846 847 848 <li class="md-nav__item"> 849 <a href="ft2-bitmap_handling.html" class="md-nav__link"> 850 Bitmap Handling 851 </a> 852 </li> 853 854 855 856 857 858 859 860 <li class="md-nav__item"> 861 <a href="ft2-raster.html" class="md-nav__link"> 862 Scanline Converter 863 </a> 864 </li> 865 866 867 868 869 870 871 872 <li class="md-nav__item"> 873 <a href="ft2-glyph_stroker.html" class="md-nav__link"> 874 Glyph Stroker 875 </a> 876 </li> 877 878 879 880 881 882 883 884 <li class="md-nav__item"> 885 <a href="ft2-system_interface.html" class="md-nav__link"> 886 System Interface 887 </a> 888 </li> 889 890 891 892 893 894 895 896 <li class="md-nav__item"> 897 <a href="ft2-module_management.html" class="md-nav__link"> 898 Module Management 899 </a> 900 </li> 901 902 903 904 905 906 907 908 <li class="md-nav__item"> 909 <a href="ft2-gzip.html" class="md-nav__link"> 910 GZIP Streams 911 </a> 912 </li> 913 914 915 916 917 918 919 920 <li class="md-nav__item"> 921 <a href="ft2-lzw.html" class="md-nav__link"> 922 LZW Streams 923 </a> 924 </li> 925 926 927 928 929 930 931 932 <li class="md-nav__item"> 933 <a href="ft2-bzip2.html" class="md-nav__link"> 934 BZIP2 Streams 935 </a> 936 </li> 937 938 939 940 941 942 943 944 <li class="md-nav__item"> 945 <a href="ft2-debugging_apis.html" class="md-nav__link"> 946 External Debugging APIs 947 </a> 948 </li> 949 950 951 952 </ul> 953 </nav> 954 </li> 955 956 957 958 959 960 961 962 963 964 965 966 <li class="md-nav__item md-nav__item--nested"> 967 968 969 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > 970 971 <label class="md-nav__link" for="__nav_9"> 972 Error Codes 973 <span class="md-nav__icon md-icon"></span> 974 </label> 975 <nav class="md-nav" aria-label="Error Codes" data-md-level="1"> 976 <label class="md-nav__title" for="__nav_9"> 977 <span class="md-nav__icon md-icon"></span> 978 Error Codes 979 </label> 980 <ul class="md-nav__list" data-md-scrollfix> 981 982 983 984 985 986 <li class="md-nav__item"> 987 <a href="ft2-error_enumerations.html" class="md-nav__link"> 988 Error Enumerations 989 </a> 990 </li> 991 992 993 994 995 996 997 998 <li class="md-nav__item"> 999 <a href="ft2-error_code_values.html" class="md-nav__link"> 1000 Error Code Values 1001 </a> 1002 </li> 1003 1004 1005 1006 </ul> 1007 </nav> 1008 </li> 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 <li class="md-nav__item md-nav__item--nested"> 1021 1022 1023 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > 1024 1025 <label class="md-nav__link" for="__nav_10"> 1026 Miscellaneous 1027 <span class="md-nav__icon md-icon"></span> 1028 </label> 1029 <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1"> 1030 <label class="md-nav__title" for="__nav_10"> 1031 <span class="md-nav__icon md-icon"></span> 1032 Miscellaneous 1033 </label> 1034 <ul class="md-nav__list" data-md-scrollfix> 1035 1036 1037 1038 1039 1040 <li class="md-nav__item"> 1041 <a href="ft2-gx_validation.html" class="md-nav__link"> 1042 TrueTypeGX/AAT Validation 1043 </a> 1044 </li> 1045 1046 1047 1048 1049 1050 1051 1052 <li class="md-nav__item"> 1053 <a href="ft2-incremental.html" class="md-nav__link"> 1054 Incremental Loading 1055 </a> 1056 </li> 1057 1058 1059 1060 1061 1062 1063 1064 <li class="md-nav__item"> 1065 <a href="ft2-truetype_engine.html" class="md-nav__link"> 1066 The TrueType Engine 1067 </a> 1068 </li> 1069 1070 1071 1072 1073 1074 1075 1076 <li class="md-nav__item"> 1077 <a href="ft2-ot_validation.html" class="md-nav__link"> 1078 OpenType Validation 1079 </a> 1080 </li> 1081 1082 1083 1084 </ul> 1085 </nav> 1086 </li> 1087 1088 1089 1090 </ul> 1091</nav> 1092 </div> 1093 </div> 1094 </div> 1095 1096 1097 1098 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > 1099 <div class="md-sidebar__scrollwrap"> 1100 <div class="md-sidebar__inner"> 1101 1102<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> 1103 1104 1105 1106 1107 1108 1109</nav> 1110 </div> 1111 </div> 1112 </div> 1113 1114 1115 <div class="md-content" data-md-component="content"> 1116 <article class="md-content__inner md-typeset"> 1117 1118 1119 1120 <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » Table of Contents</p> 1121<hr /> 1122<h1 id="freetype-2121-api-reference">FreeType-2.12.1 API Reference<a class="headerlink" href="#freetype-2121-api-reference" title="Permanent link">¶</a></h1> 1123<h1 id="table-of-contents">Table of Contents<a class="headerlink" href="#table-of-contents" title="Permanent link">¶</a></h1> 1124<h2 id="general-remarks">General Remarks<a class="headerlink" href="#general-remarks" title="Permanent link">¶</a></h2> 1125<table class="toc"> 1126<tr><td class="link"><a href="ft2-preamble.html">Preamble</a></td><td class="desc"> 1127<p>What FreeType is and isn't</p> 1128</td></tr> 1129<tr><td class="link"><a href="ft2-header_inclusion.html">FreeType's header inclusion scheme</a></td><td class="desc"> 1130<p>How client applications should include FreeType header files.</p> 1131</td></tr> 1132<tr><td class="link"><a href="ft2-user_allocation.html">User allocation</a></td><td class="desc"> 1133<p>How client applications should allocate FreeType data structures.</p> 1134</td></tr> 1135</table> 1136<h2 id="core-api">Core API<a class="headerlink" href="#core-api" title="Permanent link">¶</a></h2> 1137<table class="toc"> 1138<tr><td class="link"><a href="ft2-version.html">FreeType Version</a></td><td class="desc"> 1139<p>Functions and macros related to FreeType versions.</p> 1140</td></tr> 1141<tr><td class="link"><a href="ft2-basic_types.html">Basic Data Types</a></td><td class="desc"> 1142<p>The basic data types defined by the library.</p> 1143</td></tr> 1144<tr><td class="link"><a href="ft2-base_interface.html">Base Interface</a></td><td class="desc"> 1145<p>The FreeType 2 base font interface.</p> 1146</td></tr> 1147<tr><td class="link"><a href="ft2-glyph_variants.html">Unicode Variation Sequences</a></td><td class="desc"> 1148<p>The FreeType 2 interface to Unicode Variation Sequences (UVS), using the SFNT cmap format 14.</p> 1149</td></tr> 1150<tr><td class="link"><a href="ft2-color_management.html">Glyph Color Management</a></td><td class="desc"> 1151<p>Retrieving and manipulating OpenType's ‘CPAL’ table data.</p> 1152</td></tr> 1153<tr><td class="link"><a href="ft2-layer_management.html">Glyph Layer Management</a></td><td class="desc"> 1154<p>Retrieving and manipulating OpenType's ‘COLR’ table data.</p> 1155</td></tr> 1156<tr><td class="link"><a href="ft2-glyph_management.html">Glyph Management</a></td><td class="desc"> 1157<p>Generic interface to manage individual glyph data.</p> 1158</td></tr> 1159<tr><td class="link"><a href="ft2-mac_specific.html">Mac Specific Interface</a></td><td class="desc"> 1160<p>Only available on the Macintosh.</p> 1161</td></tr> 1162<tr><td class="link"><a href="ft2-sizes_management.html">Size Management</a></td><td class="desc"> 1163<p>Managing multiple sizes per face.</p> 1164</td></tr> 1165<tr><td class="link"><a href="ft2-header_file_macros.html">Header File Macros</a></td><td class="desc"> 1166<p>Macro definitions used to <code>#include</code> specific header files.</p> 1167</td></tr> 1168</table> 1169<h2 id="format-specific-api">Format-Specific API<a class="headerlink" href="#format-specific-api" title="Permanent link">¶</a></h2> 1170<table class="toc"> 1171<tr><td class="link"><a href="ft2-multiple_masters.html">Multiple Masters</a></td><td class="desc"> 1172<p>How to manage Multiple Masters fonts.</p> 1173</td></tr> 1174<tr><td class="link"><a href="ft2-truetype_tables.html">TrueType Tables</a></td><td class="desc"> 1175<p>TrueType-specific table types and functions.</p> 1176</td></tr> 1177<tr><td class="link"><a href="ft2-type1_tables.html">Type 1 Tables</a></td><td class="desc"> 1178<p>Type 1-specific font tables.</p> 1179</td></tr> 1180<tr><td class="link"><a href="ft2-sfnt_names.html">SFNT Names</a></td><td class="desc"> 1181<p>Access the names embedded in TrueType and OpenType files.</p> 1182</td></tr> 1183<tr><td class="link"><a href="ft2-bdf_fonts.html">BDF and PCF Files</a></td><td class="desc"> 1184<p>BDF and PCF specific API.</p> 1185</td></tr> 1186<tr><td class="link"><a href="ft2-cid_fonts.html">CID Fonts</a></td><td class="desc"> 1187<p>CID-keyed font-specific API.</p> 1188</td></tr> 1189<tr><td class="link"><a href="ft2-pfr_fonts.html">PFR Fonts</a></td><td class="desc"> 1190<p>PFR/TrueDoc-specific API.</p> 1191</td></tr> 1192<tr><td class="link"><a href="ft2-winfnt_fonts.html">Window FNT Files</a></td><td class="desc"> 1193<p>Windows FNT-specific API.</p> 1194</td></tr> 1195<tr><td class="link"><a href="ft2-svg_fonts.html">OpenType SVG Fonts</a></td><td class="desc"> 1196<p>OT-SVG API between FreeType and an external SVG rendering library.</p> 1197</td></tr> 1198<tr><td class="link"><a href="ft2-font_formats.html">Font Formats</a></td><td class="desc"> 1199<p>Getting the font format.</p> 1200</td></tr> 1201<tr><td class="link"><a href="ft2-gasp_table.html">Gasp Table</a></td><td class="desc"> 1202<p>Retrieving TrueType ‘gasp’ table entries.</p> 1203</td></tr> 1204</table> 1205<h2 id="controlling-freetype-modules">Controlling FreeType Modules<a class="headerlink" href="#controlling-freetype-modules" title="Permanent link">¶</a></h2> 1206<table class="toc"> 1207<tr><td class="link"><a href="ft2-auto_hinter.html">The auto-hinter</a></td><td class="desc"> 1208<p>Controlling the auto-hinting module.</p> 1209</td></tr> 1210<tr><td class="link"><a href="ft2-cff_driver.html">The CFF driver</a></td><td class="desc"> 1211<p>Controlling the CFF driver module.</p> 1212</td></tr> 1213<tr><td class="link"><a href="ft2-t1_cid_driver.html">The Type 1 and CID drivers</a></td><td class="desc"> 1214<p>Controlling the Type 1 and CID driver modules.</p> 1215</td></tr> 1216<tr><td class="link"><a href="ft2-tt_driver.html">The TrueType driver</a></td><td class="desc"> 1217<p>Controlling the TrueType driver module.</p> 1218</td></tr> 1219<tr><td class="link"><a href="ft2-pcf_driver.html">The PCF driver</a></td><td class="desc"> 1220<p>Controlling the PCF driver module.</p> 1221</td></tr> 1222<tr><td class="link"><a href="ft2-ot_svg_driver.html">The SVG driver</a></td><td class="desc"> 1223<p>Controlling the external rendering of OT-SVG glyphs.</p> 1224</td></tr> 1225<tr><td class="link"><a href="ft2-properties.html">Driver properties</a></td><td class="desc"> 1226<p>Controlling driver modules.</p> 1227</td></tr> 1228<tr><td class="link"><a href="ft2-parameter_tags.html">Parameter Tags</a></td><td class="desc"> 1229<p>Macros for driver property and font loading parameter tags.</p> 1230</td></tr> 1231<tr><td class="link"><a href="ft2-lcd_rendering.html">Subpixel Rendering</a></td><td class="desc"> 1232<p>API to control subpixel rendering.</p> 1233</td></tr> 1234</table> 1235<h2 id="cache-sub-system">Cache Sub-System<a class="headerlink" href="#cache-sub-system" title="Permanent link">¶</a></h2> 1236<table class="toc"> 1237<tr><td class="link"><a href="ft2-cache_subsystem.html">Cache Sub-System</a></td><td class="desc"> 1238<p>How to cache face, size, and glyph data with FreeType 2.</p> 1239</td></tr> 1240</table> 1241<h2 id="support-api">Support API<a class="headerlink" href="#support-api" title="Permanent link">¶</a></h2> 1242<table class="toc"> 1243<tr><td class="link"><a href="ft2-computations.html">Computations</a></td><td class="desc"> 1244<p>Crunching fixed numbers and vectors.</p> 1245</td></tr> 1246<tr><td class="link"><a href="ft2-list_processing.html">List Processing</a></td><td class="desc"> 1247<p>Simple management of lists.</p> 1248</td></tr> 1249<tr><td class="link"><a href="ft2-outline_processing.html">Outline Processing</a></td><td class="desc"> 1250<p>Functions to create, transform, and render vectorial glyph images.</p> 1251</td></tr> 1252<tr><td class="link"><a href="ft2-quick_advance.html">Quick retrieval of advance values</a></td><td class="desc"> 1253<p>Retrieve horizontal and vertical advance values without processing glyph outlines, if possible.</p> 1254</td></tr> 1255<tr><td class="link"><a href="ft2-bitmap_handling.html">Bitmap Handling</a></td><td class="desc"> 1256<p>Handling FT_Bitmap objects.</p> 1257</td></tr> 1258<tr><td class="link"><a href="ft2-raster.html">Scanline Converter</a></td><td class="desc"> 1259<p>How vectorial outlines are converted into bitmaps and pixmaps.</p> 1260</td></tr> 1261<tr><td class="link"><a href="ft2-glyph_stroker.html">Glyph Stroker</a></td><td class="desc"> 1262<p>Generating bordered and stroked glyphs.</p> 1263</td></tr> 1264<tr><td class="link"><a href="ft2-system_interface.html">System Interface</a></td><td class="desc"> 1265<p>How FreeType manages memory and i/o.</p> 1266</td></tr> 1267<tr><td class="link"><a href="ft2-module_management.html">Module Management</a></td><td class="desc"> 1268<p>How to add, upgrade, remove, and control modules from FreeType.</p> 1269</td></tr> 1270<tr><td class="link"><a href="ft2-gzip.html">GZIP Streams</a></td><td class="desc"> 1271<p>Using gzip-compressed font files.</p> 1272</td></tr> 1273<tr><td class="link"><a href="ft2-lzw.html">LZW Streams</a></td><td class="desc"> 1274<p>Using LZW-compressed font files.</p> 1275</td></tr> 1276<tr><td class="link"><a href="ft2-bzip2.html">BZIP2 Streams</a></td><td class="desc"> 1277<p>Using bzip2-compressed font files.</p> 1278</td></tr> 1279<tr><td class="link"><a href="ft2-debugging_apis.html">External Debugging APIs</a></td><td class="desc"> 1280<p>Public APIs to control the <code>FT_DEBUG_LOGGING</code> macro.</p> 1281</td></tr> 1282</table> 1283<h2 id="error-codes">Error Codes<a class="headerlink" href="#error-codes" title="Permanent link">¶</a></h2> 1284<table class="toc"> 1285<tr><td class="link"><a href="ft2-error_enumerations.html">Error Enumerations</a></td><td class="desc"> 1286<p>How to handle errors and error strings.</p> 1287</td></tr> 1288<tr><td class="link"><a href="ft2-error_code_values.html">Error Code Values</a></td><td class="desc"> 1289<p>All possible error codes returned by FreeType functions.</p> 1290</td></tr> 1291</table> 1292<h2 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">¶</a></h2> 1293<table class="toc"> 1294<tr><td class="link"><a href="ft2-gx_validation.html">TrueTypeGX/AAT Validation</a></td><td class="desc"> 1295<p>An API to validate TrueTypeGX/AAT tables.</p> 1296</td></tr> 1297<tr><td class="link"><a href="ft2-incremental.html">Incremental Loading</a></td><td class="desc"> 1298<p>Custom Glyph Loading.</p> 1299</td></tr> 1300<tr><td class="link"><a href="ft2-truetype_engine.html">The TrueType Engine</a></td><td class="desc"> 1301<p>TrueType bytecode support.</p> 1302</td></tr> 1303<tr><td class="link"><a href="ft2-ot_validation.html">OpenType Validation</a></td><td class="desc"> 1304<p>An API to validate OpenType tables.</p> 1305</td></tr> 1306</table> 1307<h2 id="global-index"><a href="ft2-index.html">Global Index</a><a class="headerlink" href="#global-index" title="Permanent link">¶</a></h2> 1308<hr /> 1309<div class="timestamp">generated on Sun May 1 05:24:59 2022 UTC</div> 1310 1311 1312 1313 1314 1315 1316 1317 </article> 1318 </div> 1319 </div> 1320 1321 </main> 1322 1323 1324<footer class="md-footer"> 1325 1326 <nav class="md-footer__inner md-grid" aria-label="Footer"> 1327 1328 1329 1330 <a href="ft2-index.html" class="md-footer__link md-footer__link--next" aria-label="Next: Index" rel="next"> 1331 <div class="md-footer__title"> 1332 <div class="md-ellipsis"> 1333 <span class="md-footer__direction"> 1334 Next 1335 </span> 1336 Index 1337 </div> 1338 </div> 1339 <div class="md-footer__button md-icon"> 1340 <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> 1341 </div> 1342 </a> 1343 1344 </nav> 1345 1346 <div class="md-footer-meta md-typeset"> 1347 <div class="md-footer-meta__inner md-grid"> 1348 <div class="md-footer-copyright"> 1349 1350 <div class="md-footer-copyright__highlight"> 1351 Copyright 2022 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>. 1352 </div> 1353 1354 Made with 1355 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> 1356 Material for MkDocs 1357 </a> 1358 1359 </div> 1360 1361 </div> 1362 </div> 1363</footer> 1364 1365 </div> 1366 <div class="md-dialog" data-md-component="dialog"> 1367 <div class="md-dialog__inner md-typeset"></div> 1368 </div> 1369 <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> 1370 1371 1372 <script src="assets/javascripts/bundle.82b56eb2.min.js"></script> 1373 1374 <script src="javascripts/extra.js"></script> 1375 1376 1377 </body> 1378</html>