docs/reference/ft2-quick_advance.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>Quick retrieval of advance values - 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="#quick-retrieval-of-advance-values" 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                 Quick retrieval of advance values
 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   <li class="md-nav__item md-nav__item--nested">
 259
 260       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
 261
 262     <label class="md-nav__link" for="nav-4">
 263       Core API
 264     </label>
 265     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 266       <label class="md-nav__title" for="nav-4">
 267         Core API
 268       </label>
 269       <ul class="md-nav__list" data-md-scrollfix>
 270
 271
 272
 273
 274
 275
 276
 277   <li class="md-nav__item">
 278     <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
 279       FreeType Version
 280     </a>
 281   </li>
 282
 283
 284
 285
 286
 287
 288
 289   <li class="md-nav__item">
 290     <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
 291       Basic Data Types
 292     </a>
 293   </li>
 294
 295
 296
 297
 298
 299
 300
 301   <li class="md-nav__item">
 302     <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link">
 303       Base Interface
 304     </a>
 305   </li>
 306
 307
 308
 309
 310
 311
 312
 313   <li class="md-nav__item">
 314     <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
 315       Unicode Variation Sequences
 316     </a>
 317   </li>
 318
 319
 320
 321
 322
 323
 324
 325   <li class="md-nav__item">
 326     <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
 327       Glyph Color Management
 328     </a>
 329   </li>
 330
 331
 332
 333
 334
 335
 336
 337   <li class="md-nav__item">
 338     <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
 339       Glyph Layer Management
 340     </a>
 341   </li>
 342
 343
 344
 345
 346
 347
 348
 349   <li class="md-nav__item">
 350     <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
 351       Glyph Management
 352     </a>
 353   </li>
 354
 355
 356
 357
 358
 359
 360
 361   <li class="md-nav__item">
 362     <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
 363       Mac Specific Interface
 364     </a>
 365   </li>
 366
 367
 368
 369
 370
 371
 372
 373   <li class="md-nav__item">
 374     <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
 375       Size Management
 376     </a>
 377   </li>
 378
 379
 380
 381
 382
 383
 384
 385   <li class="md-nav__item">
 386     <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
 387       Header File Macros
 388     </a>
 389   </li>
 390
 391
 392       </ul>
 393     </nav>
 394   </li>
 395
 396
 397
 398
 399
 400
 401
 402   <li class="md-nav__item md-nav__item--nested">
 403
 404       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
 405
 406     <label class="md-nav__link" for="nav-5">
 407       Format-Specific API
 408     </label>
 409     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 410       <label class="md-nav__title" for="nav-5">
 411         Format-Specific API
 412       </label>
 413       <ul class="md-nav__list" data-md-scrollfix>
 414
 415
 416
 417
 418
 419
 420
 421   <li class="md-nav__item">
 422     <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
 423       Multiple Masters
 424     </a>
 425   </li>
 426
 427
 428
 429
 430
 431
 432
 433   <li class="md-nav__item">
 434     <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
 435       TrueType Tables
 436     </a>
 437   </li>
 438
 439
 440
 441
 442
 443
 444
 445   <li class="md-nav__item">
 446     <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
 447       Type 1 Tables
 448     </a>
 449   </li>
 450
 451
 452
 453
 454
 455
 456
 457   <li class="md-nav__item">
 458     <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
 459       SFNT Names
 460     </a>
 461   </li>
 462
 463
 464
 465
 466
 467
 468
 469   <li class="md-nav__item">
 470     <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
 471       BDF and PCF Files
 472     </a>
 473   </li>
 474
 475
 476
 477
 478
 479
 480
 481   <li class="md-nav__item">
 482     <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
 483       CID Fonts
 484     </a>
 485   </li>
 486
 487
 488
 489
 490
 491
 492
 493   <li class="md-nav__item">
 494     <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
 495       PFR Fonts
 496     </a>
 497   </li>
 498
 499
 500
 501
 502
 503
 504
 505   <li class="md-nav__item">
 506     <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
 507       Window FNT Files
 508     </a>
 509   </li>
 510
 511
 512
 513
 514
 515
 516
 517   <li class="md-nav__item">
 518     <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
 519       Font Formats
 520     </a>
 521   </li>
 522
 523
 524
 525
 526
 527
 528
 529   <li class="md-nav__item">
 530     <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
 531       Gasp Table
 532     </a>
 533   </li>
 534
 535
 536       </ul>
 537     </nav>
 538   </li>
 539
 540
 541
 542
 543
 544
 545
 546   <li class="md-nav__item md-nav__item--nested">
 547
 548       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
 549
 550     <label class="md-nav__link" for="nav-6">
 551       Controlling FreeType Modules
 552     </label>
 553     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 554       <label class="md-nav__title" for="nav-6">
 555         Controlling FreeType Modules
 556       </label>
 557       <ul class="md-nav__list" data-md-scrollfix>
 558
 559
 560
 561
 562
 563
 564
 565   <li class="md-nav__item">
 566     <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
 567       The auto-hinter
 568     </a>
 569   </li>
 570
 571
 572
 573
 574
 575
 576
 577   <li class="md-nav__item">
 578     <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
 579       The CFF driver
 580     </a>
 581   </li>
 582
 583
 584
 585
 586
 587
 588
 589   <li class="md-nav__item">
 590     <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
 591       The Type 1 and CID drivers
 592     </a>
 593   </li>
 594
 595
 596
 597
 598
 599
 600
 601   <li class="md-nav__item">
 602     <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
 603       The TrueType driver
 604     </a>
 605   </li>
 606
 607
 608
 609
 610
 611
 612
 613   <li class="md-nav__item">
 614     <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
 615       The PCF driver
 616     </a>
 617   </li>
 618
 619
 620
 621
 622
 623
 624
 625   <li class="md-nav__item">
 626     <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
 627       Driver properties
 628     </a>
 629   </li>
 630
 631
 632
 633
 634
 635
 636
 637   <li class="md-nav__item">
 638     <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
 639       Parameter Tags
 640     </a>
 641   </li>
 642
 643
 644
 645
 646
 647
 648
 649   <li class="md-nav__item">
 650     <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
 651       Subpixel Rendering
 652     </a>
 653   </li>
 654
 655
 656       </ul>
 657     </nav>
 658   </li>
 659
 660
 661
 662
 663
 664
 665
 666   <li class="md-nav__item md-nav__item--nested">
 667
 668       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
 669
 670     <label class="md-nav__link" for="nav-7">
 671       Cache Sub-System
 672     </label>
 673     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 674       <label class="md-nav__title" for="nav-7">
 675         Cache Sub-System
 676       </label>
 677       <ul class="md-nav__list" data-md-scrollfix>
 678
 679
 680
 681
 682
 683
 684
 685   <li class="md-nav__item">
 686     <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
 687       Cache Sub-System
 688     </a>
 689   </li>
 690
 691
 692       </ul>
 693     </nav>
 694   </li>
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 705
 706       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8" checked>
 707
 708     <label class="md-nav__link" for="nav-8">
 709       Support API
 710     </label>
 711     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 712       <label class="md-nav__title" for="nav-8">
 713         Support API
 714       </label>
 715       <ul class="md-nav__list" data-md-scrollfix>
 716
 717
 718
 719
 720
 721
 722
 723   <li class="md-nav__item">
 724     <a href="ft2-computations.html" title="Computations" class="md-nav__link">
 725       Computations
 726     </a>
 727   </li>
 728
 729
 730
 731
 732
 733
 734
 735   <li class="md-nav__item">
 736     <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
 737       List Processing
 738     </a>
 739   </li>
 740
 741
 742
 743
 744
 745
 746
 747   <li class="md-nav__item">
 748     <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
 749       Outline Processing
 750     </a>
 751   </li>
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761   <li class="md-nav__item md-nav__item--active">
 762
 763     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 764
 765
 766
 767
 768       <label class="md-nav__link md-nav__link--active" for="__toc">
 769         Quick retrieval of advance values
 770       </label>
 771
 772     <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link md-nav__link--active">
 773       Quick retrieval of advance values
 774     </a>
 775
 776
 777 <nav class="md-nav md-nav--secondary">
 778
 779
 780
 781
 782
 783     <label class="md-nav__title" for="__toc">Table of contents</label>
 784     <ul class="md-nav__list" data-md-scrollfix>
 785
 786         <li class="md-nav__item">
 787   <a href="#synopsis" class="md-nav__link">
 788     Synopsis
 789   </a>
 790
 791 </li>
 792
 793         <li class="md-nav__item">
 794   <a href="#ft_get_advance" class="md-nav__link">
 795     FT_Get_Advance
 796   </a>
 797
 798 </li>
 799
 800         <li class="md-nav__item">
 801   <a href="#ft_get_advances" class="md-nav__link">
 802     FT_Get_Advances
 803   </a>
 804
 805 </li>
 806
 807         <li class="md-nav__item">
 808   <a href="#ft_advance_flag_fast_only" class="md-nav__link">
 809     FT_ADVANCE_FLAG_FAST_ONLY
 810   </a>
 811
 812 </li>
 813
 814
 815
 816
 817
 818     </ul>
 819
 820 </nav>
 821
 822   </li>
 823
 824
 825
 826
 827
 828
 829
 830   <li class="md-nav__item">
 831     <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
 832       Bitmap Handling
 833     </a>
 834   </li>
 835
 836
 837
 838
 839
 840
 841
 842   <li class="md-nav__item">
 843     <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
 844       Scanline Converter
 845     </a>
 846   </li>
 847
 848
 849
 850
 851
 852
 853
 854   <li class="md-nav__item">
 855     <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
 856       Glyph Stroker
 857     </a>
 858   </li>
 859
 860
 861
 862
 863
 864
 865
 866   <li class="md-nav__item">
 867     <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
 868       System Interface
 869     </a>
 870   </li>
 871
 872
 873
 874
 875
 876
 877
 878   <li class="md-nav__item">
 879     <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
 880       Module Management
 881     </a>
 882   </li>
 883
 884
 885
 886
 887
 888
 889
 890   <li class="md-nav__item">
 891     <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
 892       GZIP Streams
 893     </a>
 894   </li>
 895
 896
 897
 898
 899
 900
 901
 902   <li class="md-nav__item">
 903     <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
 904       LZW Streams
 905     </a>
 906   </li>
 907
 908
 909
 910
 911
 912
 913
 914   <li class="md-nav__item">
 915     <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
 916       BZIP2 Streams
 917     </a>
 918   </li>
 919
 920
 921       </ul>
 922     </nav>
 923   </li>
 924
 925
 926
 927
 928
 929
 930
 931   <li class="md-nav__item md-nav__item--nested">
 932
 933       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
 934
 935     <label class="md-nav__link" for="nav-9">
 936       Error Codes
 937     </label>
 938     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 939       <label class="md-nav__title" for="nav-9">
 940         Error Codes
 941       </label>
 942       <ul class="md-nav__list" data-md-scrollfix>
 943
 944
 945
 946
 947
 948
 949
 950   <li class="md-nav__item">
 951     <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
 952       Error Enumerations
 953     </a>
 954   </li>
 955
 956
 957
 958
 959
 960
 961
 962   <li class="md-nav__item">
 963     <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
 964       Error Code Values
 965     </a>
 966   </li>
 967
 968
 969       </ul>
 970     </nav>
 971   </li>
 972
 973
 974
 975
 976
 977
 978
 979   <li class="md-nav__item md-nav__item--nested">
 980
 981       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
 982
 983     <label class="md-nav__link" for="nav-10">
 984       Miscellaneous
 985     </label>
 986     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 987       <label class="md-nav__title" for="nav-10">
 988         Miscellaneous
 989       </label>
 990       <ul class="md-nav__list" data-md-scrollfix>
 991
 992
 993
 994
 995
 996
 997
 998   <li class="md-nav__item">
 999     <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1000       TrueTypeGX/AAT Validation
1001     </a>
1002   </li>
1003
1004
1005
1006
1007
1008
1009
1010   <li class="md-nav__item">
1011     <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1012       Incremental Loading
1013     </a>
1014   </li>
1015
1016
1017
1018
1019
1020
1021
1022   <li class="md-nav__item">
1023     <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1024       The TrueType Engine
1025     </a>
1026   </li>
1027
1028
1029
1030
1031
1032
1033
1034   <li class="md-nav__item">
1035     <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1036       OpenType Validation
1037     </a>
1038   </li>
1039
1040
1041       </ul>
1042     </nav>
1043   </li>
1044
1045
1046   </ul>
1047 </nav>
1048                   </div>
1049                 </div>
1050               </div>
1051
1052
1053               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1054                 <div class="md-sidebar__scrollwrap">
1055                   <div class="md-sidebar__inner">
1056
1057 <nav class="md-nav md-nav--secondary">
1058
1059
1060
1061
1062
1063     <label class="md-nav__title" for="__toc">Table of contents</label>
1064     <ul class="md-nav__list" data-md-scrollfix>
1065
1066         <li class="md-nav__item">
1067   <a href="#synopsis" class="md-nav__link">
1068     Synopsis
1069   </a>
1070
1071 </li>
1072
1073         <li class="md-nav__item">
1074   <a href="#ft_get_advance" class="md-nav__link">
1075     FT_Get_Advance
1076   </a>
1077
1078 </li>
1079
1080         <li class="md-nav__item">
1081   <a href="#ft_get_advances" class="md-nav__link">
1082     FT_Get_Advances
1083   </a>
1084
1085 </li>
1086
1087         <li class="md-nav__item">
1088   <a href="#ft_advance_flag_fast_only" class="md-nav__link">
1089     FT_ADVANCE_FLAG_FAST_ONLY
1090   </a>
1091
1092 </li>
1093
1094
1095
1096
1097
1098     </ul>
1099
1100 </nav>
1101                   </div>
1102                 </div>
1103               </div>
1104
1105
1106           <div class="md-content">
1107             <article class="md-content__inner md-typeset">
1108
1109
1110
1111                 <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#support-api">Support API</a> &raquo; Quick retrieval of advance values</p>
1112 <hr />
1113 <h1 id="quick-retrieval-of-advance-values">Quick retrieval of advance values<a class="headerlink" href="#quick-retrieval-of-advance-values" title="Permanent link">&para;</a></h1>
1114 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1115 <p>This section contains functions to quickly extract advance values without handling glyph outlines, if possible.</p>
1116 <h2 id="ft_get_advance">FT_Get_Advance<a class="headerlink" href="#ft_get_advance" title="Permanent link">&para;</a></h2>
1117 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1118 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1119   <b>FT_Get_Advance</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>    face,
1120                   <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    gindex,
1121                   <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>   load_flags,
1122                   <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *padvance );
1123 </code></pre></div>
1124
1125 <p>Retrieve the advance value of a given glyph outline in an <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code>.</p>
1126 <h4>input</h4>
1127
1128 <table class="fields">
1129 <tr><td class="val" id="face">face</td><td class="desc">
1130 <p>The source <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> handle.</p>
1131 </td></tr>
1132 <tr><td class="val" id="gindex">gindex</td><td class="desc">
1133 <p>The glyph index.</p>
1134 </td></tr>
1135 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
1136 <p>A set of bit flags similar to those used when calling <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>, used to determine what kind of advances you need.</p>
1137 </td></tr>
1138 </table>
1139
1140 <h4>output</h4>
1141
1142 <table class="fields">
1143 <tr><td class="val" id="padvance">padvance</td><td class="desc">
1144 <p>The advance value. If scaling is performed (based on the value of <code>load_flags</code>), the advance value is in 16.16 format. Otherwise, it is in font units.</p>
1145 <p>If <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_VERTICAL_LAYOUT</a></code> is set, this is the vertical advance corresponding to a vertical layout. Otherwise, it is the horizontal advance in a horizontal layout.</p>
1146 </td></tr>
1147 </table>
1148
1149 <h4>return</h4>
1150
1151 <p>FreeType error code. 0 means success.</p>
1152 <h4>note</h4>
1153
1154 <p>This function may fail if you use <code><a href="ft2-quick_advance.html#ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY</a></code> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
1155 <p>A scaled advance is returned in 16.16 format but isn't transformed by the affine transformation specified by <code><a href="ft2-base_interface.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
1156 <hr>
1157
1158 <h2 id="ft_get_advances">FT_Get_Advances<a class="headerlink" href="#ft_get_advances" title="Permanent link">&para;</a></h2>
1159 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1160 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1161   <b>FT_Get_Advances</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>    face,
1162                    <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    start,
1163                    <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    count,
1164                    <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>   load_flags,
1165                    <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *padvances );
1166 </code></pre></div>
1167
1168 <p>Retrieve the advance values of several glyph outlines in an <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code>.</p>
1169 <h4>input</h4>
1170
1171 <table class="fields">
1172 <tr><td class="val" id="face">face</td><td class="desc">
1173 <p>The source <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> handle.</p>
1174 </td></tr>
1175 <tr><td class="val" id="start">start</td><td class="desc">
1176 <p>The first glyph index.</p>
1177 </td></tr>
1178 <tr><td class="val" id="count">count</td><td class="desc">
1179 <p>The number of advance values you want to retrieve.</p>
1180 </td></tr>
1181 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
1182 <p>A set of bit flags similar to those used when calling <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
1183 </td></tr>
1184 </table>
1185
1186 <h4>output</h4>
1187
1188 <table class="fields">
1189 <tr><td class="val" id="padvance">padvance</td><td class="desc">
1190 <p>The advance values. This array, to be provided by the caller, must contain at least <code>count</code> elements.</p>
1191 <p>If scaling is performed (based on the value of <code>load_flags</code>), the advance values are in 16.16 format. Otherwise, they are in font units.</p>
1192 <p>If <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_VERTICAL_LAYOUT</a></code> is set, these are the vertical advances corresponding to a vertical layout. Otherwise, they are the horizontal advances in a horizontal layout.</p>
1193 </td></tr>
1194 </table>
1195
1196 <h4>return</h4>
1197
1198 <p>FreeType error code. 0 means success.</p>
1199 <h4>note</h4>
1200
1201 <p>This function may fail if you use <code><a href="ft2-quick_advance.html#ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY</a></code> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
1202 <p>Scaled advances are returned in 16.16 format but aren't transformed by the affine transformation specified by <code><a href="ft2-base_interface.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
1203 <hr>
1204
1205 <h2 id="ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY<a class="headerlink" href="#ft_advance_flag_fast_only" title="Permanent link">&para;</a></h2>
1206 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1207 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_ADVANCE_FLAG_FAST_ONLY</b>  0x20000000L
1208 </code></pre></div>
1209
1210 <p>A bit-flag to be OR-ed with the <code>flags</code> parameter of the <code><a href="ft2-quick_advance.html#ft_get_advance">FT_Get_Advance</a></code> and <code><a href="ft2-quick_advance.html#ft_get_advances">FT_Get_Advances</a></code> functions.</p>
1211 <p>If set, it indicates that you want these functions to fail if the corresponding hinting mode or font driver doesn't allow for very quick advance computation.</p>
1212 <p>Typically, glyphs that are either unscaled, unhinted, bitmapped, or light-hinted can have their advance width computed very quickly.</p>
1213 <p>Normal and bytecode hinted modes that require loading, scaling, and hinting of the glyph outline, are extremely slow by comparison.</p>
1214 <hr>
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225             </article>
1226           </div>
1227         </div>
1228       </main>
1229
1230
1231 <footer class="md-footer">
1232
1233     <div class="md-footer-nav">
1234       <nav class="md-footer-nav__inner md-grid">
1235
1236           <a href="ft2-outline_processing.html" title="Outline Processing" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1237             <div class="md-flex__cell md-flex__cell--shrink">
1238               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1239             </div>
1240             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1241               <span class="md-flex__ellipsis">
1242                 <span class="md-footer-nav__direction">
1243                   Previous
1244                 </span>
1245                 Outline Processing
1246               </span>
1247             </div>
1248           </a>
1249
1250
1251           <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1252             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1253               <span class="md-flex__ellipsis">
1254                 <span class="md-footer-nav__direction">
1255                   Next
1256                 </span>
1257                 Bitmap Handling
1258               </span>
1259             </div>
1260             <div class="md-flex__cell md-flex__cell--shrink">
1261               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1262             </div>
1263           </a>
1264
1265       </nav>
1266     </div>
1267
1268   <div class="md-footer-meta md-typeset">
1269     <div class="md-footer-meta__inner md-grid">
1270       <div class="md-footer-copyright">
1271
1272           <div class="md-footer-copyright__highlight">
1273             Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1274           </div>
1275
1276         powered by
1277         <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1278         and
1279         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1280           Material for MkDocs</a>
1281       </div>
1282
1283     </div>
1284   </div>
1285 </footer>
1286
1287     </div>
1288
1289       <script src="assets/javascripts/application.c33a9706.js"></script>
1290
1291       <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1292
1293         <script src="javascripts/extra.js"></script>
1294
1295
1296   </body>
1297 </html>