docs/reference/ft2-information_retrieval.html

   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.13.2">
  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.4.3, mkdocs-material-7.1.9">
  18
  19
  20
  21         <title>Information Retrieval - FreeType-2.13.2 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="#information-retrieval" 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.13.2 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.13.2 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.13.2 API Reference
  98           </span>
  99         </div>
 100         <div class="md-header__topic" data-md-component="header-topic">
 101           <span class="md-ellipsis">
 102
 103               Information Retrieval
 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.13.2 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.13.2 API Reference" data-md-component="logo">
 165
 166   <img src="images/favico.ico" alt="logo">
 167
 168     </a>
 169     FreeType-2.13.2 API Reference
 170   </label>
 171
 172   <ul class="md-nav__list" data-md-scrollfix>
 173
 174
 175
 176
 177
 178
 179
 180
 181     <li class="md-nav__item">
 182       <a href="index.html" class="md-nav__link">
 183         TOC
 184       </a>
 185     </li>
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196     <li class="md-nav__item">
 197       <a href="ft2-index.html" class="md-nav__link">
 198         Index
 199       </a>
 200     </li>
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212     <li class="md-nav__item md-nav__item--nested">
 213
 214
 215         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 216
 217       <label class="md-nav__link" for="__nav_3">
 218         General Remarks
 219         <span class="md-nav__icon md-icon"></span>
 220       </label>
 221       <nav class="md-nav" aria-label="General Remarks" data-md-level="1">
 222         <label class="md-nav__title" for="__nav_3">
 223           <span class="md-nav__icon md-icon"></span>
 224           General Remarks
 225         </label>
 226         <ul class="md-nav__list" data-md-scrollfix>
 227
 228
 229
 230
 231
 232     <li class="md-nav__item">
 233       <a href="ft2-preamble.html" class="md-nav__link">
 234         Preamble
 235       </a>
 236     </li>
 237
 238
 239
 240
 241
 242
 243
 244     <li class="md-nav__item">
 245       <a href="ft2-header_inclusion.html" class="md-nav__link">
 246         FreeType's header inclusion scheme
 247       </a>
 248     </li>
 249
 250
 251
 252
 253
 254
 255
 256     <li class="md-nav__item">
 257       <a href="ft2-user_allocation.html" class="md-nav__link">
 258         User allocation
 259       </a>
 260     </li>
 261
 262
 263
 264         </ul>
 265       </nav>
 266     </li>
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 281
 282
 283         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
 284
 285       <label class="md-nav__link" for="__nav_4">
 286         Core API
 287         <span class="md-nav__icon md-icon"></span>
 288       </label>
 289       <nav class="md-nav" aria-label="Core API" data-md-level="1">
 290         <label class="md-nav__title" for="__nav_4">
 291           <span class="md-nav__icon md-icon"></span>
 292           Core API
 293         </label>
 294         <ul class="md-nav__list" data-md-scrollfix>
 295
 296
 297
 298
 299
 300     <li class="md-nav__item">
 301       <a href="ft2-basic_types.html" class="md-nav__link">
 302         Basic Data Types
 303       </a>
 304     </li>
 305
 306
 307
 308
 309
 310
 311
 312     <li class="md-nav__item">
 313       <a href="ft2-library_setup.html" class="md-nav__link">
 314         Library Setup
 315       </a>
 316     </li>
 317
 318
 319
 320
 321
 322
 323
 324     <li class="md-nav__item">
 325       <a href="ft2-face_creation.html" class="md-nav__link">
 326         Face Creation
 327       </a>
 328     </li>
 329
 330
 331
 332
 333
 334
 335
 336     <li class="md-nav__item">
 337       <a href="ft2-font_testing_macros.html" class="md-nav__link">
 338         Font Testing Macros
 339       </a>
 340     </li>
 341
 342
 343
 344
 345
 346
 347
 348     <li class="md-nav__item">
 349       <a href="ft2-sizing_and_scaling.html" class="md-nav__link">
 350         Sizing and Scaling
 351       </a>
 352     </li>
 353
 354
 355
 356
 357
 358
 359
 360     <li class="md-nav__item">
 361       <a href="ft2-glyph_retrieval.html" class="md-nav__link">
 362         Glyph Retrieval
 363       </a>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="ft2-character_mapping.html" class="md-nav__link">
 374         Character Mapping
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386     <li class="md-nav__item md-nav__item--active">
 387
 388       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 389
 390
 391
 392
 393
 394         <label class="md-nav__link md-nav__link--active" for="__toc">
 395           Information Retrieval
 396           <span class="md-nav__icon md-icon"></span>
 397         </label>
 398
 399       <a href="ft2-information_retrieval.html" class="md-nav__link md-nav__link--active">
 400         Information Retrieval
 401       </a>
 402
 403
 404 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 405
 406
 407
 408
 409
 410
 411     <label class="md-nav__title" for="__toc">
 412       <span class="md-nav__icon md-icon"></span>
 413       Table of contents
 414     </label>
 415     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 416
 417         <li class="md-nav__item">
 418   <a href="#synopsis" class="md-nav__link">
 419     Synopsis
 420   </a>
 421
 422 </li>
 423
 424         <li class="md-nav__item">
 425   <a href="#ft_get_name_index" class="md-nav__link">
 426     FT_Get_Name_Index
 427   </a>
 428
 429 </li>
 430
 431         <li class="md-nav__item">
 432   <a href="#ft_get_glyph_name" class="md-nav__link">
 433     FT_Get_Glyph_Name
 434   </a>
 435
 436 </li>
 437
 438         <li class="md-nav__item">
 439   <a href="#ft_get_postscript_name" class="md-nav__link">
 440     FT_Get_Postscript_Name
 441   </a>
 442
 443 </li>
 444
 445         <li class="md-nav__item">
 446   <a href="#ft_get_fstype_flags" class="md-nav__link">
 447     FT_Get_FSType_Flags
 448   </a>
 449
 450 </li>
 451
 452         <li class="md-nav__item">
 453   <a href="#ft_fstype_xxx" class="md-nav__link">
 454     FT_FSTYPE_XXX
 455   </a>
 456
 457 </li>
 458
 459         <li class="md-nav__item">
 460   <a href="#ft_get_subglyph_info" class="md-nav__link">
 461     FT_Get_SubGlyph_Info
 462   </a>
 463
 464 </li>
 465
 466         <li class="md-nav__item">
 467   <a href="#ft_subglyph_flag_xxx" class="md-nav__link">
 468     FT_SUBGLYPH_FLAG_XXX
 469   </a>
 470
 471 </li>
 472
 473     </ul>
 474
 475 </nav>
 476
 477     </li>
 478
 479
 480
 481
 482
 483
 484
 485     <li class="md-nav__item">
 486       <a href="ft2-other_api_data.html" class="md-nav__link">
 487         Other API Data
 488       </a>
 489     </li>
 490
 491
 492
 493         </ul>
 494       </nav>
 495     </li>
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item md-nav__item--nested">
 508
 509
 510         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 511
 512       <label class="md-nav__link" for="__nav_5">
 513         Extended API
 514         <span class="md-nav__icon md-icon"></span>
 515       </label>
 516       <nav class="md-nav" aria-label="Extended API" data-md-level="1">
 517         <label class="md-nav__title" for="__nav_5">
 518           <span class="md-nav__icon md-icon"></span>
 519           Extended API
 520         </label>
 521         <ul class="md-nav__list" data-md-scrollfix>
 522
 523
 524
 525
 526
 527     <li class="md-nav__item">
 528       <a href="ft2-glyph_variants.html" class="md-nav__link">
 529         Unicode Variation Sequences
 530       </a>
 531     </li>
 532
 533
 534
 535
 536
 537
 538
 539     <li class="md-nav__item">
 540       <a href="ft2-color_management.html" class="md-nav__link">
 541         Glyph Color Management
 542       </a>
 543     </li>
 544
 545
 546
 547
 548
 549
 550
 551     <li class="md-nav__item">
 552       <a href="ft2-layer_management.html" class="md-nav__link">
 553         Glyph Layer Management
 554       </a>
 555     </li>
 556
 557
 558
 559
 560
 561
 562
 563     <li class="md-nav__item">
 564       <a href="ft2-glyph_management.html" class="md-nav__link">
 565         Glyph Management
 566       </a>
 567     </li>
 568
 569
 570
 571
 572
 573
 574
 575     <li class="md-nav__item">
 576       <a href="ft2-mac_specific.html" class="md-nav__link">
 577         Mac Specific Interface
 578       </a>
 579     </li>
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="ft2-sizes_management.html" class="md-nav__link">
 589         Size Management
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599     <li class="md-nav__item">
 600       <a href="ft2-header_file_macros.html" class="md-nav__link">
 601         Header File Macros
 602       </a>
 603     </li>
 604
 605
 606
 607         </ul>
 608       </nav>
 609     </li>
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621     <li class="md-nav__item md-nav__item--nested">
 622
 623
 624         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
 625
 626       <label class="md-nav__link" for="__nav_6">
 627         Format-Specific API
 628         <span class="md-nav__icon md-icon"></span>
 629       </label>
 630       <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
 631         <label class="md-nav__title" for="__nav_6">
 632           <span class="md-nav__icon md-icon"></span>
 633           Format-Specific API
 634         </label>
 635         <ul class="md-nav__list" data-md-scrollfix>
 636
 637
 638
 639
 640
 641     <li class="md-nav__item">
 642       <a href="ft2-multiple_masters.html" class="md-nav__link">
 643         Multiple Masters
 644       </a>
 645     </li>
 646
 647
 648
 649
 650
 651
 652
 653     <li class="md-nav__item">
 654       <a href="ft2-truetype_tables.html" class="md-nav__link">
 655         TrueType Tables
 656       </a>
 657     </li>
 658
 659
 660
 661
 662
 663
 664
 665     <li class="md-nav__item">
 666       <a href="ft2-type1_tables.html" class="md-nav__link">
 667         Type 1 Tables
 668       </a>
 669     </li>
 670
 671
 672
 673
 674
 675
 676
 677     <li class="md-nav__item">
 678       <a href="ft2-sfnt_names.html" class="md-nav__link">
 679         SFNT Names
 680       </a>
 681     </li>
 682
 683
 684
 685
 686
 687
 688
 689     <li class="md-nav__item">
 690       <a href="ft2-bdf_fonts.html" class="md-nav__link">
 691         BDF and PCF Files
 692       </a>
 693     </li>
 694
 695
 696
 697
 698
 699
 700
 701     <li class="md-nav__item">
 702       <a href="ft2-cid_fonts.html" class="md-nav__link">
 703         CID Fonts
 704       </a>
 705     </li>
 706
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="ft2-pfr_fonts.html" class="md-nav__link">
 715         PFR Fonts
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725     <li class="md-nav__item">
 726       <a href="ft2-winfnt_fonts.html" class="md-nav__link">
 727         Window FNT Files
 728       </a>
 729     </li>
 730
 731
 732
 733
 734
 735
 736
 737     <li class="md-nav__item">
 738       <a href="ft2-svg_fonts.html" class="md-nav__link">
 739         OpenType SVG Fonts
 740       </a>
 741     </li>
 742
 743
 744
 745
 746
 747
 748
 749     <li class="md-nav__item">
 750       <a href="ft2-font_formats.html" class="md-nav__link">
 751         Font Formats
 752       </a>
 753     </li>
 754
 755
 756
 757
 758
 759
 760
 761     <li class="md-nav__item">
 762       <a href="ft2-gasp_table.html" class="md-nav__link">
 763         Gasp Table
 764       </a>
 765     </li>
 766
 767
 768
 769         </ul>
 770       </nav>
 771     </li>
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783     <li class="md-nav__item md-nav__item--nested">
 784
 785
 786         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
 787
 788       <label class="md-nav__link" for="__nav_7">
 789         Controlling FreeType Modules
 790         <span class="md-nav__icon md-icon"></span>
 791       </label>
 792       <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
 793         <label class="md-nav__title" for="__nav_7">
 794           <span class="md-nav__icon md-icon"></span>
 795           Controlling FreeType Modules
 796         </label>
 797         <ul class="md-nav__list" data-md-scrollfix>
 798
 799
 800
 801
 802
 803     <li class="md-nav__item">
 804       <a href="ft2-auto_hinter.html" class="md-nav__link">
 805         The auto-hinter
 806       </a>
 807     </li>
 808
 809
 810
 811
 812
 813
 814
 815     <li class="md-nav__item">
 816       <a href="ft2-cff_driver.html" class="md-nav__link">
 817         The CFF driver
 818       </a>
 819     </li>
 820
 821
 822
 823
 824
 825
 826
 827     <li class="md-nav__item">
 828       <a href="ft2-t1_cid_driver.html" class="md-nav__link">
 829         The Type 1 and CID drivers
 830       </a>
 831     </li>
 832
 833
 834
 835
 836
 837
 838
 839     <li class="md-nav__item">
 840       <a href="ft2-tt_driver.html" class="md-nav__link">
 841         The TrueType driver
 842       </a>
 843     </li>
 844
 845
 846
 847
 848
 849
 850
 851     <li class="md-nav__item">
 852       <a href="ft2-pcf_driver.html" class="md-nav__link">
 853         The PCF driver
 854       </a>
 855     </li>
 856
 857
 858
 859
 860
 861
 862
 863     <li class="md-nav__item">
 864       <a href="ft2-ot_svg_driver.html" class="md-nav__link">
 865         The SVG driver
 866       </a>
 867     </li>
 868
 869
 870
 871
 872
 873
 874
 875     <li class="md-nav__item">
 876       <a href="ft2-properties.html" class="md-nav__link">
 877         Driver properties
 878       </a>
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="ft2-parameter_tags.html" class="md-nav__link">
 889         Parameter Tags
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899     <li class="md-nav__item">
 900       <a href="ft2-lcd_rendering.html" class="md-nav__link">
 901         Subpixel Rendering
 902       </a>
 903     </li>
 904
 905
 906
 907         </ul>
 908       </nav>
 909     </li>
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921     <li class="md-nav__item md-nav__item--nested">
 922
 923
 924         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
 925
 926       <label class="md-nav__link" for="__nav_8">
 927         Cache Sub-System
 928         <span class="md-nav__icon md-icon"></span>
 929       </label>
 930       <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
 931         <label class="md-nav__title" for="__nav_8">
 932           <span class="md-nav__icon md-icon"></span>
 933           Cache Sub-System
 934         </label>
 935         <ul class="md-nav__list" data-md-scrollfix>
 936
 937
 938
 939
 940
 941     <li class="md-nav__item">
 942       <a href="ft2-cache_subsystem.html" class="md-nav__link">
 943         Cache Sub-System
 944       </a>
 945     </li>
 946
 947
 948
 949         </ul>
 950       </nav>
 951     </li>
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item md-nav__item--nested">
 964
 965
 966         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
 967
 968       <label class="md-nav__link" for="__nav_9">
 969         Support API
 970         <span class="md-nav__icon md-icon"></span>
 971       </label>
 972       <nav class="md-nav" aria-label="Support API" data-md-level="1">
 973         <label class="md-nav__title" for="__nav_9">
 974           <span class="md-nav__icon md-icon"></span>
 975           Support API
 976         </label>
 977         <ul class="md-nav__list" data-md-scrollfix>
 978
 979
 980
 981
 982
 983     <li class="md-nav__item">
 984       <a href="ft2-computations.html" class="md-nav__link">
 985         Computations
 986       </a>
 987     </li>
 988
 989
 990
 991
 992
 993
 994
 995     <li class="md-nav__item">
 996       <a href="ft2-list_processing.html" class="md-nav__link">
 997         List Processing
 998       </a>
 999     </li>
1000
1001
1002
1003
1004
1005
1006
1007     <li class="md-nav__item">
1008       <a href="ft2-outline_processing.html" class="md-nav__link">
1009         Outline Processing
1010       </a>
1011     </li>
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="ft2-quick_advance.html" class="md-nav__link">
1021         Quick retrieval of advance values
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031     <li class="md-nav__item">
1032       <a href="ft2-bitmap_handling.html" class="md-nav__link">
1033         Bitmap Handling
1034       </a>
1035     </li>
1036
1037
1038
1039
1040
1041
1042
1043     <li class="md-nav__item">
1044       <a href="ft2-raster.html" class="md-nav__link">
1045         Scanline Converter
1046       </a>
1047     </li>
1048
1049
1050
1051
1052
1053
1054
1055     <li class="md-nav__item">
1056       <a href="ft2-glyph_stroker.html" class="md-nav__link">
1057         Glyph Stroker
1058       </a>
1059     </li>
1060
1061
1062
1063
1064
1065
1066
1067     <li class="md-nav__item">
1068       <a href="ft2-system_interface.html" class="md-nav__link">
1069         System Interface
1070       </a>
1071     </li>
1072
1073
1074
1075
1076
1077
1078
1079     <li class="md-nav__item">
1080       <a href="ft2-module_management.html" class="md-nav__link">
1081         Module Management
1082       </a>
1083     </li>
1084
1085
1086
1087
1088
1089
1090
1091     <li class="md-nav__item">
1092       <a href="ft2-gzip.html" class="md-nav__link">
1093         GZIP Streams
1094       </a>
1095     </li>
1096
1097
1098
1099
1100
1101
1102
1103     <li class="md-nav__item">
1104       <a href="ft2-lzw.html" class="md-nav__link">
1105         LZW Streams
1106       </a>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115     <li class="md-nav__item">
1116       <a href="ft2-bzip2.html" class="md-nav__link">
1117         BZIP2 Streams
1118       </a>
1119     </li>
1120
1121
1122
1123
1124
1125
1126
1127     <li class="md-nav__item">
1128       <a href="ft2-debugging_apis.html" class="md-nav__link">
1129         External Debugging APIs
1130       </a>
1131     </li>
1132
1133
1134
1135         </ul>
1136       </nav>
1137     </li>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149     <li class="md-nav__item md-nav__item--nested">
1150
1151
1152         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
1153
1154       <label class="md-nav__link" for="__nav_10">
1155         Error Codes
1156         <span class="md-nav__icon md-icon"></span>
1157       </label>
1158       <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1159         <label class="md-nav__title" for="__nav_10">
1160           <span class="md-nav__icon md-icon"></span>
1161           Error Codes
1162         </label>
1163         <ul class="md-nav__list" data-md-scrollfix>
1164
1165
1166
1167
1168
1169     <li class="md-nav__item">
1170       <a href="ft2-error_enumerations.html" class="md-nav__link">
1171         Error Enumerations
1172       </a>
1173     </li>
1174
1175
1176
1177
1178
1179
1180
1181     <li class="md-nav__item">
1182       <a href="ft2-error_code_values.html" class="md-nav__link">
1183         Error Code Values
1184       </a>
1185     </li>
1186
1187
1188
1189         </ul>
1190       </nav>
1191     </li>
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item md-nav__item--nested">
1204
1205
1206         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" >
1207
1208       <label class="md-nav__link" for="__nav_11">
1209         Miscellaneous
1210         <span class="md-nav__icon md-icon"></span>
1211       </label>
1212       <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1213         <label class="md-nav__title" for="__nav_11">
1214           <span class="md-nav__icon md-icon"></span>
1215           Miscellaneous
1216         </label>
1217         <ul class="md-nav__list" data-md-scrollfix>
1218
1219
1220
1221
1222
1223     <li class="md-nav__item">
1224       <a href="ft2-gx_validation.html" class="md-nav__link">
1225         TrueTypeGX/AAT Validation
1226       </a>
1227     </li>
1228
1229
1230
1231
1232
1233
1234
1235     <li class="md-nav__item">
1236       <a href="ft2-incremental.html" class="md-nav__link">
1237         Incremental Loading
1238       </a>
1239     </li>
1240
1241
1242
1243
1244
1245
1246
1247     <li class="md-nav__item">
1248       <a href="ft2-truetype_engine.html" class="md-nav__link">
1249         The TrueType Engine
1250       </a>
1251     </li>
1252
1253
1254
1255
1256
1257
1258
1259     <li class="md-nav__item">
1260       <a href="ft2-ot_validation.html" class="md-nav__link">
1261         OpenType Validation
1262       </a>
1263     </li>
1264
1265
1266
1267         </ul>
1268       </nav>
1269     </li>
1270
1271
1272
1273   </ul>
1274 </nav>
1275                   </div>
1276                 </div>
1277               </div>
1278
1279
1280
1281               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1282                 <div class="md-sidebar__scrollwrap">
1283                   <div class="md-sidebar__inner">
1284
1285 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1286
1287
1288
1289
1290
1291
1292     <label class="md-nav__title" for="__toc">
1293       <span class="md-nav__icon md-icon"></span>
1294       Table of contents
1295     </label>
1296     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1297
1298         <li class="md-nav__item">
1299   <a href="#synopsis" class="md-nav__link">
1300     Synopsis
1301   </a>
1302
1303 </li>
1304
1305         <li class="md-nav__item">
1306   <a href="#ft_get_name_index" class="md-nav__link">
1307     FT_Get_Name_Index
1308   </a>
1309
1310 </li>
1311
1312         <li class="md-nav__item">
1313   <a href="#ft_get_glyph_name" class="md-nav__link">
1314     FT_Get_Glyph_Name
1315   </a>
1316
1317 </li>
1318
1319         <li class="md-nav__item">
1320   <a href="#ft_get_postscript_name" class="md-nav__link">
1321     FT_Get_Postscript_Name
1322   </a>
1323
1324 </li>
1325
1326         <li class="md-nav__item">
1327   <a href="#ft_get_fstype_flags" class="md-nav__link">
1328     FT_Get_FSType_Flags
1329   </a>
1330
1331 </li>
1332
1333         <li class="md-nav__item">
1334   <a href="#ft_fstype_xxx" class="md-nav__link">
1335     FT_FSTYPE_XXX
1336   </a>
1337
1338 </li>
1339
1340         <li class="md-nav__item">
1341   <a href="#ft_get_subglyph_info" class="md-nav__link">
1342     FT_Get_SubGlyph_Info
1343   </a>
1344
1345 </li>
1346
1347         <li class="md-nav__item">
1348   <a href="#ft_subglyph_flag_xxx" class="md-nav__link">
1349     FT_SUBGLYPH_FLAG_XXX
1350   </a>
1351
1352 </li>
1353
1354     </ul>
1355
1356 </nav>
1357                   </div>
1358                 </div>
1359               </div>
1360
1361
1362           <div class="md-content" data-md-component="content">
1363             <article class="md-content__inner md-typeset">
1364
1365
1366
1367                 <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; Information Retrieval</p>
1368 <hr />
1369 <h1 id="information-retrieval">Information Retrieval<a class="headerlink" href="#information-retrieval" title="Permanent link">&para;</a></h1>
1370 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1371 <p>Functions to retrieve font and glyph information. Only some very basic data is covered; see also the chapter on the format-specific API for more.</p>
1372 <h2 id="ft_get_name_index">FT_Get_Name_Index<a class="headerlink" href="#ft_get_name_index" title="Permanent link">&para;</a></h2>
1373 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1374 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> )
1375   <b>FT_Get_Name_Index</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>           face,
1376                      <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_string">FT_String</a>*  glyph_name );
1377 </code></pre></div>
1378
1379 <p>Return the glyph index of a given glyph name. This only works for those faces where <code><a href="ft2-font_testing_macros.html#ft_has_glyph_names">FT_HAS_GLYPH_NAMES</a></code> returns true.</p>
1380 <h4>input</h4>
1381 <table class="fields">
1382 <tr><td class="val" id="face">face</td><td class="desc">
1383 <p>A handle to the source face object.</p>
1384 </td></tr>
1385 <tr><td class="val" id="glyph_name">glyph_name</td><td class="desc">
1386 <p>The glyph name.</p>
1387 </td></tr>
1388 </table>
1389
1390 <h4>return</h4>
1391
1392 <p>The glyph index. 0&nbsp;means &lsquo;undefined character code&rsquo;.</p>
1393 <h4>note</h4>
1394
1395 <p>Acceptable glyph names might come from the <a href="https://github.com/adobe-type-tools/agl-aglfn">Adobe Glyph List</a>. See <code><a href="ft2-information_retrieval.html#ft_get_glyph_name">FT_Get_Glyph_Name</a></code> for the inverse functionality.</p>
1396 <p>This function has limited capabilities if the config macro <code>FT_CONFIG_OPTION_POSTSCRIPT_NAMES</code> is not defined in <code>ftoption.h</code>: It then works only for fonts that actually embed glyph names (which many recent OpenType fonts do not).</p>
1397 <hr>
1398
1399 <h2 id="ft_get_glyph_name">FT_Get_Glyph_Name<a class="headerlink" href="#ft_get_glyph_name" title="Permanent link">&para;</a></h2>
1400 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1401 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1402   <b>FT_Get_Glyph_Name</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>     face,
1403                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     glyph_index,
1404                      <a href="ft2-basic_types.html#ft_pointer">FT_Pointer</a>  buffer,
1405                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     buffer_max );
1406 </code></pre></div>
1407
1408 <p>Retrieve the ASCII name of a given glyph in a face. This only works for those faces where <code><a href="ft2-font_testing_macros.html#ft_has_glyph_names">FT_HAS_GLYPH_NAMES</a></code> returns true.</p>
1409 <h4>input</h4>
1410 <table class="fields">
1411 <tr><td class="val" id="face">face</td><td class="desc">
1412 <p>A handle to a source face object.</p>
1413 </td></tr>
1414 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
1415 <p>The glyph index.</p>
1416 </td></tr>
1417 <tr><td class="val" id="buffer_max">buffer_max</td><td class="desc">
1418 <p>The maximum number of bytes available in the buffer.</p>
1419 </td></tr>
1420 </table>
1421
1422 <h4>output</h4>
1423 <table class="fields">
1424 <tr><td class="val" id="buffer">buffer</td><td class="desc">
1425 <p>A pointer to a target buffer where the name is copied to.</p>
1426 </td></tr>
1427 </table>
1428
1429 <h4>return</h4>
1430
1431 <p>FreeType error code. 0&nbsp;means success.</p>
1432 <h4>note</h4>
1433
1434 <p>An error is returned if the face doesn't provide glyph names or if the glyph index is invalid. In all cases of failure, the first byte of <code>buffer</code> is set to&nbsp;0 to indicate an empty name.</p>
1435 <p>The glyph name is truncated to fit within the buffer if it is too long. The returned string is always zero-terminated.</p>
1436 <p>Be aware that FreeType reorders glyph indices internally so that glyph index&nbsp;0 always corresponds to the &lsquo;missing glyph&rsquo; (called &lsquo;.notdef&rsquo;).</p>
1437 <p>This function has limited capabilities if the config macro <code>FT_CONFIG_OPTION_POSTSCRIPT_NAMES</code> is not defined in <code>ftoption.h</code>: It then works only for fonts that actually embed glyph names (which many recent OpenType fonts do not).</p>
1438 <hr>
1439
1440 <h2 id="ft_get_postscript_name">FT_Get_Postscript_Name<a class="headerlink" href="#ft_get_postscript_name" title="Permanent link">&para;</a></h2>
1441 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1442 <div class = "codehilite"><pre><code>  FT_EXPORT( <span class="keyword">const</span> <span class="keyword">char</span>* )
1443   <b>FT_Get_Postscript_Name</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>  face );
1444 </code></pre></div>
1445
1446 <p>Retrieve the ASCII PostScript name of a given face, if available. This only works with PostScript, TrueType, and OpenType fonts.</p>
1447 <h4>input</h4>
1448 <table class="fields">
1449 <tr><td class="val" id="face">face</td><td class="desc">
1450 <p>A handle to the source face object.</p>
1451 </td></tr>
1452 </table>
1453
1454 <h4>return</h4>
1455
1456 <p>A pointer to the face's PostScript name. <code>NULL</code> if unavailable.</p>
1457 <h4>note</h4>
1458
1459 <p>The returned pointer is owned by the face and is destroyed with it.</p>
1460 <p>For variation fonts, this string changes if you select a different instance, and you have to call <code>FT_Get_PostScript_Name</code> again to retrieve it. FreeType follows Adobe TechNote #5902, &lsquo;Generating PostScript Names for Fonts Using OpenType Font Variations&rsquo;.</p>
1461 <p><a href="https://download.macromedia.com/pub/developer/opentype/tech-notes/5902.AdobePSNameGeneration.html">https://download.macromedia.com/pub/developer/opentype/tech-notes/5902.AdobePSNameGeneration.html</a></p>
1462 <p>[Since 2.9] Special PostScript names for named instances are only returned if the named instance is set with <code><a href="ft2-multiple_masters.html#ft_set_named_instance">FT_Set_Named_Instance</a></code> (and the font has corresponding entries in its &lsquo;fvar&rsquo; table or is the default named instance). If <code><a href="ft2-font_testing_macros.html#ft_is_variation">FT_IS_VARIATION</a></code> returns true, the algorithmically derived PostScript name is provided, not looking up special entries for named instances.</p>
1463 <hr>
1464
1465 <h2 id="ft_get_fstype_flags">FT_Get_FSType_Flags<a class="headerlink" href="#ft_get_fstype_flags" title="Permanent link">&para;</a></h2>
1466 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1467 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> )
1468   <b>FT_Get_FSType_Flags</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>  face );
1469 </code></pre></div>
1470
1471 <p>Return the <code>fsType</code> flags for a font.</p>
1472 <h4>input</h4>
1473 <table class="fields">
1474 <tr><td class="val" id="face">face</td><td class="desc">
1475 <p>A handle to the source face object.</p>
1476 </td></tr>
1477 </table>
1478
1479 <h4>return</h4>
1480
1481 <p>The <code>fsType</code> flags, see <code><a href="ft2-information_retrieval.html#ft_fstype_xxx">FT_FSTYPE_XXX</a></code>.</p>
1482 <h4>note</h4>
1483
1484 <p>Use this function rather than directly reading the <code>fs_type</code> field in the <code><a href="ft2-type1_tables.html#ps_fontinforec">PS_FontInfoRec</a></code> structure, which is only guaranteed to return the correct results for Type&nbsp;1 fonts.</p>
1485 <h4>since</h4>
1486
1487 <p>2.3.8</p>
1488 <hr>
1489
1490 <h2 id="ft_fstype_xxx">FT_FSTYPE_XXX<a class="headerlink" href="#ft_fstype_xxx" title="Permanent link">&para;</a></h2>
1491 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1492 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_installable_embedding">FT_FSTYPE_INSTALLABLE_EMBEDDING</a>         0x0000
1493 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_restricted_license_embedding">FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING</a>  0x0002
1494 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_preview_and_print_embedding">FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING</a>   0x0004
1495 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_editable_embedding">FT_FSTYPE_EDITABLE_EMBEDDING</a>            0x0008
1496 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_no_subsetting">FT_FSTYPE_NO_SUBSETTING</a>                 0x0100
1497 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_fstype_bitmap_embedding_only">FT_FSTYPE_BITMAP_EMBEDDING_ONLY</a>         0x0200
1498 </code></pre></div>
1499
1500 <p>A list of bit flags used in the <code>fsType</code> field of the OS/2 table in a TrueType or OpenType font and the <code>FSType</code> entry in a PostScript font. These bit flags are returned by <code><a href="ft2-information_retrieval.html#ft_get_fstype_flags">FT_Get_FSType_Flags</a></code>; they inform client applications of embedding and subsetting restrictions associated with a font.</p>
1501 <p>See <a href="https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf">https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf</a> for more details.</p>
1502 <h4>values</h4>
1503 <table class="fields long">
1504 <tr><td class="val" id="ft_fstype_installable_embedding">FT_FSTYPE_INSTALLABLE_EMBEDDING</td><td class="desc">
1505 <p>Fonts with no fsType bit set may be embedded and permanently installed on the remote system by an application.</p>
1506 </td></tr>
1507 <tr><td class="val" id="ft_fstype_restricted_license_embedding">FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING</td><td class="desc">
1508 <p>Fonts that have only this bit set must not be modified, embedded or exchanged in any manner without first obtaining permission of the font software copyright owner.</p>
1509 </td></tr>
1510 <tr><td class="val" id="ft_fstype_preview_and_print_embedding">FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING</td><td class="desc">
1511 <p>The font may be embedded and temporarily loaded on the remote system. Documents containing Preview &amp; Print fonts must be opened &lsquo;read-only&rsquo;; no edits can be applied to the document.</p>
1512 </td></tr>
1513 <tr><td class="val" id="ft_fstype_editable_embedding">FT_FSTYPE_EDITABLE_EMBEDDING</td><td class="desc">
1514 <p>The font may be embedded but must only be installed temporarily on other systems. In contrast to Preview &amp; Print fonts, documents containing editable fonts may be opened for reading, editing is permitted, and changes may be saved.</p>
1515 </td></tr>
1516 <tr><td class="val" id="ft_fstype_no_subsetting">FT_FSTYPE_NO_SUBSETTING</td><td class="desc">
1517 <p>The font may not be subsetted prior to embedding.</p>
1518 </td></tr>
1519 <tr><td class="val" id="ft_fstype_bitmap_embedding_only">FT_FSTYPE_BITMAP_EMBEDDING_ONLY</td><td class="desc">
1520 <p>Only bitmaps contained in the font may be embedded; no outline data may be embedded. If there are no bitmaps available in the font, then the font is unembeddable.</p>
1521 </td></tr>
1522 </table>
1523
1524 <h4>note</h4>
1525
1526 <p>The flags are ORed together, thus more than a single value can be returned.</p>
1527 <p>While the <code>fsType</code> flags can indicate that a font may be embedded, a license with the font vendor may be separately required to use the font in this way.</p>
1528 <hr>
1529
1530 <h2 id="ft_get_subglyph_info">FT_Get_SubGlyph_Info<a class="headerlink" href="#ft_get_subglyph_info" title="Permanent link">&para;</a></h2>
1531 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1532 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1533   <b>FT_Get_SubGlyph_Info</b>( <a href="ft2-glyph_retrieval.html#ft_glyphslot">FT_GlyphSlot</a>  glyph,
1534                         <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>       sub_index,
1535                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_index,
1536                         <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>      *p_flags,
1537                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_arg1,
1538                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_arg2,
1539                         <a href="ft2-basic_types.html#ft_matrix">FT_Matrix</a>    *p_transform );
1540 </code></pre></div>
1541
1542 <p>Retrieve a description of a given subglyph. Only use it if <code>glyph-&gt;format</code> is <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_COMPOSITE</a></code>; an error is returned otherwise.</p>
1543 <h4>input</h4>
1544 <table class="fields">
1545 <tr><td class="val" id="glyph">glyph</td><td class="desc">
1546 <p>The source glyph slot.</p>
1547 </td></tr>
1548 <tr><td class="val" id="sub_index">sub_index</td><td class="desc">
1549 <p>The index of the subglyph. Must be less than <code>glyph-&gt;num_subglyphs</code>.</p>
1550 </td></tr>
1551 </table>
1552
1553 <h4>output</h4>
1554 <table class="fields">
1555 <tr><td class="val" id="p_index">p_index</td><td class="desc">
1556 <p>The glyph index of the subglyph.</p>
1557 </td></tr>
1558 <tr><td class="val" id="p_flags">p_flags</td><td class="desc">
1559 <p>The subglyph flags, see <code><a href="ft2-information_retrieval.html#ft_subglyph_flag_xxx">FT_SUBGLYPH_FLAG_XXX</a></code>.</p>
1560 </td></tr>
1561 <tr><td class="val" id="p_arg1">p_arg1</td><td class="desc">
1562 <p>The subglyph's first argument (if any).</p>
1563 </td></tr>
1564 <tr><td class="val" id="p_arg2">p_arg2</td><td class="desc">
1565 <p>The subglyph's second argument (if any).</p>
1566 </td></tr>
1567 <tr><td class="val" id="p_transform">p_transform</td><td class="desc">
1568 <p>The subglyph transformation (if any).</p>
1569 </td></tr>
1570 </table>
1571
1572 <h4>return</h4>
1573
1574 <p>FreeType error code. 0&nbsp;means success.</p>
1575 <h4>note</h4>
1576
1577 <p>The values of <code>*p_arg1</code>, <code>*p_arg2</code>, and <code>*p_transform</code> must be interpreted depending on the flags returned in <code>*p_flags</code>. See the OpenType specification for details.</p>
1578 <p><a href="https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description">https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description</a></p>
1579 <hr>
1580
1581 <h2 id="ft_subglyph_flag_xxx">FT_SUBGLYPH_FLAG_XXX<a class="headerlink" href="#ft_subglyph_flag_xxx" title="Permanent link">&para;</a></h2>
1582 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
1583 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_args_are_words">FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS</a>          1
1584 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_args_are_xy_values">FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES</a>      2
1585 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_round_xy_to_grid">FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID</a>        4
1586 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_scale">FT_SUBGLYPH_FLAG_SCALE</a>                   8
1587 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_xy_scale">FT_SUBGLYPH_FLAG_XY_SCALE</a>             0x40
1588 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_2x2">FT_SUBGLYPH_FLAG_2X2</a>                  0x80
1589 #<span class="keyword">define</span> <a href="ft2-information_retrieval.html#ft_subglyph_flag_use_my_metrics">FT_SUBGLYPH_FLAG_USE_MY_METRICS</a>      0x200
1590 </code></pre></div>
1591
1592 <p>A list of constants describing subglyphs. Please refer to the &lsquo;glyf&rsquo; table description in the OpenType specification for the meaning of the various flags (which get synthesized for non-OpenType subglyphs).</p>
1593 <p><a href="https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description">https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description</a></p>
1594 <h4>values</h4>
1595 <table class="fields long">
1596 <tr><td class="val" id="ft_subglyph_flag_args_are_words">FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS</td><td class="desc">
1597
1598 </td></tr>
1599 <tr><td class="val" id="ft_subglyph_flag_args_are_xy_values">FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES</td><td class="desc">
1600
1601 </td></tr>
1602 <tr><td class="val" id="ft_subglyph_flag_round_xy_to_grid">FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID</td><td class="desc">
1603
1604 </td></tr>
1605 <tr><td class="val" id="ft_subglyph_flag_scale">FT_SUBGLYPH_FLAG_SCALE</td><td class="desc">
1606
1607 </td></tr>
1608 <tr><td class="val" id="ft_subglyph_flag_xy_scale">FT_SUBGLYPH_FLAG_XY_SCALE</td><td class="desc">
1609
1610 </td></tr>
1611 <tr><td class="val" id="ft_subglyph_flag_2x2">FT_SUBGLYPH_FLAG_2X2</td><td class="desc">
1612
1613 </td></tr>
1614 <tr><td class="val" id="ft_subglyph_flag_use_my_metrics">FT_SUBGLYPH_FLAG_USE_MY_METRICS</td><td class="desc">
1615
1616 </td></tr>
1617 </table>
1618
1619 <hr>
1620
1621
1622
1623
1624
1625
1626
1627             </article>
1628           </div>
1629         </div>
1630
1631       </main>
1632
1633
1634 <footer class="md-footer">
1635
1636     <nav class="md-footer__inner md-grid" aria-label="Footer">
1637
1638
1639         <a href="ft2-character_mapping.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Character Mapping" rel="prev">
1640           <div class="md-footer__button md-icon">
1641             <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>
1642           </div>
1643           <div class="md-footer__title">
1644             <div class="md-ellipsis">
1645               <span class="md-footer__direction">
1646                 Previous
1647               </span>
1648               Character Mapping
1649             </div>
1650           </div>
1651         </a>
1652
1653
1654
1655         <a href="ft2-other_api_data.html" class="md-footer__link md-footer__link--next" aria-label="Next: Other API Data" rel="next">
1656           <div class="md-footer__title">
1657             <div class="md-ellipsis">
1658               <span class="md-footer__direction">
1659                 Next
1660               </span>
1661               Other API Data
1662             </div>
1663           </div>
1664           <div class="md-footer__button md-icon">
1665             <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>
1666           </div>
1667         </a>
1668
1669     </nav>
1670
1671   <div class="md-footer-meta md-typeset">
1672     <div class="md-footer-meta__inner md-grid">
1673       <div class="md-footer-copyright">
1674
1675           <div class="md-footer-copyright__highlight">
1676             Copyright 2023 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1677           </div>
1678
1679         Made with
1680         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1681           Material for MkDocs
1682         </a>
1683
1684       </div>
1685
1686     </div>
1687   </div>
1688 </footer>
1689
1690     </div>
1691     <div class="md-dialog" data-md-component="dialog">
1692       <div class="md-dialog__inner md-typeset"></div>
1693     </div>
1694     <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.477d984a.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "version": null}</script>
1695
1696
1697       <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
1698
1699         <script src="javascripts/extra.js"></script>
1700
1701
1702   </body>
1703 </html>