docs/reference/ft2-base_interface.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>Base Interface - 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="#base-interface" 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                 Base Interface
 119
 120             </span>
 121
 122         </div>
 123       </div>
 124       <div class="md-flex__cell md-flex__cell--shrink">
 125
 126           <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
 127
 128 <div class="md-search" data-md-component="search" role="dialog">
 129   <label class="md-search__overlay" for="__search"></label>
 130   <div class="md-search__inner" role="search">
 131     <form class="md-search__form" name="search">
 132       <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
 133       <label class="md-icon md-search__icon" for="__search"></label>
 134       <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
 135         &#xE5CD;
 136       </button>
 137     </form>
 138     <div class="md-search__output">
 139       <div class="md-search__scrollwrap" data-md-scrollfix>
 140         <div class="md-search-result" data-md-component="result">
 141           <div class="md-search-result__meta">
 142             Type to start searching
 143           </div>
 144           <ol class="md-search-result__list"></ol>
 145         </div>
 146       </div>
 147     </div>
 148   </div>
 149 </div>
 150
 151       </div>
 152
 153     </div>
 154   </nav>
 155 </header>
 156
 157     <div class="md-container">
 158
 159
 160
 161
 162       <main class="md-main" role="main">
 163         <div class="md-main__inner md-grid" data-md-component="container">
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169                     <nav class="md-nav md-nav--primary" data-md-level="0">
 170   <label class="md-nav__title md-nav__title--site" for="__drawer">
 171     <a href="." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
 172
 173         <img alt="logo" src="images/favico.ico" width="48" height="48">
 174
 175     </a>
 176     FreeType-2.10.4 API Reference
 177   </label>
 178
 179   <ul class="md-nav__list" data-md-scrollfix>
 180
 181
 182
 183
 184
 185
 186   <li class="md-nav__item">
 187     <a href="index.html" title="TOC" class="md-nav__link">
 188       TOC
 189     </a>
 190   </li>
 191
 192
 193
 194
 195
 196
 197
 198   <li class="md-nav__item">
 199     <a href="ft2-index.html" title="Index" class="md-nav__link">
 200       Index
 201     </a>
 202   </li>
 203
 204
 205
 206
 207
 208
 209
 210   <li class="md-nav__item md-nav__item--nested">
 211
 212       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
 213
 214     <label class="md-nav__link" for="nav-3">
 215       General Remarks
 216     </label>
 217     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 218       <label class="md-nav__title" for="nav-3">
 219         General Remarks
 220       </label>
 221       <ul class="md-nav__list" data-md-scrollfix>
 222
 223
 224
 225
 226
 227
 228
 229   <li class="md-nav__item">
 230     <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
 231       FreeType's header inclusion scheme
 232     </a>
 233   </li>
 234
 235
 236
 237
 238
 239
 240
 241   <li class="md-nav__item">
 242     <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link">
 243       User allocation
 244     </a>
 245   </li>
 246
 247
 248       </ul>
 249     </nav>
 250   </li>
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260   <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 261
 262       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
 263
 264     <label class="md-nav__link" for="nav-4">
 265       Core API
 266     </label>
 267     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
 268       <label class="md-nav__title" for="nav-4">
 269         Core API
 270       </label>
 271       <ul class="md-nav__list" data-md-scrollfix>
 272
 273
 274
 275
 276
 277
 278
 279   <li class="md-nav__item">
 280     <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
 281       FreeType Version
 282     </a>
 283   </li>
 284
 285
 286
 287
 288
 289
 290
 291   <li class="md-nav__item">
 292     <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
 293       Basic Data Types
 294     </a>
 295   </li>
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305   <li class="md-nav__item md-nav__item--active">
 306
 307     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 308
 309
 310
 311
 312       <label class="md-nav__link md-nav__link--active" for="__toc">
 313         Base Interface
 314       </label>
 315
 316     <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link md-nav__link--active">
 317       Base Interface
 318     </a>
 319
 320
 321 <nav class="md-nav md-nav--secondary">
 322
 323
 324
 325
 326
 327     <label class="md-nav__title" for="__toc">Table of contents</label>
 328     <ul class="md-nav__list" data-md-scrollfix>
 329
 330         <li class="md-nav__item">
 331   <a href="#synopsis" class="md-nav__link">
 332     Synopsis
 333   </a>
 334
 335 </li>
 336
 337         <li class="md-nav__item">
 338   <a href="#ft_library" class="md-nav__link">
 339     FT_Library
 340   </a>
 341
 342 </li>
 343
 344         <li class="md-nav__item">
 345   <a href="#ft_face" class="md-nav__link">
 346     FT_Face
 347   </a>
 348
 349 </li>
 350
 351         <li class="md-nav__item">
 352   <a href="#ft_size" class="md-nav__link">
 353     FT_Size
 354   </a>
 355
 356 </li>
 357
 358         <li class="md-nav__item">
 359   <a href="#ft_glyphslot" class="md-nav__link">
 360     FT_GlyphSlot
 361   </a>
 362
 363 </li>
 364
 365         <li class="md-nav__item">
 366   <a href="#ft_charmap" class="md-nav__link">
 367     FT_CharMap
 368   </a>
 369
 370 </li>
 371
 372         <li class="md-nav__item">
 373   <a href="#ft_encoding" class="md-nav__link">
 374     FT_Encoding
 375   </a>
 376
 377 </li>
 378
 379         <li class="md-nav__item">
 380   <a href="#ft_enc_tag" class="md-nav__link">
 381     FT_ENC_TAG
 382   </a>
 383
 384 </li>
 385
 386         <li class="md-nav__item">
 387   <a href="#ft_facerec" class="md-nav__link">
 388     FT_FaceRec
 389   </a>
 390
 391 </li>
 392
 393         <li class="md-nav__item">
 394   <a href="#ft_has_horizontal" class="md-nav__link">
 395     FT_HAS_HORIZONTAL
 396   </a>
 397
 398 </li>
 399
 400         <li class="md-nav__item">
 401   <a href="#ft_has_vertical" class="md-nav__link">
 402     FT_HAS_VERTICAL
 403   </a>
 404
 405 </li>
 406
 407         <li class="md-nav__item">
 408   <a href="#ft_has_kerning" class="md-nav__link">
 409     FT_HAS_KERNING
 410   </a>
 411
 412 </li>
 413
 414         <li class="md-nav__item">
 415   <a href="#ft_has_fixed_sizes" class="md-nav__link">
 416     FT_HAS_FIXED_SIZES
 417   </a>
 418
 419 </li>
 420
 421         <li class="md-nav__item">
 422   <a href="#ft_has_glyph_names" class="md-nav__link">
 423     FT_HAS_GLYPH_NAMES
 424   </a>
 425
 426 </li>
 427
 428         <li class="md-nav__item">
 429   <a href="#ft_has_color" class="md-nav__link">
 430     FT_HAS_COLOR
 431   </a>
 432
 433 </li>
 434
 435         <li class="md-nav__item">
 436   <a href="#ft_has_multiple_masters" class="md-nav__link">
 437     FT_HAS_MULTIPLE_MASTERS
 438   </a>
 439
 440 </li>
 441
 442         <li class="md-nav__item">
 443   <a href="#ft_is_sfnt" class="md-nav__link">
 444     FT_IS_SFNT
 445   </a>
 446
 447 </li>
 448
 449         <li class="md-nav__item">
 450   <a href="#ft_is_scalable" class="md-nav__link">
 451     FT_IS_SCALABLE
 452   </a>
 453
 454 </li>
 455
 456         <li class="md-nav__item">
 457   <a href="#ft_is_fixed_width" class="md-nav__link">
 458     FT_IS_FIXED_WIDTH
 459   </a>
 460
 461 </li>
 462
 463         <li class="md-nav__item">
 464   <a href="#ft_is_cid_keyed" class="md-nav__link">
 465     FT_IS_CID_KEYED
 466   </a>
 467
 468 </li>
 469
 470         <li class="md-nav__item">
 471   <a href="#ft_is_tricky" class="md-nav__link">
 472     FT_IS_TRICKY
 473   </a>
 474
 475 </li>
 476
 477         <li class="md-nav__item">
 478   <a href="#ft_is_named_instance" class="md-nav__link">
 479     FT_IS_NAMED_INSTANCE
 480   </a>
 481
 482 </li>
 483
 484         <li class="md-nav__item">
 485   <a href="#ft_is_variation" class="md-nav__link">
 486     FT_IS_VARIATION
 487   </a>
 488
 489 </li>
 490
 491         <li class="md-nav__item">
 492   <a href="#ft_sizerec" class="md-nav__link">
 493     FT_SizeRec
 494   </a>
 495
 496 </li>
 497
 498         <li class="md-nav__item">
 499   <a href="#ft_size_metrics" class="md-nav__link">
 500     FT_Size_Metrics
 501   </a>
 502
 503 </li>
 504
 505         <li class="md-nav__item">
 506   <a href="#ft_glyphslotrec" class="md-nav__link">
 507     FT_GlyphSlotRec
 508   </a>
 509
 510 </li>
 511
 512         <li class="md-nav__item">
 513   <a href="#ft_glyph_metrics" class="md-nav__link">
 514     FT_Glyph_Metrics
 515   </a>
 516
 517 </li>
 518
 519         <li class="md-nav__item">
 520   <a href="#ft_subglyph" class="md-nav__link">
 521     FT_SubGlyph
 522   </a>
 523
 524 </li>
 525
 526         <li class="md-nav__item">
 527   <a href="#ft_bitmap_size" class="md-nav__link">
 528     FT_Bitmap_Size
 529   </a>
 530
 531 </li>
 532
 533         <li class="md-nav__item">
 534   <a href="#ft_init_freetype" class="md-nav__link">
 535     FT_Init_FreeType
 536   </a>
 537
 538 </li>
 539
 540         <li class="md-nav__item">
 541   <a href="#ft_done_freetype" class="md-nav__link">
 542     FT_Done_FreeType
 543   </a>
 544
 545 </li>
 546
 547         <li class="md-nav__item">
 548   <a href="#ft_new_face" class="md-nav__link">
 549     FT_New_Face
 550   </a>
 551
 552 </li>
 553
 554         <li class="md-nav__item">
 555   <a href="#ft_done_face" class="md-nav__link">
 556     FT_Done_Face
 557   </a>
 558
 559 </li>
 560
 561         <li class="md-nav__item">
 562   <a href="#ft_reference_face" class="md-nav__link">
 563     FT_Reference_Face
 564   </a>
 565
 566 </li>
 567
 568         <li class="md-nav__item">
 569   <a href="#ft_new_memory_face" class="md-nav__link">
 570     FT_New_Memory_Face
 571   </a>
 572
 573 </li>
 574
 575         <li class="md-nav__item">
 576   <a href="#ft_face_properties" class="md-nav__link">
 577     FT_Face_Properties
 578   </a>
 579
 580 </li>
 581
 582         <li class="md-nav__item">
 583   <a href="#ft_open_face" class="md-nav__link">
 584     FT_Open_Face
 585   </a>
 586
 587 </li>
 588
 589         <li class="md-nav__item">
 590   <a href="#ft_open_args" class="md-nav__link">
 591     FT_Open_Args
 592   </a>
 593
 594 </li>
 595
 596         <li class="md-nav__item">
 597   <a href="#ft_parameter" class="md-nav__link">
 598     FT_Parameter
 599   </a>
 600
 601 </li>
 602
 603         <li class="md-nav__item">
 604   <a href="#ft_attach_file" class="md-nav__link">
 605     FT_Attach_File
 606   </a>
 607
 608 </li>
 609
 610         <li class="md-nav__item">
 611   <a href="#ft_attach_stream" class="md-nav__link">
 612     FT_Attach_Stream
 613   </a>
 614
 615 </li>
 616
 617         <li class="md-nav__item">
 618   <a href="#ft_set_char_size" class="md-nav__link">
 619     FT_Set_Char_Size
 620   </a>
 621
 622 </li>
 623
 624         <li class="md-nav__item">
 625   <a href="#ft_set_pixel_sizes" class="md-nav__link">
 626     FT_Set_Pixel_Sizes
 627   </a>
 628
 629 </li>
 630
 631         <li class="md-nav__item">
 632   <a href="#ft_request_size" class="md-nav__link">
 633     FT_Request_Size
 634   </a>
 635
 636 </li>
 637
 638         <li class="md-nav__item">
 639   <a href="#ft_select_size" class="md-nav__link">
 640     FT_Select_Size
 641   </a>
 642
 643 </li>
 644
 645         <li class="md-nav__item">
 646   <a href="#ft_size_request_type" class="md-nav__link">
 647     FT_Size_Request_Type
 648   </a>
 649
 650 </li>
 651
 652         <li class="md-nav__item">
 653   <a href="#ft_size_requestrec" class="md-nav__link">
 654     FT_Size_RequestRec
 655   </a>
 656
 657 </li>
 658
 659         <li class="md-nav__item">
 660   <a href="#ft_size_request" class="md-nav__link">
 661     FT_Size_Request
 662   </a>
 663
 664 </li>
 665
 666         <li class="md-nav__item">
 667   <a href="#ft_set_transform" class="md-nav__link">
 668     FT_Set_Transform
 669   </a>
 670
 671 </li>
 672
 673         <li class="md-nav__item">
 674   <a href="#ft_load_glyph" class="md-nav__link">
 675     FT_Load_Glyph
 676   </a>
 677
 678 </li>
 679
 680         <li class="md-nav__item">
 681   <a href="#ft_get_char_index" class="md-nav__link">
 682     FT_Get_Char_Index
 683   </a>
 684
 685 </li>
 686
 687         <li class="md-nav__item">
 688   <a href="#ft_get_first_char" class="md-nav__link">
 689     FT_Get_First_Char
 690   </a>
 691
 692 </li>
 693
 694         <li class="md-nav__item">
 695   <a href="#ft_get_next_char" class="md-nav__link">
 696     FT_Get_Next_Char
 697   </a>
 698
 699 </li>
 700
 701         <li class="md-nav__item">
 702   <a href="#ft_get_name_index" class="md-nav__link">
 703     FT_Get_Name_Index
 704   </a>
 705
 706 </li>
 707
 708         <li class="md-nav__item">
 709   <a href="#ft_load_char" class="md-nav__link">
 710     FT_Load_Char
 711   </a>
 712
 713 </li>
 714
 715         <li class="md-nav__item">
 716   <a href="#ft_load_target_mode" class="md-nav__link">
 717     FT_LOAD_TARGET_MODE
 718   </a>
 719
 720 </li>
 721
 722         <li class="md-nav__item">
 723   <a href="#ft_render_glyph" class="md-nav__link">
 724     FT_Render_Glyph
 725   </a>
 726
 727 </li>
 728
 729         <li class="md-nav__item">
 730   <a href="#ft_render_mode" class="md-nav__link">
 731     FT_Render_Mode
 732   </a>
 733
 734 </li>
 735
 736         <li class="md-nav__item">
 737   <a href="#ft_get_kerning" class="md-nav__link">
 738     FT_Get_Kerning
 739   </a>
 740
 741 </li>
 742
 743         <li class="md-nav__item">
 744   <a href="#ft_kerning_mode" class="md-nav__link">
 745     FT_Kerning_Mode
 746   </a>
 747
 748 </li>
 749
 750         <li class="md-nav__item">
 751   <a href="#ft_get_track_kerning" class="md-nav__link">
 752     FT_Get_Track_Kerning
 753   </a>
 754
 755 </li>
 756
 757         <li class="md-nav__item">
 758   <a href="#ft_get_glyph_name" class="md-nav__link">
 759     FT_Get_Glyph_Name
 760   </a>
 761
 762 </li>
 763
 764         <li class="md-nav__item">
 765   <a href="#ft_get_postscript_name" class="md-nav__link">
 766     FT_Get_Postscript_Name
 767   </a>
 768
 769 </li>
 770
 771         <li class="md-nav__item">
 772   <a href="#ft_charmaprec" class="md-nav__link">
 773     FT_CharMapRec
 774   </a>
 775
 776 </li>
 777
 778         <li class="md-nav__item">
 779   <a href="#ft_select_charmap" class="md-nav__link">
 780     FT_Select_Charmap
 781   </a>
 782
 783 </li>
 784
 785         <li class="md-nav__item">
 786   <a href="#ft_set_charmap" class="md-nav__link">
 787     FT_Set_Charmap
 788   </a>
 789
 790 </li>
 791
 792         <li class="md-nav__item">
 793   <a href="#ft_get_charmap_index" class="md-nav__link">
 794     FT_Get_Charmap_Index
 795   </a>
 796
 797 </li>
 798
 799         <li class="md-nav__item">
 800   <a href="#ft_get_fstype_flags" class="md-nav__link">
 801     FT_Get_FSType_Flags
 802   </a>
 803
 804 </li>
 805
 806         <li class="md-nav__item">
 807   <a href="#ft_get_subglyph_info" class="md-nav__link">
 808     FT_Get_SubGlyph_Info
 809   </a>
 810
 811 </li>
 812
 813         <li class="md-nav__item">
 814   <a href="#ft_face_internal" class="md-nav__link">
 815     FT_Face_Internal
 816   </a>
 817
 818 </li>
 819
 820         <li class="md-nav__item">
 821   <a href="#ft_size_internal" class="md-nav__link">
 822     FT_Size_Internal
 823   </a>
 824
 825 </li>
 826
 827         <li class="md-nav__item">
 828   <a href="#ft_slot_internal" class="md-nav__link">
 829     FT_Slot_Internal
 830   </a>
 831
 832 </li>
 833
 834         <li class="md-nav__item">
 835   <a href="#ft_face_flag_xxx" class="md-nav__link">
 836     FT_FACE_FLAG_XXX
 837   </a>
 838
 839 </li>
 840
 841         <li class="md-nav__item">
 842   <a href="#ft_style_flag_xxx" class="md-nav__link">
 843     FT_STYLE_FLAG_XXX
 844   </a>
 845
 846 </li>
 847
 848         <li class="md-nav__item">
 849   <a href="#ft_open_xxx" class="md-nav__link">
 850     FT_OPEN_XXX
 851   </a>
 852
 853 </li>
 854
 855         <li class="md-nav__item">
 856   <a href="#ft_load_xxx" class="md-nav__link">
 857     FT_LOAD_XXX
 858   </a>
 859
 860 </li>
 861
 862         <li class="md-nav__item">
 863   <a href="#ft_load_target_xxx" class="md-nav__link">
 864     FT_LOAD_TARGET_XXX
 865   </a>
 866
 867 </li>
 868
 869         <li class="md-nav__item">
 870   <a href="#ft_subglyph_flag_xxx" class="md-nav__link">
 871     FT_SUBGLYPH_FLAG_XXX
 872   </a>
 873
 874 </li>
 875
 876         <li class="md-nav__item">
 877   <a href="#ft_fstype_xxx" class="md-nav__link">
 878     FT_FSTYPE_XXX
 879   </a>
 880
 881 </li>
 882
 883         <li class="md-nav__item">
 884   <a href="#ft_has_fast_glyphs" class="md-nav__link">
 885     FT_HAS_FAST_GLYPHS
 886   </a>
 887
 888 </li>
 889
 890
 891
 892
 893
 894     </ul>
 895
 896 </nav>
 897
 898   </li>
 899
 900
 901
 902
 903
 904
 905
 906   <li class="md-nav__item">
 907     <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
 908       Unicode Variation Sequences
 909     </a>
 910   </li>
 911
 912
 913
 914
 915
 916
 917
 918   <li class="md-nav__item">
 919     <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
 920       Glyph Color Management
 921     </a>
 922   </li>
 923
 924
 925
 926
 927
 928
 929
 930   <li class="md-nav__item">
 931     <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
 932       Glyph Layer Management
 933     </a>
 934   </li>
 935
 936
 937
 938
 939
 940
 941
 942   <li class="md-nav__item">
 943     <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
 944       Glyph Management
 945     </a>
 946   </li>
 947
 948
 949
 950
 951
 952
 953
 954   <li class="md-nav__item">
 955     <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
 956       Mac Specific Interface
 957     </a>
 958   </li>
 959
 960
 961
 962
 963
 964
 965
 966   <li class="md-nav__item">
 967     <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
 968       Size Management
 969     </a>
 970   </li>
 971
 972
 973
 974
 975
 976
 977
 978   <li class="md-nav__item">
 979     <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
 980       Header File Macros
 981     </a>
 982   </li>
 983
 984
 985       </ul>
 986     </nav>
 987   </li>
 988
 989
 990
 991
 992
 993
 994
 995   <li class="md-nav__item md-nav__item--nested">
 996
 997       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
 998
 999     <label class="md-nav__link" for="nav-5">
1000       Format-Specific API
1001     </label>
1002     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1003       <label class="md-nav__title" for="nav-5">
1004         Format-Specific API
1005       </label>
1006       <ul class="md-nav__list" data-md-scrollfix>
1007
1008
1009
1010
1011
1012
1013
1014   <li class="md-nav__item">
1015     <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
1016       Multiple Masters
1017     </a>
1018   </li>
1019
1020
1021
1022
1023
1024
1025
1026   <li class="md-nav__item">
1027     <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
1028       TrueType Tables
1029     </a>
1030   </li>
1031
1032
1033
1034
1035
1036
1037
1038   <li class="md-nav__item">
1039     <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
1040       Type 1 Tables
1041     </a>
1042   </li>
1043
1044
1045
1046
1047
1048
1049
1050   <li class="md-nav__item">
1051     <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
1052       SFNT Names
1053     </a>
1054   </li>
1055
1056
1057
1058
1059
1060
1061
1062   <li class="md-nav__item">
1063     <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
1064       BDF and PCF Files
1065     </a>
1066   </li>
1067
1068
1069
1070
1071
1072
1073
1074   <li class="md-nav__item">
1075     <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
1076       CID Fonts
1077     </a>
1078   </li>
1079
1080
1081
1082
1083
1084
1085
1086   <li class="md-nav__item">
1087     <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
1088       PFR Fonts
1089     </a>
1090   </li>
1091
1092
1093
1094
1095
1096
1097
1098   <li class="md-nav__item">
1099     <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
1100       Window FNT Files
1101     </a>
1102   </li>
1103
1104
1105
1106
1107
1108
1109
1110   <li class="md-nav__item">
1111     <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
1112       Font Formats
1113     </a>
1114   </li>
1115
1116
1117
1118
1119
1120
1121
1122   <li class="md-nav__item">
1123     <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
1124       Gasp Table
1125     </a>
1126   </li>
1127
1128
1129       </ul>
1130     </nav>
1131   </li>
1132
1133
1134
1135
1136
1137
1138
1139   <li class="md-nav__item md-nav__item--nested">
1140
1141       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
1142
1143     <label class="md-nav__link" for="nav-6">
1144       Controlling FreeType Modules
1145     </label>
1146     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1147       <label class="md-nav__title" for="nav-6">
1148         Controlling FreeType Modules
1149       </label>
1150       <ul class="md-nav__list" data-md-scrollfix>
1151
1152
1153
1154
1155
1156
1157
1158   <li class="md-nav__item">
1159     <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
1160       The auto-hinter
1161     </a>
1162   </li>
1163
1164
1165
1166
1167
1168
1169
1170   <li class="md-nav__item">
1171     <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
1172       The CFF driver
1173     </a>
1174   </li>
1175
1176
1177
1178
1179
1180
1181
1182   <li class="md-nav__item">
1183     <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
1184       The Type 1 and CID drivers
1185     </a>
1186   </li>
1187
1188
1189
1190
1191
1192
1193
1194   <li class="md-nav__item">
1195     <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
1196       The TrueType driver
1197     </a>
1198   </li>
1199
1200
1201
1202
1203
1204
1205
1206   <li class="md-nav__item">
1207     <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
1208       The PCF driver
1209     </a>
1210   </li>
1211
1212
1213
1214
1215
1216
1217
1218   <li class="md-nav__item">
1219     <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
1220       Driver properties
1221     </a>
1222   </li>
1223
1224
1225
1226
1227
1228
1229
1230   <li class="md-nav__item">
1231     <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
1232       Parameter Tags
1233     </a>
1234   </li>
1235
1236
1237
1238
1239
1240
1241
1242   <li class="md-nav__item">
1243     <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
1244       Subpixel Rendering
1245     </a>
1246   </li>
1247
1248
1249       </ul>
1250     </nav>
1251   </li>
1252
1253
1254
1255
1256
1257
1258
1259   <li class="md-nav__item md-nav__item--nested">
1260
1261       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
1262
1263     <label class="md-nav__link" for="nav-7">
1264       Cache Sub-System
1265     </label>
1266     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1267       <label class="md-nav__title" for="nav-7">
1268         Cache Sub-System
1269       </label>
1270       <ul class="md-nav__list" data-md-scrollfix>
1271
1272
1273
1274
1275
1276
1277
1278   <li class="md-nav__item">
1279     <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
1280       Cache Sub-System
1281     </a>
1282   </li>
1283
1284
1285       </ul>
1286     </nav>
1287   </li>
1288
1289
1290
1291
1292
1293
1294
1295   <li class="md-nav__item md-nav__item--nested">
1296
1297       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
1298
1299     <label class="md-nav__link" for="nav-8">
1300       Support API
1301     </label>
1302     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1303       <label class="md-nav__title" for="nav-8">
1304         Support API
1305       </label>
1306       <ul class="md-nav__list" data-md-scrollfix>
1307
1308
1309
1310
1311
1312
1313
1314   <li class="md-nav__item">
1315     <a href="ft2-computations.html" title="Computations" class="md-nav__link">
1316       Computations
1317     </a>
1318   </li>
1319
1320
1321
1322
1323
1324
1325
1326   <li class="md-nav__item">
1327     <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
1328       List Processing
1329     </a>
1330   </li>
1331
1332
1333
1334
1335
1336
1337
1338   <li class="md-nav__item">
1339     <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
1340       Outline Processing
1341     </a>
1342   </li>
1343
1344
1345
1346
1347
1348
1349
1350   <li class="md-nav__item">
1351     <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
1352       Quick retrieval of advance values
1353     </a>
1354   </li>
1355
1356
1357
1358
1359
1360
1361
1362   <li class="md-nav__item">
1363     <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
1364       Bitmap Handling
1365     </a>
1366   </li>
1367
1368
1369
1370
1371
1372
1373
1374   <li class="md-nav__item">
1375     <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
1376       Scanline Converter
1377     </a>
1378   </li>
1379
1380
1381
1382
1383
1384
1385
1386   <li class="md-nav__item">
1387     <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
1388       Glyph Stroker
1389     </a>
1390   </li>
1391
1392
1393
1394
1395
1396
1397
1398   <li class="md-nav__item">
1399     <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
1400       System Interface
1401     </a>
1402   </li>
1403
1404
1405
1406
1407
1408
1409
1410   <li class="md-nav__item">
1411     <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
1412       Module Management
1413     </a>
1414   </li>
1415
1416
1417
1418
1419
1420
1421
1422   <li class="md-nav__item">
1423     <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
1424       GZIP Streams
1425     </a>
1426   </li>
1427
1428
1429
1430
1431
1432
1433
1434   <li class="md-nav__item">
1435     <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
1436       LZW Streams
1437     </a>
1438   </li>
1439
1440
1441
1442
1443
1444
1445
1446   <li class="md-nav__item">
1447     <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
1448       BZIP2 Streams
1449     </a>
1450   </li>
1451
1452
1453       </ul>
1454     </nav>
1455   </li>
1456
1457
1458
1459
1460
1461
1462
1463   <li class="md-nav__item md-nav__item--nested">
1464
1465       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
1466
1467     <label class="md-nav__link" for="nav-9">
1468       Error Codes
1469     </label>
1470     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1471       <label class="md-nav__title" for="nav-9">
1472         Error Codes
1473       </label>
1474       <ul class="md-nav__list" data-md-scrollfix>
1475
1476
1477
1478
1479
1480
1481
1482   <li class="md-nav__item">
1483     <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
1484       Error Enumerations
1485     </a>
1486   </li>
1487
1488
1489
1490
1491
1492
1493
1494   <li class="md-nav__item">
1495     <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
1496       Error Code Values
1497     </a>
1498   </li>
1499
1500
1501       </ul>
1502     </nav>
1503   </li>
1504
1505
1506
1507
1508
1509
1510
1511   <li class="md-nav__item md-nav__item--nested">
1512
1513       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
1514
1515     <label class="md-nav__link" for="nav-10">
1516       Miscellaneous
1517     </label>
1518     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1519       <label class="md-nav__title" for="nav-10">
1520         Miscellaneous
1521       </label>
1522       <ul class="md-nav__list" data-md-scrollfix>
1523
1524
1525
1526
1527
1528
1529
1530   <li class="md-nav__item">
1531     <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1532       TrueTypeGX/AAT Validation
1533     </a>
1534   </li>
1535
1536
1537
1538
1539
1540
1541
1542   <li class="md-nav__item">
1543     <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1544       Incremental Loading
1545     </a>
1546   </li>
1547
1548
1549
1550
1551
1552
1553
1554   <li class="md-nav__item">
1555     <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1556       The TrueType Engine
1557     </a>
1558   </li>
1559
1560
1561
1562
1563
1564
1565
1566   <li class="md-nav__item">
1567     <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1568       OpenType Validation
1569     </a>
1570   </li>
1571
1572
1573       </ul>
1574     </nav>
1575   </li>
1576
1577
1578   </ul>
1579 </nav>
1580                   </div>
1581                 </div>
1582               </div>
1583
1584
1585               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1586                 <div class="md-sidebar__scrollwrap">
1587                   <div class="md-sidebar__inner">
1588
1589 <nav class="md-nav md-nav--secondary">
1590
1591
1592
1593
1594
1595     <label class="md-nav__title" for="__toc">Table of contents</label>
1596     <ul class="md-nav__list" data-md-scrollfix>
1597
1598         <li class="md-nav__item">
1599   <a href="#synopsis" class="md-nav__link">
1600     Synopsis
1601   </a>
1602
1603 </li>
1604
1605         <li class="md-nav__item">
1606   <a href="#ft_library" class="md-nav__link">
1607     FT_Library
1608   </a>
1609
1610 </li>
1611
1612         <li class="md-nav__item">
1613   <a href="#ft_face" class="md-nav__link">
1614     FT_Face
1615   </a>
1616
1617 </li>
1618
1619         <li class="md-nav__item">
1620   <a href="#ft_size" class="md-nav__link">
1621     FT_Size
1622   </a>
1623
1624 </li>
1625
1626         <li class="md-nav__item">
1627   <a href="#ft_glyphslot" class="md-nav__link">
1628     FT_GlyphSlot
1629   </a>
1630
1631 </li>
1632
1633         <li class="md-nav__item">
1634   <a href="#ft_charmap" class="md-nav__link">
1635     FT_CharMap
1636   </a>
1637
1638 </li>
1639
1640         <li class="md-nav__item">
1641   <a href="#ft_encoding" class="md-nav__link">
1642     FT_Encoding
1643   </a>
1644
1645 </li>
1646
1647         <li class="md-nav__item">
1648   <a href="#ft_enc_tag" class="md-nav__link">
1649     FT_ENC_TAG
1650   </a>
1651
1652 </li>
1653
1654         <li class="md-nav__item">
1655   <a href="#ft_facerec" class="md-nav__link">
1656     FT_FaceRec
1657   </a>
1658
1659 </li>
1660
1661         <li class="md-nav__item">
1662   <a href="#ft_has_horizontal" class="md-nav__link">
1663     FT_HAS_HORIZONTAL
1664   </a>
1665
1666 </li>
1667
1668         <li class="md-nav__item">
1669   <a href="#ft_has_vertical" class="md-nav__link">
1670     FT_HAS_VERTICAL
1671   </a>
1672
1673 </li>
1674
1675         <li class="md-nav__item">
1676   <a href="#ft_has_kerning" class="md-nav__link">
1677     FT_HAS_KERNING
1678   </a>
1679
1680 </li>
1681
1682         <li class="md-nav__item">
1683   <a href="#ft_has_fixed_sizes" class="md-nav__link">
1684     FT_HAS_FIXED_SIZES
1685   </a>
1686
1687 </li>
1688
1689         <li class="md-nav__item">
1690   <a href="#ft_has_glyph_names" class="md-nav__link">
1691     FT_HAS_GLYPH_NAMES
1692   </a>
1693
1694 </li>
1695
1696         <li class="md-nav__item">
1697   <a href="#ft_has_color" class="md-nav__link">
1698     FT_HAS_COLOR
1699   </a>
1700
1701 </li>
1702
1703         <li class="md-nav__item">
1704   <a href="#ft_has_multiple_masters" class="md-nav__link">
1705     FT_HAS_MULTIPLE_MASTERS
1706   </a>
1707
1708 </li>
1709
1710         <li class="md-nav__item">
1711   <a href="#ft_is_sfnt" class="md-nav__link">
1712     FT_IS_SFNT
1713   </a>
1714
1715 </li>
1716
1717         <li class="md-nav__item">
1718   <a href="#ft_is_scalable" class="md-nav__link">
1719     FT_IS_SCALABLE
1720   </a>
1721
1722 </li>
1723
1724         <li class="md-nav__item">
1725   <a href="#ft_is_fixed_width" class="md-nav__link">
1726     FT_IS_FIXED_WIDTH
1727   </a>
1728
1729 </li>
1730
1731         <li class="md-nav__item">
1732   <a href="#ft_is_cid_keyed" class="md-nav__link">
1733     FT_IS_CID_KEYED
1734   </a>
1735
1736 </li>
1737
1738         <li class="md-nav__item">
1739   <a href="#ft_is_tricky" class="md-nav__link">
1740     FT_IS_TRICKY
1741   </a>
1742
1743 </li>
1744
1745         <li class="md-nav__item">
1746   <a href="#ft_is_named_instance" class="md-nav__link">
1747     FT_IS_NAMED_INSTANCE
1748   </a>
1749
1750 </li>
1751
1752         <li class="md-nav__item">
1753   <a href="#ft_is_variation" class="md-nav__link">
1754     FT_IS_VARIATION
1755   </a>
1756
1757 </li>
1758
1759         <li class="md-nav__item">
1760   <a href="#ft_sizerec" class="md-nav__link">
1761     FT_SizeRec
1762   </a>
1763
1764 </li>
1765
1766         <li class="md-nav__item">
1767   <a href="#ft_size_metrics" class="md-nav__link">
1768     FT_Size_Metrics
1769   </a>
1770
1771 </li>
1772
1773         <li class="md-nav__item">
1774   <a href="#ft_glyphslotrec" class="md-nav__link">
1775     FT_GlyphSlotRec
1776   </a>
1777
1778 </li>
1779
1780         <li class="md-nav__item">
1781   <a href="#ft_glyph_metrics" class="md-nav__link">
1782     FT_Glyph_Metrics
1783   </a>
1784
1785 </li>
1786
1787         <li class="md-nav__item">
1788   <a href="#ft_subglyph" class="md-nav__link">
1789     FT_SubGlyph
1790   </a>
1791
1792 </li>
1793
1794         <li class="md-nav__item">
1795   <a href="#ft_bitmap_size" class="md-nav__link">
1796     FT_Bitmap_Size
1797   </a>
1798
1799 </li>
1800
1801         <li class="md-nav__item">
1802   <a href="#ft_init_freetype" class="md-nav__link">
1803     FT_Init_FreeType
1804   </a>
1805
1806 </li>
1807
1808         <li class="md-nav__item">
1809   <a href="#ft_done_freetype" class="md-nav__link">
1810     FT_Done_FreeType
1811   </a>
1812
1813 </li>
1814
1815         <li class="md-nav__item">
1816   <a href="#ft_new_face" class="md-nav__link">
1817     FT_New_Face
1818   </a>
1819
1820 </li>
1821
1822         <li class="md-nav__item">
1823   <a href="#ft_done_face" class="md-nav__link">
1824     FT_Done_Face
1825   </a>
1826
1827 </li>
1828
1829         <li class="md-nav__item">
1830   <a href="#ft_reference_face" class="md-nav__link">
1831     FT_Reference_Face
1832   </a>
1833
1834 </li>
1835
1836         <li class="md-nav__item">
1837   <a href="#ft_new_memory_face" class="md-nav__link">
1838     FT_New_Memory_Face
1839   </a>
1840
1841 </li>
1842
1843         <li class="md-nav__item">
1844   <a href="#ft_face_properties" class="md-nav__link">
1845     FT_Face_Properties
1846   </a>
1847
1848 </li>
1849
1850         <li class="md-nav__item">
1851   <a href="#ft_open_face" class="md-nav__link">
1852     FT_Open_Face
1853   </a>
1854
1855 </li>
1856
1857         <li class="md-nav__item">
1858   <a href="#ft_open_args" class="md-nav__link">
1859     FT_Open_Args
1860   </a>
1861
1862 </li>
1863
1864         <li class="md-nav__item">
1865   <a href="#ft_parameter" class="md-nav__link">
1866     FT_Parameter
1867   </a>
1868
1869 </li>
1870
1871         <li class="md-nav__item">
1872   <a href="#ft_attach_file" class="md-nav__link">
1873     FT_Attach_File
1874   </a>
1875
1876 </li>
1877
1878         <li class="md-nav__item">
1879   <a href="#ft_attach_stream" class="md-nav__link">
1880     FT_Attach_Stream
1881   </a>
1882
1883 </li>
1884
1885         <li class="md-nav__item">
1886   <a href="#ft_set_char_size" class="md-nav__link">
1887     FT_Set_Char_Size
1888   </a>
1889
1890 </li>
1891
1892         <li class="md-nav__item">
1893   <a href="#ft_set_pixel_sizes" class="md-nav__link">
1894     FT_Set_Pixel_Sizes
1895   </a>
1896
1897 </li>
1898
1899         <li class="md-nav__item">
1900   <a href="#ft_request_size" class="md-nav__link">
1901     FT_Request_Size
1902   </a>
1903
1904 </li>
1905
1906         <li class="md-nav__item">
1907   <a href="#ft_select_size" class="md-nav__link">
1908     FT_Select_Size
1909   </a>
1910
1911 </li>
1912
1913         <li class="md-nav__item">
1914   <a href="#ft_size_request_type" class="md-nav__link">
1915     FT_Size_Request_Type
1916   </a>
1917
1918 </li>
1919
1920         <li class="md-nav__item">
1921   <a href="#ft_size_requestrec" class="md-nav__link">
1922     FT_Size_RequestRec
1923   </a>
1924
1925 </li>
1926
1927         <li class="md-nav__item">
1928   <a href="#ft_size_request" class="md-nav__link">
1929     FT_Size_Request
1930   </a>
1931
1932 </li>
1933
1934         <li class="md-nav__item">
1935   <a href="#ft_set_transform" class="md-nav__link">
1936     FT_Set_Transform
1937   </a>
1938
1939 </li>
1940
1941         <li class="md-nav__item">
1942   <a href="#ft_load_glyph" class="md-nav__link">
1943     FT_Load_Glyph
1944   </a>
1945
1946 </li>
1947
1948         <li class="md-nav__item">
1949   <a href="#ft_get_char_index" class="md-nav__link">
1950     FT_Get_Char_Index
1951   </a>
1952
1953 </li>
1954
1955         <li class="md-nav__item">
1956   <a href="#ft_get_first_char" class="md-nav__link">
1957     FT_Get_First_Char
1958   </a>
1959
1960 </li>
1961
1962         <li class="md-nav__item">
1963   <a href="#ft_get_next_char" class="md-nav__link">
1964     FT_Get_Next_Char
1965   </a>
1966
1967 </li>
1968
1969         <li class="md-nav__item">
1970   <a href="#ft_get_name_index" class="md-nav__link">
1971     FT_Get_Name_Index
1972   </a>
1973
1974 </li>
1975
1976         <li class="md-nav__item">
1977   <a href="#ft_load_char" class="md-nav__link">
1978     FT_Load_Char
1979   </a>
1980
1981 </li>
1982
1983         <li class="md-nav__item">
1984   <a href="#ft_load_target_mode" class="md-nav__link">
1985     FT_LOAD_TARGET_MODE
1986   </a>
1987
1988 </li>
1989
1990         <li class="md-nav__item">
1991   <a href="#ft_render_glyph" class="md-nav__link">
1992     FT_Render_Glyph
1993   </a>
1994
1995 </li>
1996
1997         <li class="md-nav__item">
1998   <a href="#ft_render_mode" class="md-nav__link">
1999     FT_Render_Mode
2000   </a>
2001
2002 </li>
2003
2004         <li class="md-nav__item">
2005   <a href="#ft_get_kerning" class="md-nav__link">
2006     FT_Get_Kerning
2007   </a>
2008
2009 </li>
2010
2011         <li class="md-nav__item">
2012   <a href="#ft_kerning_mode" class="md-nav__link">
2013     FT_Kerning_Mode
2014   </a>
2015
2016 </li>
2017
2018         <li class="md-nav__item">
2019   <a href="#ft_get_track_kerning" class="md-nav__link">
2020     FT_Get_Track_Kerning
2021   </a>
2022
2023 </li>
2024
2025         <li class="md-nav__item">
2026   <a href="#ft_get_glyph_name" class="md-nav__link">
2027     FT_Get_Glyph_Name
2028   </a>
2029
2030 </li>
2031
2032         <li class="md-nav__item">
2033   <a href="#ft_get_postscript_name" class="md-nav__link">
2034     FT_Get_Postscript_Name
2035   </a>
2036
2037 </li>
2038
2039         <li class="md-nav__item">
2040   <a href="#ft_charmaprec" class="md-nav__link">
2041     FT_CharMapRec
2042   </a>
2043
2044 </li>
2045
2046         <li class="md-nav__item">
2047   <a href="#ft_select_charmap" class="md-nav__link">
2048     FT_Select_Charmap
2049   </a>
2050
2051 </li>
2052
2053         <li class="md-nav__item">
2054   <a href="#ft_set_charmap" class="md-nav__link">
2055     FT_Set_Charmap
2056   </a>
2057
2058 </li>
2059
2060         <li class="md-nav__item">
2061   <a href="#ft_get_charmap_index" class="md-nav__link">
2062     FT_Get_Charmap_Index
2063   </a>
2064
2065 </li>
2066
2067         <li class="md-nav__item">
2068   <a href="#ft_get_fstype_flags" class="md-nav__link">
2069     FT_Get_FSType_Flags
2070   </a>
2071
2072 </li>
2073
2074         <li class="md-nav__item">
2075   <a href="#ft_get_subglyph_info" class="md-nav__link">
2076     FT_Get_SubGlyph_Info
2077   </a>
2078
2079 </li>
2080
2081         <li class="md-nav__item">
2082   <a href="#ft_face_internal" class="md-nav__link">
2083     FT_Face_Internal
2084   </a>
2085
2086 </li>
2087
2088         <li class="md-nav__item">
2089   <a href="#ft_size_internal" class="md-nav__link">
2090     FT_Size_Internal
2091   </a>
2092
2093 </li>
2094
2095         <li class="md-nav__item">
2096   <a href="#ft_slot_internal" class="md-nav__link">
2097     FT_Slot_Internal
2098   </a>
2099
2100 </li>
2101
2102         <li class="md-nav__item">
2103   <a href="#ft_face_flag_xxx" class="md-nav__link">
2104     FT_FACE_FLAG_XXX
2105   </a>
2106
2107 </li>
2108
2109         <li class="md-nav__item">
2110   <a href="#ft_style_flag_xxx" class="md-nav__link">
2111     FT_STYLE_FLAG_XXX
2112   </a>
2113
2114 </li>
2115
2116         <li class="md-nav__item">
2117   <a href="#ft_open_xxx" class="md-nav__link">
2118     FT_OPEN_XXX
2119   </a>
2120
2121 </li>
2122
2123         <li class="md-nav__item">
2124   <a href="#ft_load_xxx" class="md-nav__link">
2125     FT_LOAD_XXX
2126   </a>
2127
2128 </li>
2129
2130         <li class="md-nav__item">
2131   <a href="#ft_load_target_xxx" class="md-nav__link">
2132     FT_LOAD_TARGET_XXX
2133   </a>
2134
2135 </li>
2136
2137         <li class="md-nav__item">
2138   <a href="#ft_subglyph_flag_xxx" class="md-nav__link">
2139     FT_SUBGLYPH_FLAG_XXX
2140   </a>
2141
2142 </li>
2143
2144         <li class="md-nav__item">
2145   <a href="#ft_fstype_xxx" class="md-nav__link">
2146     FT_FSTYPE_XXX
2147   </a>
2148
2149 </li>
2150
2151         <li class="md-nav__item">
2152   <a href="#ft_has_fast_glyphs" class="md-nav__link">
2153     FT_HAS_FAST_GLYPHS
2154   </a>
2155
2156 </li>
2157
2158
2159
2160
2161
2162     </ul>
2163
2164 </nav>
2165                   </div>
2166                 </div>
2167               </div>
2168
2169
2170           <div class="md-content">
2171             <article class="md-content__inner md-typeset">
2172
2173
2174
2175                 <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; Base Interface</p>
2176 <hr />
2177 <h1 id="base-interface">Base Interface<a class="headerlink" href="#base-interface" title="Permanent link">&para;</a></h1>
2178 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
2179 <p>This section describes the most important public high-level API functions of FreeType&nbsp;2.</p>
2180 <h2 id="ft_library">FT_Library<a class="headerlink" href="#ft_library" title="Permanent link">&para;</a></h2>
2181 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2182 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_LibraryRec_  *<b>FT_Library</b>;
2183 </code></pre></div>
2184
2185 <p>A handle to a FreeType library instance. Each &lsquo;library&rsquo; is completely independent from the others; it is the &lsquo;root&rsquo; of a set of objects like fonts, faces, sizes, etc.</p>
2186 <p>It also embeds a memory manager (see <code><a href="ft2-system_interface.html#ft_memory">FT_Memory</a></code>), as well as a scan-line converter object (see <code><a href="ft2-raster.html#ft_raster">FT_Raster</a></code>).</p>
2187 <p>[Since 2.5.6] In multi-threaded applications it is easiest to use one <code>FT_Library</code> object per thread. In case this is too cumbersome, a single <code>FT_Library</code> object across threads is possible also, as long as a mutex lock is used around <code><a href="ft2-base_interface.html#ft_new_face">FT_New_Face</a></code> and <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code>.</p>
2188 <h4>note</h4>
2189
2190 <p>Library objects are normally created by <code><a href="ft2-base_interface.html#ft_init_freetype">FT_Init_FreeType</a></code>, and destroyed with <code><a href="ft2-base_interface.html#ft_done_freetype">FT_Done_FreeType</a></code>. If you need reference-counting (cf. <code><a href="ft2-module_management.html#ft_reference_library">FT_Reference_Library</a></code>), use <code><a href="ft2-module_management.html#ft_new_library">FT_New_Library</a></code> and <code><a href="ft2-module_management.html#ft_done_library">FT_Done_Library</a></code>.</p>
2191 <hr>
2192
2193 <h2 id="ft_face">FT_Face<a class="headerlink" href="#ft_face" title="Permanent link">&para;</a></h2>
2194 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2195 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_FaceRec_*  <b>FT_Face</b>;
2196 </code></pre></div>
2197
2198 <p>A handle to a typographic face object. A face object models a given typeface, in a given style.</p>
2199 <h4>note</h4>
2200
2201 <p>A face object also owns a single <code><a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a></code> object, as well as one or more <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> objects.</p>
2202 <p>Use <code><a href="ft2-base_interface.html#ft_new_face">FT_New_Face</a></code> or <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> to create a new face object from a given filepath or a custom input stream.</p>
2203 <p>Use <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code> to destroy it (along with its slot and sizes).</p>
2204 <p>An <code>FT_Face</code> object can only be safely used from one thread at a time. Similarly, creation and destruction of <code>FT_Face</code> with the same <code><a href="ft2-base_interface.html#ft_library">FT_Library</a></code> object can only be done from one thread at a time. On the other hand, functions like <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> and its siblings are thread-safe and do not need the lock to be held as long as the same <code>FT_Face</code> object is not used from multiple threads at the same time.</p>
2205 <h4>also</h4>
2206
2207 <p>See <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> for the publicly accessible fields of a given face object.</p>
2208 <hr>
2209
2210 <h2 id="ft_size">FT_Size<a class="headerlink" href="#ft_size" title="Permanent link">&para;</a></h2>
2211 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2212 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_SizeRec_*  <b>FT_Size</b>;
2213 </code></pre></div>
2214
2215 <p>A handle to an object that models a face scaled to a given character size.</p>
2216 <h4>note</h4>
2217
2218 <p>An <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> has one <em>active</em> <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object that is used by functions like <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> to determine the scaling transformation that in turn is used to load and hint glyphs and metrics.</p>
2219 <p>You can use <code><a href="ft2-base_interface.html#ft_set_char_size">FT_Set_Char_Size</a></code>, <code><a href="ft2-base_interface.html#ft_set_pixel_sizes">FT_Set_Pixel_Sizes</a></code>, <code><a href="ft2-base_interface.html#ft_request_size">FT_Request_Size</a></code> or even <code><a href="ft2-base_interface.html#ft_select_size">FT_Select_Size</a></code> to change the content (i.e., the scaling values) of the active <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code>.</p>
2220 <p>You can use <code><a href="ft2-sizes_management.html#ft_new_size">FT_New_Size</a></code> to create additional size objects for a given <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code>, but they won't be used by other functions until you activate it through <code><a href="ft2-sizes_management.html#ft_activate_size">FT_Activate_Size</a></code>. Only one size can be activated at any given time per face.</p>
2221 <h4>also</h4>
2222
2223 <p>See <code><a href="ft2-base_interface.html#ft_sizerec">FT_SizeRec</a></code> for the publicly accessible fields of a given size object.</p>
2224 <hr>
2225
2226 <h2 id="ft_glyphslot">FT_GlyphSlot<a class="headerlink" href="#ft_glyphslot" title="Permanent link">&para;</a></h2>
2227 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2228 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_GlyphSlotRec_*  <b>FT_GlyphSlot</b>;
2229 </code></pre></div>
2230
2231 <p>A handle to a given &lsquo;glyph slot&rsquo;. A slot is a container that can hold any of the glyphs contained in its parent face.</p>
2232 <p>In other words, each time you call <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> or <code><a href="ft2-base_interface.html#ft_load_char">FT_Load_Char</a></code>, the slot's content is erased by the new glyph data, i.e., the glyph's metrics, its image (bitmap or outline), and other control information.</p>
2233 <h4>also</h4>
2234
2235 <p>See <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> for the publicly accessible glyph fields.</p>
2236 <hr>
2237
2238 <h2 id="ft_charmap">FT_CharMap<a class="headerlink" href="#ft_charmap" title="Permanent link">&para;</a></h2>
2239 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2240 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_CharMapRec_*  <b>FT_CharMap</b>;
2241 </code></pre></div>
2242
2243 <p>A handle to a character map (usually abbreviated to &lsquo;charmap&rsquo;). A charmap is used to translate character codes in a given encoding into glyph indexes for its parent's face. Some font formats may provide several charmaps per font.</p>
2244 <p>Each face object owns zero or more charmaps, but only one of them can be &lsquo;active&rsquo;, providing the data used by <code><a href="ft2-base_interface.html#ft_get_char_index">FT_Get_Char_Index</a></code> or <code><a href="ft2-base_interface.html#ft_load_char">FT_Load_Char</a></code>.</p>
2245 <p>The list of available charmaps in a face is available through the <code>face-&gt;num_charmaps</code> and <code>face-&gt;charmaps</code> fields of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code>.</p>
2246 <p>The currently active charmap is available as <code>face-&gt;charmap</code>. You should call <code><a href="ft2-base_interface.html#ft_set_charmap">FT_Set_Charmap</a></code> to change it.</p>
2247 <h4>note</h4>
2248
2249 <p>When a new face is created (either through <code><a href="ft2-base_interface.html#ft_new_face">FT_New_Face</a></code> or <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code>), the library looks for a Unicode charmap within the list and automatically activates it. If there is no Unicode charmap, FreeType doesn't set an &lsquo;active&rsquo; charmap.</p>
2250 <h4>also</h4>
2251
2252 <p>See <code><a href="ft2-base_interface.html#ft_charmaprec">FT_CharMapRec</a></code> for the publicly accessible fields of a given character map.</p>
2253 <hr>
2254
2255 <h2 id="ft_encoding">FT_Encoding<a class="headerlink" href="#ft_encoding" title="Permanent link">&para;</a></h2>
2256 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2257 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Encoding_
2258   {
2259     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_none">FT_ENCODING_NONE</a>, 0, 0, 0, 0 ),
2260
2261     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_ms_symbol">FT_ENCODING_MS_SYMBOL</a>, 's', 'y', 'm', 'b' ),
2262     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_unicode">FT_ENCODING_UNICODE</a>,   'u', 'n', 'i', 'c' ),
2263
2264     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_sjis">FT_ENCODING_SJIS</a>,    's', 'j', 'i', 's' ),
2265     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_prc">FT_ENCODING_PRC</a>,     'g', 'b', ' ', ' ' ),
2266     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_big5">FT_ENCODING_BIG5</a>,    'b', 'i', 'g', '5' ),
2267     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_wansung">FT_ENCODING_WANSUNG</a>, 'w', 'a', 'n', 's' ),
2268     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_johab">FT_ENCODING_JOHAB</a>,   'j', 'o', 'h', 'a' ),
2269
2270     /* for backward compatibility */
2271     FT_ENCODING_GB2312     = <a href="ft2-base_interface.html#ft_encoding_prc">FT_ENCODING_PRC</a>,
2272     <a href="ft2-base_interface.html#ft_encoding_ms_sjis">FT_ENCODING_MS_SJIS</a>    = <a href="ft2-base_interface.html#ft_encoding_sjis">FT_ENCODING_SJIS</a>,
2273     <a href="ft2-base_interface.html#ft_encoding_ms_gb2312">FT_ENCODING_MS_GB2312</a>  = <a href="ft2-base_interface.html#ft_encoding_prc">FT_ENCODING_PRC</a>,
2274     <a href="ft2-base_interface.html#ft_encoding_ms_big5">FT_ENCODING_MS_BIG5</a>    = <a href="ft2-base_interface.html#ft_encoding_big5">FT_ENCODING_BIG5</a>,
2275     <a href="ft2-base_interface.html#ft_encoding_ms_wansung">FT_ENCODING_MS_WANSUNG</a> = <a href="ft2-base_interface.html#ft_encoding_wansung">FT_ENCODING_WANSUNG</a>,
2276     <a href="ft2-base_interface.html#ft_encoding_ms_johab">FT_ENCODING_MS_JOHAB</a>   = <a href="ft2-base_interface.html#ft_encoding_johab">FT_ENCODING_JOHAB</a>,
2277
2278     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_adobe_standard">FT_ENCODING_ADOBE_STANDARD</a>, 'A', 'D', 'O', 'B' ),
2279     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_adobe_expert">FT_ENCODING_ADOBE_EXPERT</a>,   'A', 'D', 'B', 'E' ),
2280     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_adobe_custom">FT_ENCODING_ADOBE_CUSTOM</a>,   'A', 'D', 'B', 'C' ),
2281     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_adobe_latin_1">FT_ENCODING_ADOBE_LATIN_1</a>,  'l', 'a', 't', '1' ),
2282
2283     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_old_latin_2">FT_ENCODING_OLD_LATIN_2</a>, 'l', 'a', 't', '2' ),
2284
2285     <a href="ft2-base_interface.html#ft_enc_tag">FT_ENC_TAG</a>( <a href="ft2-base_interface.html#ft_encoding_apple_roman">FT_ENCODING_APPLE_ROMAN</a>, 'a', 'r', 'm', 'n' )
2286
2287   } <b>FT_Encoding</b>;
2288
2289
2290   /* these constants are deprecated; use the corresponding `<b>FT_Encoding</b>` */
2291   /* values instead                                                      */
2292 #<span class="keyword">define</span> ft_encoding_none            <a href="ft2-base_interface.html#ft_encoding_none">FT_ENCODING_NONE</a>
2293 #<span class="keyword">define</span> ft_encoding_unicode         <a href="ft2-base_interface.html#ft_encoding_unicode">FT_ENCODING_UNICODE</a>
2294 #<span class="keyword">define</span> ft_encoding_symbol          <a href="ft2-base_interface.html#ft_encoding_ms_symbol">FT_ENCODING_MS_SYMBOL</a>
2295 #<span class="keyword">define</span> ft_encoding_latin_1         <a href="ft2-base_interface.html#ft_encoding_adobe_latin_1">FT_ENCODING_ADOBE_LATIN_1</a>
2296 #<span class="keyword">define</span> ft_encoding_latin_2         <a href="ft2-base_interface.html#ft_encoding_old_latin_2">FT_ENCODING_OLD_LATIN_2</a>
2297 #<span class="keyword">define</span> ft_encoding_sjis            <a href="ft2-base_interface.html#ft_encoding_sjis">FT_ENCODING_SJIS</a>
2298 #<span class="keyword">define</span> ft_encoding_gb2312          <a href="ft2-base_interface.html#ft_encoding_prc">FT_ENCODING_PRC</a>
2299 #<span class="keyword">define</span> ft_encoding_big5            <a href="ft2-base_interface.html#ft_encoding_big5">FT_ENCODING_BIG5</a>
2300 #<span class="keyword">define</span> ft_encoding_wansung         <a href="ft2-base_interface.html#ft_encoding_wansung">FT_ENCODING_WANSUNG</a>
2301 #<span class="keyword">define</span> ft_encoding_johab           <a href="ft2-base_interface.html#ft_encoding_johab">FT_ENCODING_JOHAB</a>
2302
2303 #<span class="keyword">define</span> ft_encoding_adobe_standard  <a href="ft2-base_interface.html#ft_encoding_adobe_standard">FT_ENCODING_ADOBE_STANDARD</a>
2304 #<span class="keyword">define</span> ft_encoding_adobe_expert    <a href="ft2-base_interface.html#ft_encoding_adobe_expert">FT_ENCODING_ADOBE_EXPERT</a>
2305 #<span class="keyword">define</span> ft_encoding_adobe_custom    <a href="ft2-base_interface.html#ft_encoding_adobe_custom">FT_ENCODING_ADOBE_CUSTOM</a>
2306 #<span class="keyword">define</span> ft_encoding_apple_roman     <a href="ft2-base_interface.html#ft_encoding_apple_roman">FT_ENCODING_APPLE_ROMAN</a>
2307 </code></pre></div>
2308
2309 <p>An enumeration to specify character sets supported by charmaps. Used in the <code><a href="ft2-base_interface.html#ft_select_charmap">FT_Select_Charmap</a></code> API function.</p>
2310 <h4>note</h4>
2311
2312 <p>Despite the name, this enumeration lists specific character repertories (i.e., charsets), and not text encoding methods (e.g., UTF-8, UTF-16, etc.).</p>
2313 <p>Other encodings might be defined in the future.</p>
2314 <h4>values</h4>
2315
2316 <table class="fields long">
2317 <tr><td class="val" id="ft_encoding_none">FT_ENCODING_NONE</td><td class="desc">
2318 <p>The encoding value&nbsp;0 is reserved for all formats except BDF, PCF, and Windows FNT; see below for more information.</p>
2319 </td></tr>
2320 <tr><td class="val" id="ft_encoding_unicode">FT_ENCODING_UNICODE</td><td class="desc">
2321 <p>The Unicode character set. This value covers all versions of the Unicode repertoire, including ASCII and Latin-1. Most fonts include a Unicode charmap, but not all of them.</p>
2322 <p>For example, if you want to access Unicode value U+1F028 (and the font contains it), use value 0x1F028 as the input value for <code><a href="ft2-base_interface.html#ft_get_char_index">FT_Get_Char_Index</a></code>.</p>
2323 </td></tr>
2324 <tr><td class="val" id="ft_encoding_ms_symbol">FT_ENCODING_MS_SYMBOL</td><td class="desc">
2325 <p>Microsoft Symbol encoding, used to encode mathematical symbols and wingdings. For more information, see &lsquo;<a href="https://www.microsoft.com/typography/otspec/recom.htm#non-standard-symbol-fonts">https://www.microsoft.com/typography/otspec/recom.htm#non-standard-symbol-fonts</a>&rsquo;, &lsquo;<a href="http://www.kostis.net/charsets/symbol.htm">http://www.kostis.net/charsets/symbol.htm</a>&rsquo;, and &lsquo;<a href="http://www.kostis.net/charsets/wingding.htm">http://www.kostis.net/charsets/wingding.htm</a>&rsquo;.</p>
2326 <p>This encoding uses character codes from the PUA (Private Unicode Area) in the range U+F020-U+F0FF.</p>
2327 </td></tr>
2328 <tr><td class="val" id="ft_encoding_sjis">FT_ENCODING_SJIS</td><td class="desc">
2329 <p>Shift JIS encoding for Japanese. More info at &lsquo;<a href="https://en.wikipedia.org/wiki/Shift_JIS">https://en.wikipedia.org/wiki/Shift_JIS</a>&rsquo;. See note on multi-byte encodings below.</p>
2330 </td></tr>
2331 <tr><td class="val" id="ft_encoding_prc">FT_ENCODING_PRC</td><td class="desc">
2332 <p>Corresponds to encoding systems mainly for Simplified Chinese as used in People's Republic of China (PRC). The encoding layout is based on GB&nbsp;2312 and its supersets GBK and GB&nbsp;18030.</p>
2333 </td></tr>
2334 <tr><td class="val" id="ft_encoding_big5">FT_ENCODING_BIG5</td><td class="desc">
2335 <p>Corresponds to an encoding system for Traditional Chinese as used in Taiwan and Hong Kong.</p>
2336 </td></tr>
2337 <tr><td class="val" id="ft_encoding_wansung">FT_ENCODING_WANSUNG</td><td class="desc">
2338 <p>Corresponds to the Korean encoding system known as Extended Wansung (MS Windows code page 949). For more information see &lsquo;<a href="https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt">https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt</a>&rsquo;.</p>
2339 </td></tr>
2340 <tr><td class="val" id="ft_encoding_johab">FT_ENCODING_JOHAB</td><td class="desc">
2341 <p>The Korean standard character set (KS&nbsp;C 5601-1992), which corresponds to MS Windows code page 1361. This character set includes all possible Hangul character combinations.</p>
2342 </td></tr>
2343 <tr><td class="val" id="ft_encoding_adobe_latin_1">FT_ENCODING_ADOBE_LATIN_1</td><td class="desc">
2344 <p>Corresponds to a Latin-1 encoding as defined in a Type&nbsp;1 PostScript font. It is limited to 256 character codes.</p>
2345 </td></tr>
2346 <tr><td class="val" id="ft_encoding_adobe_standard">FT_ENCODING_ADOBE_STANDARD</td><td class="desc">
2347 <p>Adobe Standard encoding, as found in Type&nbsp;1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes.</p>
2348 </td></tr>
2349 <tr><td class="val" id="ft_encoding_adobe_expert">FT_ENCODING_ADOBE_EXPERT</td><td class="desc">
2350 <p>Adobe Expert encoding, as found in Type&nbsp;1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes.</p>
2351 </td></tr>
2352 <tr><td class="val" id="ft_encoding_adobe_custom">FT_ENCODING_ADOBE_CUSTOM</td><td class="desc">
2353 <p>Corresponds to a custom encoding, as found in Type&nbsp;1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes.</p>
2354 </td></tr>
2355 <tr><td class="val" id="ft_encoding_apple_roman">FT_ENCODING_APPLE_ROMAN</td><td class="desc">
2356 <p>Apple roman encoding. Many TrueType and OpenType fonts contain a charmap for this 8-bit encoding, since older versions of Mac OS are able to use it.</p>
2357 </td></tr>
2358 <tr><td class="val" id="ft_encoding_old_latin_2">FT_ENCODING_OLD_LATIN_2</td><td class="desc">
2359 <p>This value is deprecated and was neither used nor reported by FreeType. Don't use or test for it.</p>
2360 </td></tr>
2361 <tr><td class="val" id="ft_encoding_ms_sjis">FT_ENCODING_MS_SJIS</td><td class="desc">
2362 <p>Same as FT_ENCODING_SJIS. Deprecated.</p>
2363 </td></tr>
2364 <tr><td class="val" id="ft_encoding_ms_gb2312">FT_ENCODING_MS_GB2312</td><td class="desc">
2365 <p>Same as FT_ENCODING_PRC. Deprecated.</p>
2366 </td></tr>
2367 <tr><td class="val" id="ft_encoding_ms_big5">FT_ENCODING_MS_BIG5</td><td class="desc">
2368 <p>Same as FT_ENCODING_BIG5. Deprecated.</p>
2369 </td></tr>
2370 <tr><td class="val" id="ft_encoding_ms_wansung">FT_ENCODING_MS_WANSUNG</td><td class="desc">
2371 <p>Same as FT_ENCODING_WANSUNG. Deprecated.</p>
2372 </td></tr>
2373 <tr><td class="val" id="ft_encoding_ms_johab">FT_ENCODING_MS_JOHAB</td><td class="desc">
2374 <p>Same as FT_ENCODING_JOHAB. Deprecated.</p>
2375 </td></tr>
2376 </table>
2377
2378 <h4>note</h4>
2379
2380 <p>By default, FreeType enables a Unicode charmap and tags it with <code>FT_ENCODING_UNICODE</code> when it is either provided or can be generated from PostScript glyph name dictionaries in the font file. All other encodings are considered legacy and tagged only if explicitly defined in the font file. Otherwise, <code>FT_ENCODING_NONE</code> is used.</p>
2381 <p><code>FT_ENCODING_NONE</code> is set by the BDF and PCF drivers if the charmap is neither Unicode nor ISO-8859-1 (otherwise it is set to <code>FT_ENCODING_UNICODE</code>). Use <code><a href="ft2-bdf_fonts.html#ft_get_bdf_charset_id">FT_Get_BDF_Charset_ID</a></code> to find out which encoding is really present. If, for example, the <code>cs_registry</code> field is &lsquo;KOI8&rsquo; and the <code>cs_encoding</code> field is &lsquo;R&rsquo;, the font is encoded in KOI8-R.</p>
2382 <p><code>FT_ENCODING_NONE</code> is always set (with a single exception) by the winfonts driver. Use <code><a href="ft2-winfnt_fonts.html#ft_get_winfnt_header">FT_Get_WinFNT_Header</a></code> and examine the <code>charset</code> field of the <code><a href="ft2-winfnt_fonts.html#ft_winfnt_headerrec">FT_WinFNT_HeaderRec</a></code> structure to find out which encoding is really present. For example, <code><a href="ft2-winfnt_fonts.html#ft_winfnt_id_xxx">FT_WinFNT_ID_CP1251</a></code> (204) means Windows code page 1251 (for Russian).</p>
2383 <p><code>FT_ENCODING_NONE</code> is set if <code>platform_id</code> is <code><a href="ft2-truetype_tables.html#tt_platform_xxx">TT_PLATFORM_MACINTOSH</a></code> and <code>encoding_id</code> is not <code>TT_MAC_ID_ROMAN</code> (otherwise it is set to <code>FT_ENCODING_APPLE_ROMAN</code>).</p>
2384 <p>If <code>platform_id</code> is <code><a href="ft2-truetype_tables.html#tt_platform_xxx">TT_PLATFORM_MACINTOSH</a></code>, use the function <code><a href="ft2-truetype_tables.html#ft_get_cmap_language_id">FT_Get_CMap_Language_ID</a></code> to query the Mac language ID that may be needed to be able to distinguish Apple encoding variants. See</p>
2385 <p><a href="https://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt">https://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt</a></p>
2386 <p>to get an idea how to do that. Basically, if the language ID is&nbsp;0, don't use it, otherwise subtract 1 from the language ID. Then examine <code>encoding_id</code>. If, for example, <code>encoding_id</code> is <code>TT_MAC_ID_ROMAN</code> and the language ID (minus&nbsp;1) is <code>TT_MAC_LANGID_GREEK</code>, it is the Greek encoding, not Roman. <code>TT_MAC_ID_ARABIC</code> with <code>TT_MAC_LANGID_FARSI</code> means the Farsi variant the Arabic encoding.</p>
2387 <hr>
2388
2389 <h2 id="ft_enc_tag">FT_ENC_TAG<a class="headerlink" href="#ft_enc_tag" title="Permanent link">&para;</a></h2>
2390 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2391 <div class = "codehilite"><pre><code>#<span class="keyword">ifndef</span> <b>FT_ENC_TAG</b>
2392 #<span class="keyword">define</span> <b>FT_ENC_TAG</b>( value, a, b, c, d )         \
2393           value = ( ( (<a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>)(a) &lt;&lt; 24 ) |  \
2394                     ( (<a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>)(b) &lt;&lt; 16 ) |  \
2395                     ( (<a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>)(c) &lt;&lt;  8 ) |  \
2396                       (<a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>)(d)         )
2397
2398 #<span class="keyword">endif</span> /* <b>FT_ENC_TAG</b> */
2399 </code></pre></div>
2400
2401 <p>This macro converts four-letter tags into an unsigned long. It is used to define &lsquo;encoding&rsquo; identifiers (see <code><a href="ft2-base_interface.html#ft_encoding">FT_Encoding</a></code>).</p>
2402 <h4>note</h4>
2403
2404 <p>Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this:
2405 <div class="highlight"><pre><span></span><code>  #define FT_ENC_TAG( value, a, b, c, d )  value
2406 </code></pre></div></p>
2407 <p>to get a simple enumeration without assigning special numbers.</p>
2408 <hr>
2409
2410 <h2 id="ft_facerec">FT_FaceRec<a class="headerlink" href="#ft_facerec" title="Permanent link">&para;</a></h2>
2411 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2412 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_FaceRec_
2413   {
2414     <a href="ft2-basic_types.html#ft_long">FT_Long</a>           num_faces;
2415     <a href="ft2-basic_types.html#ft_long">FT_Long</a>           face_index;
2416
2417     <a href="ft2-basic_types.html#ft_long">FT_Long</a>           face_flags;
2418     <a href="ft2-basic_types.html#ft_long">FT_Long</a>           style_flags;
2419
2420     <a href="ft2-basic_types.html#ft_long">FT_Long</a>           num_glyphs;
2421
2422     <a href="ft2-basic_types.html#ft_string">FT_String</a>*        family_name;
2423     <a href="ft2-basic_types.html#ft_string">FT_String</a>*        style_name;
2424
2425     <a href="ft2-basic_types.html#ft_int">FT_Int</a>            num_fixed_sizes;
2426     <a href="ft2-base_interface.html#ft_bitmap_size">FT_Bitmap_Size</a>*   available_sizes;
2427
2428     <a href="ft2-basic_types.html#ft_int">FT_Int</a>            num_charmaps;
2429     <a href="ft2-base_interface.html#ft_charmap">FT_CharMap</a>*       charmaps;
2430
2431     <a href="ft2-basic_types.html#ft_generic">FT_Generic</a>        generic;
2432
2433     /*# The following member variables (down to `underline_thickness`) */
2434     /*# are only relevant to scalable outlines; cf. @<a href="ft2-base_interface.html#ft_bitmap_size">FT_Bitmap_Size</a>    */
2435     /*# for bitmap fonts.                                              */
2436     <a href="ft2-basic_types.html#ft_bbox">FT_BBox</a>           bbox;
2437
2438     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>         units_per_EM;
2439     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          ascender;
2440     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          descender;
2441     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          height;
2442
2443     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          max_advance_width;
2444     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          max_advance_height;
2445
2446     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          underline_position;
2447     <a href="ft2-basic_types.html#ft_short">FT_Short</a>          underline_thickness;
2448
2449     <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a>      glyph;
2450     <a href="ft2-base_interface.html#ft_size">FT_Size</a>           size;
2451     <a href="ft2-base_interface.html#ft_charmap">FT_CharMap</a>        charmap;
2452
2453     /*@private begin */
2454
2455     <a href="ft2-module_management.html#ft_driver">FT_Driver</a>         driver;
2456     <a href="ft2-system_interface.html#ft_memory">FT_Memory</a>         memory;
2457     <a href="ft2-system_interface.html#ft_stream">FT_Stream</a>         stream;
2458
2459     <a href="ft2-list_processing.html#ft_listrec">FT_ListRec</a>        sizes_list;
2460
2461     <a href="ft2-basic_types.html#ft_generic">FT_Generic</a>        autohint;   /* face-specific auto-hinter data */
2462     <span class="keyword">void</span>*             extensions; /* unused                         */
2463
2464     <a href="ft2-base_interface.html#ft_face_internal">FT_Face_Internal</a>  internal;
2465
2466     /*@private end */
2467
2468   } <b>FT_FaceRec</b>;
2469 </code></pre></div>
2470
2471 <p>FreeType root face class structure. A face object models a typeface in a font file.</p>
2472 <h4>fields</h4>
2473
2474 <table class="fields">
2475 <tr><td class="val" id="num_faces">num_faces</td><td class="desc">
2476 <p>The number of faces in the font file. Some font formats can have multiple faces in a single font file.</p>
2477 </td></tr>
2478 <tr><td class="val" id="face_index">face_index</td><td class="desc">
2479 <p>This field holds two different values. Bits 0-15 are the index of the face in the font file (starting with value&nbsp;0). They are set to&nbsp;0 if there is only one face in the font file.</p>
2480 <p>[Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation fonts only, holding the named instance index for the current face index (starting with value&nbsp;1; value&nbsp;0 indicates font access without a named instance). For non-variation fonts, bits 16-30 are ignored. If we have the third named instance of face&nbsp;4, say, <code>face_index</code> is set to 0x00030004.</p>
2481 <p>Bit 31 is always zero (this is, <code>face_index</code> is always a positive value).</p>
2482 <p>[Since 2.9] Changing the design coordinates with <code><a href="ft2-multiple_masters.html#ft_set_var_design_coordinates">FT_Set_Var_Design_Coordinates</a></code> or <code><a href="ft2-multiple_masters.html#ft_set_var_blend_coordinates">FT_Set_Var_Blend_Coordinates</a></code> does not influence the named instance index value (only <code><a href="ft2-multiple_masters.html#ft_set_named_instance">FT_Set_Named_Instance</a></code> does that).</p>
2483 </td></tr>
2484 <tr><td class="val" id="face_flags">face_flags</td><td class="desc">
2485 <p>A set of bit flags that give important information about the face; see <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_XXX</a></code> for the details.</p>
2486 </td></tr>
2487 <tr><td class="val" id="style_flags">style_flags</td><td class="desc">
2488 <p>The lower 16&nbsp;bits contain a set of bit flags indicating the style of the face; see <code><a href="ft2-base_interface.html#ft_style_flag_xxx">FT_STYLE_FLAG_XXX</a></code> for the details.</p>
2489 <p>[Since 2.6.1] Bits 16-30 hold the number of named instances available for the current face if we have a GX or OpenType variation (sub)font. Bit 31 is always zero (this is, <code>style_flags</code> is always a positive value). Note that a variation font has always at least one named instance, namely the default instance.</p>
2490 </td></tr>
2491 <tr><td class="val" id="num_glyphs">num_glyphs</td><td class="desc">
2492 <p>The number of glyphs in the face. If the face is scalable and has sbits (see <code>num_fixed_sizes</code>), it is set to the number of outline glyphs.</p>
2493 <p>For CID-keyed fonts (not in an SFNT wrapper) this value gives the highest CID used in the font.</p>
2494 </td></tr>
2495 <tr><td class="val" id="family_name">family_name</td><td class="desc">
2496 <p>The face's family name. This is an ASCII string, usually in English, that describes the typeface's family (like &lsquo;Times New Roman&rsquo;, &lsquo;Bodoni&rsquo;, &lsquo;Garamond&rsquo;, etc). This is a least common denominator used to list fonts. Some formats (TrueType &amp; OpenType) provide localized and Unicode versions of this string. Applications should use the format-specific interface to access them. Can be <code>NULL</code> (e.g., in fonts embedded in a PDF file).</p>
2497 <p>In case the font doesn't provide a specific family name entry, FreeType tries to synthesize one, deriving it from other name entries.</p>
2498 </td></tr>
2499 <tr><td class="val" id="style_name">style_name</td><td class="desc">
2500 <p>The face's style name. This is an ASCII string, usually in English, that describes the typeface's style (like &lsquo;Italic&rsquo;, &lsquo;Bold&rsquo;, &lsquo;Condensed&rsquo;, etc). Not all font formats provide a style name, so this field is optional, and can be set to <code>NULL</code>. As for <code>family_name</code>, some formats provide localized and Unicode versions of this string. Applications should use the format-specific interface to access them.</p>
2501 </td></tr>
2502 <tr><td class="val" id="num_fixed_sizes">num_fixed_sizes</td><td class="desc">
2503 <p>The number of bitmap strikes in the face. Even if the face is scalable, there might still be bitmap strikes, which are called &lsquo;sbits&rsquo; in that case.</p>
2504 </td></tr>
2505 <tr><td class="val" id="available_sizes">available_sizes</td><td class="desc">
2506 <p>An array of <code><a href="ft2-base_interface.html#ft_bitmap_size">FT_Bitmap_Size</a></code> for all bitmap strikes in the face. It is set to <code>NULL</code> if there is no bitmap strike.</p>
2507 <p>Note that FreeType tries to sanitize the strike data since they are sometimes sloppy or incorrect, but this can easily fail.</p>
2508 </td></tr>
2509 <tr><td class="val" id="num_charmaps">num_charmaps</td><td class="desc">
2510 <p>The number of charmaps in the face.</p>
2511 </td></tr>
2512 <tr><td class="val" id="charmaps">charmaps</td><td class="desc">
2513 <p>An array of the charmaps of the face.</p>
2514 </td></tr>
2515 <tr><td class="val" id="generic">generic</td><td class="desc">
2516 <p>A field reserved for client uses. See the <code><a href="ft2-basic_types.html#ft_generic">FT_Generic</a></code> type description.</p>
2517 </td></tr>
2518 <tr><td class="val" id="bbox">bbox</td><td class="desc">
2519 <p>The font bounding box. Coordinates are expressed in font units (see <code>units_per_EM</code>). The box is large enough to contain any glyph from the font. Thus, <code>bbox.yMax</code> can be seen as the &lsquo;maximum ascender&rsquo;, and <code>bbox.yMin</code> as the &lsquo;minimum descender&rsquo;. Only relevant for scalable formats.</p>
2520 <p>Note that the bounding box might be off by (at least) one pixel for hinted fonts. See <code><a href="ft2-base_interface.html#ft_size_metrics">FT_Size_Metrics</a></code> for further discussion.</p>
2521 <p>Note that the bounding box does not vary in OpenType variable fonts and should only be used in relation to the default instance.</p>
2522 </td></tr>
2523 <tr><td class="val" id="units_per_em">units_per_EM</td><td class="desc">
2524 <p>The number of font units per EM square for this face. This is typically 2048 for TrueType fonts, and 1000 for Type&nbsp;1 fonts. Only relevant for scalable formats.</p>
2525 </td></tr>
2526 <tr><td class="val" id="ascender">ascender</td><td class="desc">
2527 <p>The typographic ascender of the face, expressed in font units. For font formats not having this information, it is set to <code>bbox.yMax</code>. Only relevant for scalable formats.</p>
2528 </td></tr>
2529 <tr><td class="val" id="descender">descender</td><td class="desc">
2530 <p>The typographic descender of the face, expressed in font units. For font formats not having this information, it is set to <code>bbox.yMin</code>. Note that this field is negative for values below the baseline. Only relevant for scalable formats.</p>
2531 </td></tr>
2532 <tr><td class="val" id="height">height</td><td class="desc">
2533 <p>This value is the vertical distance between two consecutive baselines, expressed in font units. It is always positive. Only relevant for scalable formats.</p>
2534 <p>If you want the global glyph height, use <code>ascender - descender</code>.</p>
2535 </td></tr>
2536 <tr><td class="val" id="max_advance_width">max_advance_width</td><td class="desc">
2537 <p>The maximum advance width, in font units, for all glyphs in this face. This can be used to make word wrapping computations faster. Only relevant for scalable formats.</p>
2538 </td></tr>
2539 <tr><td class="val" id="max_advance_height">max_advance_height</td><td class="desc">
2540 <p>The maximum advance height, in font units, for all glyphs in this face. This is only relevant for vertical layouts, and is set to <code>height</code> for fonts that do not provide vertical metrics. Only relevant for scalable formats.</p>
2541 </td></tr>
2542 <tr><td class="val" id="underline_position">underline_position</td><td class="desc">
2543 <p>The position, in font units, of the underline line for this face. It is the center of the underlining stem. Only relevant for scalable formats.</p>
2544 </td></tr>
2545 <tr><td class="val" id="underline_thickness">underline_thickness</td><td class="desc">
2546 <p>The thickness, in font units, of the underline for this face. Only relevant for scalable formats.</p>
2547 </td></tr>
2548 <tr><td class="val" id="glyph">glyph</td><td class="desc">
2549 <p>The face's associated glyph slot(s).</p>
2550 </td></tr>
2551 <tr><td class="val" id="size">size</td><td class="desc">
2552 <p>The current active size for this face.</p>
2553 </td></tr>
2554 <tr><td class="val" id="charmap">charmap</td><td class="desc">
2555 <p>The current active charmap for this face.</p>
2556 </td></tr>
2557 </table>
2558
2559 <h4>note</h4>
2560
2561 <p>Fields may be changed after a call to <code><a href="ft2-base_interface.html#ft_attach_file">FT_Attach_File</a></code> or <code><a href="ft2-base_interface.html#ft_attach_stream">FT_Attach_Stream</a></code>.</p>
2562 <p>For an OpenType variation font, the values of the following fields can change after a call to <code><a href="ft2-multiple_masters.html#ft_set_var_design_coordinates">FT_Set_Var_Design_Coordinates</a></code> (and friends) if the font contains an &lsquo;MVAR&rsquo; table: <code>ascender</code>, <code>descender</code>, <code>height</code>, <code>underline_position</code>, and <code>underline_thickness</code>.</p>
2563 <p>Especially for TrueType fonts see also the documentation for <code><a href="ft2-base_interface.html#ft_size_metrics">FT_Size_Metrics</a></code>.</p>
2564 <hr>
2565
2566 <h2 id="ft_has_horizontal">FT_HAS_HORIZONTAL<a class="headerlink" href="#ft_has_horizontal" title="Permanent link">&para;</a></h2>
2567 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2568 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_HORIZONTAL</b>( face ) \
2569           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_horizontal">FT_FACE_FLAG_HORIZONTAL</a> ) )
2570 </code></pre></div>
2571
2572 <p>A macro that returns true whenever a face object contains horizontal metrics (this is true for all font formats though).</p>
2573 <h4>also</h4>
2574
2575 <p><code><a href="ft2-base_interface.html#ft_has_vertical">FT_HAS_VERTICAL</a></code> can be used to check for vertical metrics.</p>
2576 <hr>
2577
2578 <h2 id="ft_has_vertical">FT_HAS_VERTICAL<a class="headerlink" href="#ft_has_vertical" title="Permanent link">&para;</a></h2>
2579 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2580 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_VERTICAL</b>( face ) \
2581           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_vertical">FT_FACE_FLAG_VERTICAL</a> ) )
2582 </code></pre></div>
2583
2584 <p>A macro that returns true whenever a face object contains real vertical metrics (and not only synthesized ones).</p>
2585 <hr>
2586
2587 <h2 id="ft_has_kerning">FT_HAS_KERNING<a class="headerlink" href="#ft_has_kerning" title="Permanent link">&para;</a></h2>
2588 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2589 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_KERNING</b>( face ) \
2590           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_kerning">FT_FACE_FLAG_KERNING</a> ) )
2591 </code></pre></div>
2592
2593 <p>A macro that returns true whenever a face object contains kerning data that can be accessed with <code><a href="ft2-base_interface.html#ft_get_kerning">FT_Get_Kerning</a></code>.</p>
2594 <hr>
2595
2596 <h2 id="ft_has_fixed_sizes">FT_HAS_FIXED_SIZES<a class="headerlink" href="#ft_has_fixed_sizes" title="Permanent link">&para;</a></h2>
2597 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2598 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_FIXED_SIZES</b>( face ) \
2599           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_fixed_sizes">FT_FACE_FLAG_FIXED_SIZES</a> ) )
2600 </code></pre></div>
2601
2602 <p>A macro that returns true whenever a face object contains some embedded bitmaps. See the <code>available_sizes</code> field of the <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> structure.</p>
2603 <hr>
2604
2605 <h2 id="ft_has_glyph_names">FT_HAS_GLYPH_NAMES<a class="headerlink" href="#ft_has_glyph_names" title="Permanent link">&para;</a></h2>
2606 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2607 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_GLYPH_NAMES</b>( face ) \
2608           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_glyph_names">FT_FACE_FLAG_GLYPH_NAMES</a> ) )
2609 </code></pre></div>
2610
2611 <p>A macro that returns true whenever a face object contains some glyph names that can be accessed through <code><a href="ft2-base_interface.html#ft_get_glyph_name">FT_Get_Glyph_Name</a></code>.</p>
2612 <hr>
2613
2614 <h2 id="ft_has_color">FT_HAS_COLOR<a class="headerlink" href="#ft_has_color" title="Permanent link">&para;</a></h2>
2615 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2616 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_COLOR</b>( face ) \
2617           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_color">FT_FACE_FLAG_COLOR</a> ) )
2618 </code></pre></div>
2619
2620 <p>A macro that returns true whenever a face object contains tables for color glyphs.</p>
2621 <h4>since</h4>
2622
2623 <p>2.5.1</p>
2624 <hr>
2625
2626 <h2 id="ft_has_multiple_masters">FT_HAS_MULTIPLE_MASTERS<a class="headerlink" href="#ft_has_multiple_masters" title="Permanent link">&para;</a></h2>
2627 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2628 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_MULTIPLE_MASTERS</b>( face ) \
2629           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_multiple_masters">FT_FACE_FLAG_MULTIPLE_MASTERS</a> ) )
2630 </code></pre></div>
2631
2632 <p>A macro that returns true whenever a face object contains some multiple masters. The functions provided by <code><a href="ft2-header_file_macros.html#ft_multiple_masters_h">FT_MULTIPLE_MASTERS_H</a></code> are then available to choose the exact design you want.</p>
2633 <hr>
2634
2635 <h2 id="ft_is_sfnt">FT_IS_SFNT<a class="headerlink" href="#ft_is_sfnt" title="Permanent link">&para;</a></h2>
2636 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2637 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_SFNT</b>( face ) \
2638           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_sfnt">FT_FACE_FLAG_SFNT</a> ) )
2639 </code></pre></div>
2640
2641 <p>A macro that returns true whenever a face object contains a font whose format is based on the SFNT storage scheme. This usually means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded bitmap fonts.</p>
2642 <p>If this macro is true, all functions defined in <code><a href="ft2-header_file_macros.html#ft_sfnt_names_h">FT_SFNT_NAMES_H</a></code> and <code><a href="ft2-header_file_macros.html#ft_truetype_tables_h">FT_TRUETYPE_TABLES_H</a></code> are available.</p>
2643 <hr>
2644
2645 <h2 id="ft_is_scalable">FT_IS_SCALABLE<a class="headerlink" href="#ft_is_scalable" title="Permanent link">&para;</a></h2>
2646 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2647 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_SCALABLE</b>( face ) \
2648           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_scalable">FT_FACE_FLAG_SCALABLE</a> ) )
2649 </code></pre></div>
2650
2651 <p>A macro that returns true whenever a face object contains a scalable font face (true for TrueType, Type&nbsp;1, Type&nbsp;42, CID, OpenType/CFF, and PFR font formats).</p>
2652 <hr>
2653
2654 <h2 id="ft_is_fixed_width">FT_IS_FIXED_WIDTH<a class="headerlink" href="#ft_is_fixed_width" title="Permanent link">&para;</a></h2>
2655 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2656 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_FIXED_WIDTH</b>( face ) \
2657           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_fixed_width">FT_FACE_FLAG_FIXED_WIDTH</a> ) )
2658 </code></pre></div>
2659
2660 <p>A macro that returns true whenever a face object contains a font face that contains fixed-width (or &lsquo;monospace&rsquo;, &lsquo;fixed-pitch&rsquo;, etc.) glyphs.</p>
2661 <hr>
2662
2663 <h2 id="ft_is_cid_keyed">FT_IS_CID_KEYED<a class="headerlink" href="#ft_is_cid_keyed" title="Permanent link">&para;</a></h2>
2664 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2665 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_CID_KEYED</b>( face ) \
2666           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_cid_keyed">FT_FACE_FLAG_CID_KEYED</a> ) )
2667 </code></pre></div>
2668
2669 <p>A macro that returns true whenever a face object contains a CID-keyed font. See the discussion of <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_CID_KEYED</a></code> for more details.</p>
2670 <p>If this macro is true, all functions defined in <code><a href="ft2-header_file_macros.html#ft_cid_h">FT_CID_H</a></code> are available.</p>
2671 <hr>
2672
2673 <h2 id="ft_is_tricky">FT_IS_TRICKY<a class="headerlink" href="#ft_is_tricky" title="Permanent link">&para;</a></h2>
2674 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2675 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_TRICKY</b>( face ) \
2676           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_tricky">FT_FACE_FLAG_TRICKY</a> ) )
2677 </code></pre></div>
2678
2679 <p>A macro that returns true whenever a face represents a &lsquo;tricky&rsquo; font. See the discussion of <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_TRICKY</a></code> for more details.</p>
2680 <hr>
2681
2682 <h2 id="ft_is_named_instance">FT_IS_NAMED_INSTANCE<a class="headerlink" href="#ft_is_named_instance" title="Permanent link">&para;</a></h2>
2683 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2684 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_NAMED_INSTANCE</b>( face ) \
2685           ( !!( (face)-&gt;face_index &amp; 0x7FFF0000L ) )
2686 </code></pre></div>
2687
2688 <p>A macro that returns true whenever a face object is a named instance of a GX or OpenType variation font.</p>
2689 <p>[Since 2.9] Changing the design coordinates with <code><a href="ft2-multiple_masters.html#ft_set_var_design_coordinates">FT_Set_Var_Design_Coordinates</a></code> or <code><a href="ft2-multiple_masters.html#ft_set_var_blend_coordinates">FT_Set_Var_Blend_Coordinates</a></code> does not influence the return value of this macro (only <code><a href="ft2-multiple_masters.html#ft_set_named_instance">FT_Set_Named_Instance</a></code> does that).</p>
2690 <h4>since</h4>
2691
2692 <p>2.7</p>
2693 <hr>
2694
2695 <h2 id="ft_is_variation">FT_IS_VARIATION<a class="headerlink" href="#ft_is_variation" title="Permanent link">&para;</a></h2>
2696 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2697 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_IS_VARIATION</b>( face ) \
2698           ( !!( (face)-&gt;face_flags &amp; <a href="ft2-base_interface.html#ft_face_flag_variation">FT_FACE_FLAG_VARIATION</a> ) )
2699 </code></pre></div>
2700
2701 <p>A macro that returns true whenever a face object has been altered by <code><a href="ft2-multiple_masters.html#ft_set_mm_design_coordinates">FT_Set_MM_Design_Coordinates</a></code>, <code><a href="ft2-multiple_masters.html#ft_set_var_design_coordinates">FT_Set_Var_Design_Coordinates</a></code>, or <code><a href="ft2-multiple_masters.html#ft_set_var_blend_coordinates">FT_Set_Var_Blend_Coordinates</a></code>.</p>
2702 <h4>since</h4>
2703
2704 <p>2.9</p>
2705 <hr>
2706
2707 <h2 id="ft_sizerec">FT_SizeRec<a class="headerlink" href="#ft_sizerec" title="Permanent link">&para;</a></h2>
2708 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2709 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_SizeRec_
2710   {
2711     <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face;      /* parent face object              */
2712     <a href="ft2-basic_types.html#ft_generic">FT_Generic</a>        generic;   /* generic pointer for client uses */
2713     <a href="ft2-base_interface.html#ft_size_metrics">FT_Size_Metrics</a>   metrics;   /* size metrics                    */
2714     <a href="ft2-base_interface.html#ft_size_internal">FT_Size_Internal</a>  internal;
2715
2716   } <b>FT_SizeRec</b>;
2717 </code></pre></div>
2718
2719 <p>FreeType root size class structure. A size object models a face object at a given size.</p>
2720 <h4>fields</h4>
2721
2722 <table class="fields">
2723 <tr><td class="val" id="face">face</td><td class="desc">
2724 <p>Handle to the parent face object.</p>
2725 </td></tr>
2726 <tr><td class="val" id="generic">generic</td><td class="desc">
2727 <p>A typeless pointer, unused by the FreeType library or any of its drivers. It can be used by client applications to link their own data to each size object.</p>
2728 </td></tr>
2729 <tr><td class="val" id="metrics">metrics</td><td class="desc">
2730 <p>Metrics for this size object. This field is read-only.</p>
2731 </td></tr>
2732 </table>
2733
2734 <hr>
2735
2736 <h2 id="ft_size_metrics">FT_Size_Metrics<a class="headerlink" href="#ft_size_metrics" title="Permanent link">&para;</a></h2>
2737 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2738 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Size_Metrics_
2739   {
2740     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>  x_ppem;      /* horizontal pixels per EM               */
2741     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>  y_ppem;      /* vertical pixels per EM                 */
2742
2743     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>   x_scale;     /* scaling values used to convert font    */
2744     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>   y_scale;     /* units to 26.6 fractional pixels        */
2745
2746     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>     ascender;    /* ascender in 26.6 frac. pixels          */
2747     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>     descender;   /* descender in 26.6 frac. pixels         */
2748     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>     height;      /* text height in 26.6 frac. pixels       */
2749     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>     max_advance; /* max horizontal advance, in 26.6 pixels */
2750
2751   } <b>FT_Size_Metrics</b>;
2752 </code></pre></div>
2753
2754 <p>The size metrics structure gives the metrics of a size object.</p>
2755 <h4>fields</h4>
2756
2757 <table class="fields">
2758 <tr><td class="val" id="x_ppem">x_ppem</td><td class="desc">
2759 <p>The width of the scaled EM square in pixels, hence the term &lsquo;ppem&rsquo; (pixels per EM). It is also referred to as &lsquo;nominal width&rsquo;.</p>
2760 </td></tr>
2761 <tr><td class="val" id="y_ppem">y_ppem</td><td class="desc">
2762 <p>The height of the scaled EM square in pixels, hence the term &lsquo;ppem&rsquo; (pixels per EM). It is also referred to as &lsquo;nominal height&rsquo;.</p>
2763 </td></tr>
2764 <tr><td class="val" id="x_scale">x_scale</td><td class="desc">
2765 <p>A 16.16 fractional scaling value to convert horizontal metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats.</p>
2766 </td></tr>
2767 <tr><td class="val" id="y_scale">y_scale</td><td class="desc">
2768 <p>A 16.16 fractional scaling value to convert vertical metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats.</p>
2769 </td></tr>
2770 <tr><td class="val" id="ascender">ascender</td><td class="desc">
2771 <p>The ascender in 26.6 fractional pixels, rounded up to an integer value. See <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> for the details.</p>
2772 </td></tr>
2773 <tr><td class="val" id="descender">descender</td><td class="desc">
2774 <p>The descender in 26.6 fractional pixels, rounded down to an integer value. See <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> for the details.</p>
2775 </td></tr>
2776 <tr><td class="val" id="height">height</td><td class="desc">
2777 <p>The height in 26.6 fractional pixels, rounded to an integer value. See <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> for the details.</p>
2778 </td></tr>
2779 <tr><td class="val" id="max_advance">max_advance</td><td class="desc">
2780 <p>The maximum advance width in 26.6 fractional pixels, rounded to an integer value. See <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> for the details.</p>
2781 </td></tr>
2782 </table>
2783
2784 <h4>note</h4>
2785
2786 <p>The scaling values, if relevant, are determined first during a size changing operation. The remaining fields are then set by the driver. For scalable formats, they are usually set to scaled values of the corresponding fields in <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code>. Some values like ascender or descender are rounded for historical reasons; more precise values (for outline fonts) can be derived by scaling the corresponding <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> values manually, with code similar to the following.
2787 <div class="highlight"><pre><span></span><code>  scaled_ascender = FT_MulFix( face-&gt;ascender,
2788                                size_metrics-&gt;y_scale );
2789 </code></pre></div></p>
2790 <p>Note that due to glyph hinting and the selected rendering mode these values are usually not exact; consequently, they must be treated as unreliable with an error margin of at least one pixel!</p>
2791 <p>Indeed, the only way to get the exact metrics is to render <em>all</em> glyphs. As this would be a definite performance hit, it is up to client applications to perform such computations.</p>
2792 <p>The <code>FT_Size_Metrics</code> structure is valid for bitmap fonts also.</p>
2793 <p><strong>TrueType fonts with native bytecode hinting</strong></p>
2794 <p>All applications that handle TrueType fonts with native hinting must be aware that TTFs expect different rounding of vertical font dimensions. The application has to cater for this, especially if it wants to rely on a TTF's vertical data (for example, to properly align box characters vertically).</p>
2795 <p>Only the application knows <em>in advance</em> that it is going to use native hinting for TTFs! FreeType, on the other hand, selects the hinting mode not at the time of creating an <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object but much later, namely while calling <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
2796 <p>Here is some pseudo code that illustrates a possible solution.
2797 <div class="highlight"><pre><span></span><code>  font_format = FT_Get_Font_Format( face );
2798
2799   if ( !strcmp( font_format, &quot;TrueType&quot; ) &amp;&amp;
2800        do_native_bytecode_hinting         )
2801   {
2802     ascender  = ROUND( FT_MulFix( face-&gt;ascender,
2803                                   size_metrics-&gt;y_scale ) );
2804     descender = ROUND( FT_MulFix( face-&gt;descender,
2805                                   size_metrics-&gt;y_scale ) );
2806   }
2807   else
2808   {
2809     ascender  = size_metrics-&gt;ascender;
2810     descender = size_metrics-&gt;descender;
2811   }
2812
2813   height      = size_metrics-&gt;height;
2814   max_advance = size_metrics-&gt;max_advance;
2815 </code></pre></div></p>
2816 <hr>
2817
2818 <h2 id="ft_glyphslotrec">FT_GlyphSlotRec<a class="headerlink" href="#ft_glyphslotrec" title="Permanent link">&para;</a></h2>
2819 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2820 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_GlyphSlotRec_
2821   {
2822     <a href="ft2-base_interface.html#ft_library">FT_Library</a>        library;
2823     <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face;
2824     <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a>      next;
2825     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>           glyph_index; /* new in 2.10; was reserved previously */
2826     <a href="ft2-basic_types.html#ft_generic">FT_Generic</a>        generic;
2827
2828     <a href="ft2-base_interface.html#ft_glyph_metrics">FT_Glyph_Metrics</a>  metrics;
2829     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>          linearHoriAdvance;
2830     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>          linearVertAdvance;
2831     <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>         advance;
2832
2833     <a href="ft2-basic_types.html#ft_glyph_format">FT_Glyph_Format</a>   format;
2834
2835     <a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a>         bitmap;
2836     <a href="ft2-basic_types.html#ft_int">FT_Int</a>            bitmap_left;
2837     <a href="ft2-basic_types.html#ft_int">FT_Int</a>            bitmap_top;
2838
2839     <a href="ft2-outline_processing.html#ft_outline">FT_Outline</a>        outline;
2840
2841     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>           num_subglyphs;
2842     <a href="ft2-base_interface.html#ft_subglyph">FT_SubGlyph</a>       subglyphs;
2843
2844     <span class="keyword">void</span>*             control_data;
2845     <span class="keyword">long</span>              control_len;
2846
2847     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>            lsb_delta;
2848     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>            rsb_delta;
2849
2850     <span class="keyword">void</span>*             other;
2851
2852     <a href="ft2-base_interface.html#ft_slot_internal">FT_Slot_Internal</a>  internal;
2853
2854   } <b>FT_GlyphSlotRec</b>;
2855 </code></pre></div>
2856
2857 <p>FreeType root glyph slot class structure. A glyph slot is a container where individual glyphs can be loaded, be they in outline or bitmap format.</p>
2858 <h4>fields</h4>
2859
2860 <table class="fields">
2861 <tr><td class="val" id="library">library</td><td class="desc">
2862 <p>A handle to the FreeType library instance this slot belongs to.</p>
2863 </td></tr>
2864 <tr><td class="val" id="face">face</td><td class="desc">
2865 <p>A handle to the parent face object.</p>
2866 </td></tr>
2867 <tr><td class="val" id="next">next</td><td class="desc">
2868 <p>In some cases (like some font tools), several glyph slots per face object can be a good thing. As this is rare, the glyph slots are listed through a direct, single-linked list using its <code>next</code> field.</p>
2869 </td></tr>
2870 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
2871 <p>[Since 2.10] The glyph index passed as an argument to <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> while initializing the glyph slot.</p>
2872 </td></tr>
2873 <tr><td class="val" id="generic">generic</td><td class="desc">
2874 <p>A typeless pointer unused by the FreeType library or any of its drivers. It can be used by client applications to link their own data to each glyph slot object.</p>
2875 </td></tr>
2876 <tr><td class="val" id="metrics">metrics</td><td class="desc">
2877 <p>The metrics of the last loaded glyph in the slot. The returned values depend on the last load flags (see the <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> API function) and can be expressed either in 26.6 fractional pixels or font units.</p>
2878 <p>Note that even when the glyph image is transformed, the metrics are not.</p>
2879 </td></tr>
2880 <tr><td class="val" id="linearhoriadvance">linearHoriAdvance</td><td class="desc">
2881 <p>The advance width of the unhinted glyph. Its value is expressed in 16.16 fractional pixels, unless <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_LINEAR_DESIGN</a></code> is set when loading the glyph. This field can be important to perform correct WYSIWYG layout. Only relevant for outline glyphs.</p>
2882 </td></tr>
2883 <tr><td class="val" id="linearvertadvance">linearVertAdvance</td><td class="desc">
2884 <p>The advance height of the unhinted glyph. Its value is expressed in 16.16 fractional pixels, unless <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_LINEAR_DESIGN</a></code> is set when loading the glyph. This field can be important to perform correct WYSIWYG layout. Only relevant for outline glyphs.</p>
2885 </td></tr>
2886 <tr><td class="val" id="advance">advance</td><td class="desc">
2887 <p>This shorthand is, depending on <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_IGNORE_TRANSFORM</a></code>, the transformed (hinted) advance width for the glyph, in 26.6 fractional pixel format. As specified with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_VERTICAL_LAYOUT</a></code>, it uses either the <code>horiAdvance</code> or the <code>vertAdvance</code> value of <code>metrics</code> field.</p>
2888 </td></tr>
2889 <tr><td class="val" id="format">format</td><td class="desc">
2890 <p>This field indicates the format of the image contained in the glyph slot. Typically <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_BITMAP</a></code>, <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_OUTLINE</a></code>, or <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_COMPOSITE</a></code>, but other values are possible.</p>
2891 </td></tr>
2892 <tr><td class="val" id="bitmap">bitmap</td><td class="desc">
2893 <p>This field is used as a bitmap descriptor. Note that the address and content of the bitmap buffer can change between calls of <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> and a few other functions.</p>
2894 </td></tr>
2895 <tr><td class="val" id="bitmap_left">bitmap_left</td><td class="desc">
2896 <p>The bitmap's left bearing expressed in integer pixels.</p>
2897 </td></tr>
2898 <tr><td class="val" id="bitmap_top">bitmap_top</td><td class="desc">
2899 <p>The bitmap's top bearing expressed in integer pixels. This is the distance from the baseline to the top-most glyph scanline, upwards y&nbsp;coordinates being <strong>positive</strong>.</p>
2900 </td></tr>
2901 <tr><td class="val" id="outline">outline</td><td class="desc">
2902 <p>The outline descriptor for the current glyph image if its format is <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_OUTLINE</a></code>. Once a glyph is loaded, <code>outline</code> can be transformed, distorted, emboldened, etc. However, it must not be freed.</p>
2903 <p>[Since 2.10.1] If <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> is set, outline coordinates of OpenType variation fonts for a selected instance are internally handled as 26.6 fractional font units but returned as (rounded) integers, as expected. To get unrounded font units, don't use <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> but load the glyph with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code> and scale it, using the font's <code>units_per_EM</code> value as the ppem.</p>
2904 </td></tr>
2905 <tr><td class="val" id="num_subglyphs">num_subglyphs</td><td class="desc">
2906 <p>The number of subglyphs in a composite glyph. This field is only valid for the composite glyph format that should normally only be loaded with the <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_RECURSE</a></code> flag.</p>
2907 </td></tr>
2908 <tr><td class="val" id="subglyphs">subglyphs</td><td class="desc">
2909 <p>An array of subglyph descriptors for composite glyphs. There are <code>num_subglyphs</code> elements in there. Currently internal to FreeType.</p>
2910 </td></tr>
2911 <tr><td class="val" id="control_data">control_data</td><td class="desc">
2912 <p>Certain font drivers can also return the control data for a given glyph image (e.g. TrueType bytecode, Type&nbsp;1 charstrings, etc.). This field is a pointer to such data; it is currently internal to FreeType.</p>
2913 </td></tr>
2914 <tr><td class="val" id="control_len">control_len</td><td class="desc">
2915 <p>This is the length in bytes of the control data. Currently internal to FreeType.</p>
2916 </td></tr>
2917 <tr><td class="val" id="other">other</td><td class="desc">
2918 <p>Reserved.</p>
2919 </td></tr>
2920 <tr><td class="val" id="lsb_delta">lsb_delta</td><td class="desc">
2921 <p>The difference between hinted and unhinted left side bearing while auto-hinting is active. Zero otherwise.</p>
2922 </td></tr>
2923 <tr><td class="val" id="rsb_delta">rsb_delta</td><td class="desc">
2924 <p>The difference between hinted and unhinted right side bearing while auto-hinting is active. Zero otherwise.</p>
2925 </td></tr>
2926 </table>
2927
2928 <h4>note</h4>
2929
2930 <p>If <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> is called with default flags (see <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_DEFAULT</a></code>) the glyph image is loaded in the glyph slot in its native format (e.g., an outline glyph for TrueType and Type&nbsp;1 formats). [Since 2.9] The prospective bitmap metrics are calculated according to <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_XXX</a></code> and other flags even for the outline glyph, even if <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_RENDER</a></code> is not set.</p>
2931 <p>This image can later be converted into a bitmap by calling <code><a href="ft2-base_interface.html#ft_render_glyph">FT_Render_Glyph</a></code>. This function searches the current renderer for the native image's format, then invokes it.</p>
2932 <p>The renderer is in charge of transforming the native image through the slot's face transformation fields, then converting it into a bitmap that is returned in <code>slot-&gt;bitmap</code>.</p>
2933 <p>Note that <code>slot-&gt;bitmap_left</code> and <code>slot-&gt;bitmap_top</code> are also used to specify the position of the bitmap relative to the current pen position (e.g., coordinates (0,0) on the baseline). Of course, <code>slot-&gt;format</code> is also changed to <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_BITMAP</a></code>.</p>
2934 <p>Here is a small pseudo code fragment that shows how to use <code>lsb_delta</code> and <code>rsb_delta</code> to do fractional positioning of glyphs:
2935 <div class="highlight"><pre><span></span><code>  FT_GlyphSlot  slot     = face-&gt;glyph;
2936   FT_Pos        origin_x = 0;
2937
2938
2939   for all glyphs do
2940     &lt;load glyph with `FT_Load_Glyph&#39;&gt;
2941
2942     FT_Outline_Translate( slot-&gt;outline, origin_x &amp; 63, 0 );
2943
2944     &lt;save glyph image, or render glyph, or ...&gt;
2945
2946     &lt;compute kern between current and next glyph
2947      and add it to `origin_x&#39;&gt;
2948
2949     origin_x += slot-&gt;advance.x;
2950     origin_x += slot-&gt;lsb_delta - slot-&gt;rsb_delta;
2951   endfor
2952 </code></pre></div></p>
2953 <p>Here is another small pseudo code fragment that shows how to use <code>lsb_delta</code> and <code>rsb_delta</code> to improve integer positioning of glyphs:
2954 <div class="highlight"><pre><span></span><code>  FT_GlyphSlot  slot           = face-&gt;glyph;
2955   FT_Pos        origin_x       = 0;
2956   FT_Pos        prev_rsb_delta = 0;
2957
2958
2959   for all glyphs do
2960     &lt;compute kern between current and previous glyph
2961      and add it to `origin_x&#39;&gt;
2962
2963     &lt;load glyph with `FT_Load_Glyph&#39;&gt;
2964
2965     if ( prev_rsb_delta - slot-&gt;lsb_delta &gt;  32 )
2966       origin_x -= 64;
2967     else if ( prev_rsb_delta - slot-&gt;lsb_delta &lt; -31 )
2968       origin_x += 64;
2969
2970     prev_rsb_delta = slot-&gt;rsb_delta;
2971
2972     &lt;save glyph image, or render glyph, or ...&gt;
2973
2974     origin_x += slot-&gt;advance.x;
2975   endfor
2976 </code></pre></div></p>
2977 <p>If you use strong auto-hinting, you <strong>must</strong> apply these delta values! Otherwise you will experience far too large inter-glyph spacing at small rendering sizes in most cases. Note that it doesn't harm to use the above code for other hinting modes also, since the delta values are zero then.</p>
2978 <hr>
2979
2980 <h2 id="ft_glyph_metrics">FT_Glyph_Metrics<a class="headerlink" href="#ft_glyph_metrics" title="Permanent link">&para;</a></h2>
2981 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
2982 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Glyph_Metrics_
2983   {
2984     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  width;
2985     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  height;
2986
2987     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  horiBearingX;
2988     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  horiBearingY;
2989     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  horiAdvance;
2990
2991     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  vertBearingX;
2992     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  vertBearingY;
2993     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  vertAdvance;
2994
2995   } <b>FT_Glyph_Metrics</b>;
2996 </code></pre></div>
2997
2998 <p>A structure to model the metrics of a single glyph. The values are expressed in 26.6 fractional pixel format; if the flag <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> has been used while loading the glyph, values are expressed in font units instead.</p>
2999 <h4>fields</h4>
3000
3001 <table class="fields">
3002 <tr><td class="val" id="width">width</td><td class="desc">
3003 <p>The glyph's width.</p>
3004 </td></tr>
3005 <tr><td class="val" id="height">height</td><td class="desc">
3006 <p>The glyph's height.</p>
3007 </td></tr>
3008 <tr><td class="val" id="horibearingx">horiBearingX</td><td class="desc">
3009 <p>Left side bearing for horizontal layout.</p>
3010 </td></tr>
3011 <tr><td class="val" id="horibearingy">horiBearingY</td><td class="desc">
3012 <p>Top side bearing for horizontal layout.</p>
3013 </td></tr>
3014 <tr><td class="val" id="horiadvance">horiAdvance</td><td class="desc">
3015 <p>Advance width for horizontal layout.</p>
3016 </td></tr>
3017 <tr><td class="val" id="vertbearingx">vertBearingX</td><td class="desc">
3018 <p>Left side bearing for vertical layout.</p>
3019 </td></tr>
3020 <tr><td class="val" id="vertbearingy">vertBearingY</td><td class="desc">
3021 <p>Top side bearing for vertical layout. Larger positive values mean further below the vertical glyph origin.</p>
3022 </td></tr>
3023 <tr><td class="val" id="vertadvance">vertAdvance</td><td class="desc">
3024 <p>Advance height for vertical layout. Positive values mean the glyph has a positive advance downward.</p>
3025 </td></tr>
3026 </table>
3027
3028 <h4>note</h4>
3029
3030 <p>If not disabled with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code>, the values represent dimensions of the hinted glyph (in case hinting is applicable).</p>
3031 <p>Stroking a glyph with an outside border does not increase <code>horiAdvance</code> or <code>vertAdvance</code>; you have to manually adjust these values to account for the added width and height.</p>
3032 <p>FreeType doesn't use the &lsquo;VORG&rsquo; table data for CFF fonts because it doesn't have an interface to quickly retrieve the glyph height. The y&nbsp;coordinate of the vertical origin can be simply computed as <code>vertBearingY + height</code> after loading a glyph.</p>
3033 <hr>
3034
3035 <h2 id="ft_subglyph">FT_SubGlyph<a class="headerlink" href="#ft_subglyph" title="Permanent link">&para;</a></h2>
3036 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3037 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_SubGlyphRec_*  <b>FT_SubGlyph</b>;
3038 </code></pre></div>
3039
3040 <p>The subglyph structure is an internal object used to describe subglyphs (for example, in the case of composites).</p>
3041 <h4>note</h4>
3042
3043 <p>The subglyph implementation is not part of the high-level API, hence the forward structure declaration.</p>
3044 <p>You can however retrieve subglyph information with <code><a href="ft2-base_interface.html#ft_get_subglyph_info">FT_Get_SubGlyph_Info</a></code>.</p>
3045 <hr>
3046
3047 <h2 id="ft_bitmap_size">FT_Bitmap_Size<a class="headerlink" href="#ft_bitmap_size" title="Permanent link">&para;</a></h2>
3048 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3049 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Bitmap_Size_
3050   {
3051     <a href="ft2-basic_types.html#ft_short">FT_Short</a>  height;
3052     <a href="ft2-basic_types.html#ft_short">FT_Short</a>  width;
3053
3054     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>    size;
3055
3056     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>    x_ppem;
3057     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>    y_ppem;
3058
3059   } <b>FT_Bitmap_Size</b>;
3060 </code></pre></div>
3061
3062 <p>This structure models the metrics of a bitmap strike (i.e., a set of glyphs for a given point size and resolution) in a bitmap font. It is used for the <code>available_sizes</code> field of <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code>.</p>
3063 <h4>fields</h4>
3064
3065 <table class="fields">
3066 <tr><td class="val" id="height">height</td><td class="desc">
3067 <p>The vertical distance, in pixels, between two consecutive baselines. It is always positive.</p>
3068 </td></tr>
3069 <tr><td class="val" id="width">width</td><td class="desc">
3070 <p>The average width, in pixels, of all glyphs in the strike.</p>
3071 </td></tr>
3072 <tr><td class="val" id="size">size</td><td class="desc">
3073 <p>The nominal size of the strike in 26.6 fractional points. This field is not very useful.</p>
3074 </td></tr>
3075 <tr><td class="val" id="x_ppem">x_ppem</td><td class="desc">
3076 <p>The horizontal ppem (nominal width) in 26.6 fractional pixels.</p>
3077 </td></tr>
3078 <tr><td class="val" id="y_ppem">y_ppem</td><td class="desc">
3079 <p>The vertical ppem (nominal height) in 26.6 fractional pixels.</p>
3080 </td></tr>
3081 </table>
3082
3083 <h4>note</h4>
3084
3085 <p>Windows FNT: The nominal size given in a FNT font is not reliable. If the driver finds it incorrect, it sets <code>size</code> to some calculated values, and <code>x_ppem</code> and <code>y_ppem</code> to the pixel width and height given in the font, respectively.</p>
3086 <p>TrueType embedded bitmaps: <code>size</code>, <code>width</code>, and <code>height</code> values are not contained in the bitmap strike itself. They are computed from the global font parameters.</p>
3087 <hr>
3088
3089 <h2 id="ft_init_freetype">FT_Init_FreeType<a class="headerlink" href="#ft_init_freetype" title="Permanent link">&para;</a></h2>
3090 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3091 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3092   <b>FT_Init_FreeType</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>  *alibrary );
3093 </code></pre></div>
3094
3095 <p>Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time.</p>
3096 <h4>output</h4>
3097
3098 <table class="fields">
3099 <tr><td class="val" id="alibrary">alibrary</td><td class="desc">
3100 <p>A handle to a new library object.</p>
3101 </td></tr>
3102 </table>
3103
3104 <h4>return</h4>
3105
3106 <p>FreeType error code. 0&nbsp;means success.</p>
3107 <h4>note</h4>
3108
3109 <p>In case you want to provide your own memory allocating routines, use <code><a href="ft2-module_management.html#ft_new_library">FT_New_Library</a></code> instead, followed by a call to <code><a href="ft2-module_management.html#ft_add_default_modules">FT_Add_Default_Modules</a></code> (or a series of calls to <code><a href="ft2-module_management.html#ft_add_module">FT_Add_Module</a></code>) and <code><a href="ft2-module_management.html#ft_set_default_properties">FT_Set_Default_Properties</a></code>.</p>
3110 <p>See the documentation of <code><a href="ft2-base_interface.html#ft_library">FT_Library</a></code> and <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> for multi-threading issues.</p>
3111 <p>If you need reference-counting (cf. <code><a href="ft2-module_management.html#ft_reference_library">FT_Reference_Library</a></code>), use <code><a href="ft2-module_management.html#ft_new_library">FT_New_Library</a></code> and <code><a href="ft2-module_management.html#ft_done_library">FT_Done_Library</a></code>.</p>
3112 <p>If compilation option <code>FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES</code> is set, this function reads the <code>FREETYPE_PROPERTIES</code> environment variable to control driver properties. See section &lsquo;<a href="ft2-properties.html#properties">Driver properties</a>&rsquo; for more.</p>
3113 <hr>
3114
3115 <h2 id="ft_done_freetype">FT_Done_FreeType<a class="headerlink" href="#ft_done_freetype" title="Permanent link">&para;</a></h2>
3116 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3117 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3118   <b>FT_Done_FreeType</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>  library );
3119 </code></pre></div>
3120
3121 <p>Destroy a given FreeType library object and all of its children, including resources, drivers, faces, sizes, etc.</p>
3122 <h4>input</h4>
3123
3124 <table class="fields">
3125 <tr><td class="val" id="library">library</td><td class="desc">
3126 <p>A handle to the target library object.</p>
3127 </td></tr>
3128 </table>
3129
3130 <h4>return</h4>
3131
3132 <p>FreeType error code. 0&nbsp;means success.</p>
3133 <hr>
3134
3135 <h2 id="ft_new_face">FT_New_Face<a class="headerlink" href="#ft_new_face" title="Permanent link">&para;</a></h2>
3136 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3137 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3138   <b>FT_New_Face</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>   library,
3139                <span class="keyword">const</span> <span class="keyword">char</span>*  filepathname,
3140                <a href="ft2-basic_types.html#ft_long">FT_Long</a>      face_index,
3141                <a href="ft2-base_interface.html#ft_face">FT_Face</a>     *aface );
3142 </code></pre></div>
3143
3144 <p>Call <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> to open a font by its pathname.</p>
3145 <h4>inout</h4>
3146
3147 <table class="fields">
3148 <tr><td class="val" id="library">library</td><td class="desc">
3149 <p>A handle to the library resource.</p>
3150 </td></tr>
3151 </table>
3152
3153 <h4>input</h4>
3154
3155 <table class="fields">
3156 <tr><td class="val" id="pathname">pathname</td><td class="desc">
3157 <p>A path to the font file.</p>
3158 </td></tr>
3159 <tr><td class="val" id="face_index">face_index</td><td class="desc">
3160 <p>See <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> for a detailed description of this parameter.</p>
3161 </td></tr>
3162 </table>
3163
3164 <h4>output</h4>
3165
3166 <table class="fields">
3167 <tr><td class="val" id="aface">aface</td><td class="desc">
3168 <p>A handle to a new face object. If <code>face_index</code> is greater than or equal to zero, it must be non-<code>NULL</code>.</p>
3169 </td></tr>
3170 </table>
3171
3172 <h4>return</h4>
3173
3174 <p>FreeType error code. 0&nbsp;means success.</p>
3175 <h4>note</h4>
3176
3177 <p>Use <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code> to destroy the created <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> object (along with its slot and sizes).</p>
3178 <hr>
3179
3180 <h2 id="ft_done_face">FT_Done_Face<a class="headerlink" href="#ft_done_face" title="Permanent link">&para;</a></h2>
3181 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3182 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3183   <b>FT_Done_Face</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face );
3184 </code></pre></div>
3185
3186 <p>Discard a given face object, as well as all of its child slots and sizes.</p>
3187 <h4>input</h4>
3188
3189 <table class="fields">
3190 <tr><td class="val" id="face">face</td><td class="desc">
3191 <p>A handle to a target face object.</p>
3192 </td></tr>
3193 </table>
3194
3195 <h4>return</h4>
3196
3197 <p>FreeType error code. 0&nbsp;means success.</p>
3198 <h4>note</h4>
3199
3200 <p>See the discussion of reference counters in the description of <code><a href="ft2-base_interface.html#ft_reference_face">FT_Reference_Face</a></code>.</p>
3201 <hr>
3202
3203 <h2 id="ft_reference_face">FT_Reference_Face<a class="headerlink" href="#ft_reference_face" title="Permanent link">&para;</a></h2>
3204 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3205 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3206   <b>FT_Reference_Face</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face );
3207 </code></pre></div>
3208
3209 <p>A counter gets initialized to&nbsp;1 at the time an <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> structure is created. This function increments the counter. <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code> then only destroys a face if the counter is&nbsp;1, otherwise it simply decrements the counter.</p>
3210 <p>This function helps in managing life-cycles of structures that reference <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> objects.</p>
3211 <h4>input</h4>
3212
3213 <table class="fields">
3214 <tr><td class="val" id="face">face</td><td class="desc">
3215 <p>A handle to a target face object.</p>
3216 </td></tr>
3217 </table>
3218
3219 <h4>return</h4>
3220
3221 <p>FreeType error code. 0&nbsp;means success.</p>
3222 <h4>since</h4>
3223
3224 <p>2.4.2</p>
3225 <hr>
3226
3227 <h2 id="ft_new_memory_face">FT_New_Memory_Face<a class="headerlink" href="#ft_new_memory_face" title="Permanent link">&para;</a></h2>
3228 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3229 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3230   <b>FT_New_Memory_Face</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>      library,
3231                       <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>*  file_base,
3232                       <a href="ft2-basic_types.html#ft_long">FT_Long</a>         file_size,
3233                       <a href="ft2-basic_types.html#ft_long">FT_Long</a>         face_index,
3234                       <a href="ft2-base_interface.html#ft_face">FT_Face</a>        *aface );
3235 </code></pre></div>
3236
3237 <p>Call <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> to open a font that has been loaded into memory.</p>
3238 <h4>inout</h4>
3239
3240 <table class="fields">
3241 <tr><td class="val" id="library">library</td><td class="desc">
3242 <p>A handle to the library resource.</p>
3243 </td></tr>
3244 </table>
3245
3246 <h4>input</h4>
3247
3248 <table class="fields">
3249 <tr><td class="val" id="file_base">file_base</td><td class="desc">
3250 <p>A pointer to the beginning of the font data.</p>
3251 </td></tr>
3252 <tr><td class="val" id="file_size">file_size</td><td class="desc">
3253 <p>The size of the memory chunk used by the font data.</p>
3254 </td></tr>
3255 <tr><td class="val" id="face_index">face_index</td><td class="desc">
3256 <p>See <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> for a detailed description of this parameter.</p>
3257 </td></tr>
3258 </table>
3259
3260 <h4>output</h4>
3261
3262 <table class="fields">
3263 <tr><td class="val" id="aface">aface</td><td class="desc">
3264 <p>A handle to a new face object. If <code>face_index</code> is greater than or equal to zero, it must be non-<code>NULL</code>.</p>
3265 </td></tr>
3266 </table>
3267
3268 <h4>return</h4>
3269
3270 <p>FreeType error code. 0&nbsp;means success.</p>
3271 <h4>note</h4>
3272
3273 <p>You must not deallocate the memory before calling <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code>.</p>
3274 <hr>
3275
3276 <h2 id="ft_face_properties">FT_Face_Properties<a class="headerlink" href="#ft_face_properties" title="Permanent link">&para;</a></h2>
3277 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3278 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3279   <b>FT_Face_Properties</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>        face,
3280                       <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>        num_properties,
3281                       <a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a>*  properties );
3282 </code></pre></div>
3283
3284 <p>Set or override certain (library or module-wide) properties on a face-by-face basis. Useful for finer-grained control and avoiding locks on shared structures (threads can modify their own faces as they see fit).</p>
3285 <p>Contrary to <code><a href="ft2-module_management.html#ft_property_set">FT_Property_Set</a></code>, this function uses <code><a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a></code> so that you can pass multiple properties to the target face in one call. Note that only a subset of the available properties can be controlled.</p>
3286 <ul>
3287 <li>
3288 <p><code><a href="ft2-parameter_tags.html#ft_param_tag_stem_darkening">FT_PARAM_TAG_STEM_DARKENING</a></code> (stem darkening, corresponding to the property <code>no-stem-darkening</code> provided by the &lsquo;autofit&rsquo;, &lsquo;cff&rsquo;, &lsquo;type1&rsquo;, and &lsquo;t1cid&rsquo; modules; see <code><a href="ft2-properties.html#no-stem-darkening">no-stem-darkening</a></code>).</p>
3289 </li>
3290 <li>
3291 <p><code><a href="ft2-parameter_tags.html#ft_param_tag_lcd_filter_weights">FT_PARAM_TAG_LCD_FILTER_WEIGHTS</a></code> (LCD filter weights, corresponding to function <code><a href="ft2-lcd_rendering.html#ft_library_setlcdfilterweights">FT_Library_SetLcdFilterWeights</a></code>).</p>
3292 </li>
3293 <li>
3294 <p><code><a href="ft2-parameter_tags.html#ft_param_tag_random_seed">FT_PARAM_TAG_RANDOM_SEED</a></code> (seed value for the CFF, Type&nbsp;1, and CID &lsquo;random&rsquo; operator, corresponding to the <code>random-seed</code> property provided by the &lsquo;cff&rsquo;, &lsquo;type1&rsquo;, and &lsquo;t1cid&rsquo; modules; see <code><a href="ft2-properties.html#random-seed">random-seed</a></code>).</p>
3295 </li>
3296 </ul>
3297 <p>Pass <code>NULL</code> as <code>data</code> in <code><a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a></code> for a given tag to reset the option and use the library or module default again.</p>
3298 <h4>input</h4>
3299
3300 <table class="fields">
3301 <tr><td class="val" id="face">face</td><td class="desc">
3302 <p>A handle to the source face object.</p>
3303 </td></tr>
3304 <tr><td class="val" id="num_properties">num_properties</td><td class="desc">
3305 <p>The number of properties that follow.</p>
3306 </td></tr>
3307 <tr><td class="val" id="properties">properties</td><td class="desc">
3308 <p>A handle to an <code><a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a></code> array with <code>num_properties</code> elements.</p>
3309 </td></tr>
3310 </table>
3311
3312 <h4>return</h4>
3313
3314 <p>FreeType error code. 0&nbsp;means success.</p>
3315 <h4>example</h4>
3316
3317 <p>Here is an example that sets three properties. You must define <code>FT_CONFIG_OPTION_SUBPIXEL_RENDERING</code> to make the LCD filter examples work.
3318 <div class="highlight"><pre><span></span><code>  FT_Parameter         property1;
3319   FT_Bool              darken_stems = 1;
3320
3321   FT_Parameter         property2;
3322   FT_LcdFiveTapFilter  custom_weight =
3323                          { 0x11, 0x44, 0x56, 0x44, 0x11 };
3324
3325   FT_Parameter         property3;
3326   FT_Int32             random_seed = 314159265;
3327
3328   FT_Parameter         properties[3] = { property1,
3329                                          property2,
3330                                          property3 };
3331
3332
3333   property1.tag  = FT_PARAM_TAG_STEM_DARKENING;
3334   property1.data = &amp;darken_stems;
3335
3336   property2.tag  = FT_PARAM_TAG_LCD_FILTER_WEIGHTS;
3337   property2.data = custom_weight;
3338
3339   property3.tag  = FT_PARAM_TAG_RANDOM_SEED;
3340   property3.data = &amp;random_seed;
3341
3342   FT_Face_Properties( face, 3, properties );
3343 </code></pre></div></p>
3344 <p>The next example resets a single property to its default value.
3345 <div class="highlight"><pre><span></span><code>  FT_Parameter  property;
3346
3347
3348   property.tag  = FT_PARAM_TAG_LCD_FILTER_WEIGHTS;
3349   property.data = NULL;
3350
3351   FT_Face_Properties( face, 1, &amp;property );
3352 </code></pre></div></p>
3353 <h4>since</h4>
3354
3355 <p>2.8</p>
3356 <hr>
3357
3358 <h2 id="ft_open_face">FT_Open_Face<a class="headerlink" href="#ft_open_face" title="Permanent link">&para;</a></h2>
3359 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3360 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3361   <b>FT_Open_Face</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a>           library,
3362                 <span class="keyword">const</span> <a href="ft2-base_interface.html#ft_open_args">FT_Open_Args</a>*  args,
3363                 <a href="ft2-basic_types.html#ft_long">FT_Long</a>              face_index,
3364                 <a href="ft2-base_interface.html#ft_face">FT_Face</a>             *aface );
3365 </code></pre></div>
3366
3367 <p>Create a face object from a given resource described by <code><a href="ft2-base_interface.html#ft_open_args">FT_Open_Args</a></code>.</p>
3368 <h4>inout</h4>
3369
3370 <table class="fields">
3371 <tr><td class="val" id="library">library</td><td class="desc">
3372 <p>A handle to the library resource.</p>
3373 </td></tr>
3374 </table>
3375
3376 <h4>input</h4>
3377
3378 <table class="fields">
3379 <tr><td class="val" id="args">args</td><td class="desc">
3380 <p>A pointer to an <code>FT_Open_Args</code> structure that must be filled by the caller.</p>
3381 </td></tr>
3382 <tr><td class="val" id="face_index">face_index</td><td class="desc">
3383 <p>This field holds two different values. Bits 0-15 are the index of the face in the font file (starting with value&nbsp;0). Set it to&nbsp;0 if there is only one face in the font file.</p>
3384 <p>[Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation fonts only, specifying the named instance index for the current face index (starting with value&nbsp;1; value&nbsp;0 makes FreeType ignore named instances). For non-variation fonts, bits 16-30 are ignored. Assuming that you want to access the third named instance in face&nbsp;4, <code>face_index</code> should be set to 0x00030004. If you want to access face&nbsp;4 without variation handling, simply set <code>face_index</code> to value&nbsp;4.</p>
3385 <p><code>FT_Open_Face</code> and its siblings can be used to quickly check whether the font format of a given font resource is supported by FreeType. In general, if the <code>face_index</code> argument is negative, the function's return value is&nbsp;0 if the font format is recognized, or non-zero otherwise. The function allocates a more or less empty face handle in <code>*aface</code> (if <code>aface</code> isn't <code>NULL</code>); the only two useful fields in this special case are <code>face-&gt;num_faces</code> and <code>face-&gt;style_flags</code>. For any negative value of <code>face_index</code>, <code>face-&gt;num_faces</code> gives the number of faces within the font file. For the negative value &lsquo;-(N+1)&rsquo; (with &lsquo;N&rsquo; a non-negative 16-bit value), bits 16-30 in <code>face-&gt;style_flags</code> give the number of named instances in face &lsquo;N&rsquo; if we have a variation font (or zero otherwise). After examination, the returned <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> structure should be deallocated with a call to <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code>.</p>
3386 </td></tr>
3387 </table>
3388
3389 <h4>output</h4>
3390
3391 <table class="fields">
3392 <tr><td class="val" id="aface">aface</td><td class="desc">
3393 <p>A handle to a new face object. If <code>face_index</code> is greater than or equal to zero, it must be non-<code>NULL</code>.</p>
3394 </td></tr>
3395 </table>
3396
3397 <h4>return</h4>
3398
3399 <p>FreeType error code. 0&nbsp;means success.</p>
3400 <h4>note</h4>
3401
3402 <p>Unlike FreeType 1.x, this function automatically creates a glyph slot for the face object that can be accessed directly through <code>face-&gt;glyph</code>.</p>
3403 <p>Each new face object created with this function also owns a default <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object, accessible as <code>face-&gt;size</code>.</p>
3404 <p>One <code><a href="ft2-base_interface.html#ft_library">FT_Library</a></code> instance can have multiple face objects, this is, <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> and its siblings can be called multiple times using the same <code>library</code> argument.</p>
3405 <p>See the discussion of reference counters in the description of <code><a href="ft2-base_interface.html#ft_reference_face">FT_Reference_Face</a></code>.</p>
3406 <h4>example</h4>
3407
3408 <p>To loop over all faces, use code similar to the following snippet (omitting the error handling).
3409 <div class="highlight"><pre><span></span><code>  ...
3410   FT_Face  face;
3411   FT_Long  i, num_faces;
3412
3413
3414   error = FT_Open_Face( library, args, -1, &amp;face );
3415   if ( error ) { ... }
3416
3417   num_faces = face-&gt;num_faces;
3418   FT_Done_Face( face );
3419
3420   for ( i = 0; i &lt; num_faces; i++ )
3421   {
3422     ...
3423     error = FT_Open_Face( library, args, i, &amp;face );
3424     ...
3425     FT_Done_Face( face );
3426     ...
3427   }
3428 </code></pre></div></p>
3429 <p>To loop over all valid values for <code>face_index</code>, use something similar to the following snippet, again without error handling. The code accesses all faces immediately (thus only a single call of <code>FT_Open_Face</code> within the do-loop), with and without named instances.
3430 <div class="highlight"><pre><span></span><code>  ...
3431   FT_Face  face;
3432
3433   FT_Long  num_faces     = 0;
3434   FT_Long  num_instances = 0;
3435
3436   FT_Long  face_idx     = 0;
3437   FT_Long  instance_idx = 0;
3438
3439
3440   do
3441   {
3442     FT_Long  id = ( instance_idx &lt;&lt; 16 ) + face_idx;
3443
3444
3445     error = FT_Open_Face( library, args, id, &amp;face );
3446     if ( error ) { ... }
3447
3448     num_faces     = face-&gt;num_faces;
3449     num_instances = face-&gt;style_flags &gt;&gt; 16;
3450
3451     ...
3452
3453     FT_Done_Face( face );
3454
3455     if ( instance_idx &lt; num_instances )
3456       instance_idx++;
3457     else
3458     {
3459       face_idx++;
3460       instance_idx = 0;
3461     }
3462
3463   } while ( face_idx &lt; num_faces )
3464 </code></pre></div></p>
3465 <hr>
3466
3467 <h2 id="ft_open_args">FT_Open_Args<a class="headerlink" href="#ft_open_args" title="Permanent link">&para;</a></h2>
3468 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3469 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Open_Args_
3470   {
3471     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>         flags;
3472     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>*  memory_base;
3473     <a href="ft2-basic_types.html#ft_long">FT_Long</a>         memory_size;
3474     <a href="ft2-basic_types.html#ft_string">FT_String</a>*      pathname;
3475     <a href="ft2-system_interface.html#ft_stream">FT_Stream</a>       stream;
3476     <a href="ft2-module_management.html#ft_module">FT_Module</a>       driver;
3477     <a href="ft2-basic_types.html#ft_int">FT_Int</a>          num_params;
3478     <a href="ft2-base_interface.html#ft_parameter">FT_Parameter</a>*   params;
3479
3480   } <b>FT_Open_Args</b>;
3481 </code></pre></div>
3482
3483 <p>A structure to indicate how to open a new font file or stream. A pointer to such a structure can be used as a parameter for the functions <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> and <code><a href="ft2-base_interface.html#ft_attach_stream">FT_Attach_Stream</a></code>.</p>
3484 <h4>fields</h4>
3485
3486 <table class="fields">
3487 <tr><td class="val" id="flags">flags</td><td class="desc">
3488 <p>A set of bit flags indicating how to use the structure.</p>
3489 </td></tr>
3490 <tr><td class="val" id="memory_base">memory_base</td><td class="desc">
3491 <p>The first byte of the file in memory.</p>
3492 </td></tr>
3493 <tr><td class="val" id="memory_size">memory_size</td><td class="desc">
3494 <p>The size in bytes of the file in memory.</p>
3495 </td></tr>
3496 <tr><td class="val" id="pathname">pathname</td><td class="desc">
3497 <p>A pointer to an 8-bit file pathname. The pointer is not owned by FreeType.</p>
3498 </td></tr>
3499 <tr><td class="val" id="stream">stream</td><td class="desc">
3500 <p>A handle to a source stream object.</p>
3501 </td></tr>
3502 <tr><td class="val" id="driver">driver</td><td class="desc">
3503 <p>This field is exclusively used by <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code>; it simply specifies the font driver to use for opening the face. If set to <code>NULL</code>, FreeType tries to load the face with each one of the drivers in its list.</p>
3504 </td></tr>
3505 <tr><td class="val" id="num_params">num_params</td><td class="desc">
3506 <p>The number of extra parameters.</p>
3507 </td></tr>
3508 <tr><td class="val" id="params">params</td><td class="desc">
3509 <p>Extra parameters passed to the font driver when opening a new face.</p>
3510 </td></tr>
3511 </table>
3512
3513 <h4>note</h4>
3514
3515 <p>The stream type is determined by the contents of <code>flags</code> that are tested in the following order by <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code>:</p>
3516 <p>If the <code><a href="ft2-base_interface.html#ft_open_xxx">FT_OPEN_MEMORY</a></code> bit is set, assume that this is a memory file of <code>memory_size</code> bytes, located at <code>memory_address</code>. The data are not copied, and the client is responsible for releasing and destroying them <em>after</em> the corresponding call to <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code>.</p>
3517 <p>Otherwise, if the <code><a href="ft2-base_interface.html#ft_open_xxx">FT_OPEN_STREAM</a></code> bit is set, assume that a custom input stream <code>stream</code> is used.</p>
3518 <p>Otherwise, if the <code><a href="ft2-base_interface.html#ft_open_xxx">FT_OPEN_PATHNAME</a></code> bit is set, assume that this is a normal file and use <code>pathname</code> to open it.</p>
3519 <p>If the <code><a href="ft2-base_interface.html#ft_open_xxx">FT_OPEN_DRIVER</a></code> bit is set, <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> only tries to open the file with the driver whose handler is in <code>driver</code>.</p>
3520 <p>If the <code><a href="ft2-base_interface.html#ft_open_xxx">FT_OPEN_PARAMS</a></code> bit is set, the parameters given by <code>num_params</code> and <code>params</code> is used. They are ignored otherwise.</p>
3521 <p>Ideally, both the <code>pathname</code> and <code>params</code> fields should be tagged as &lsquo;const&rsquo;; this is missing for API backward compatibility. In other words, applications should treat them as read-only.</p>
3522 <hr>
3523
3524 <h2 id="ft_parameter">FT_Parameter<a class="headerlink" href="#ft_parameter" title="Permanent link">&para;</a></h2>
3525 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3526 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Parameter_
3527   {
3528     <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>    tag;
3529     <a href="ft2-basic_types.html#ft_pointer">FT_Pointer</a>  data;
3530
3531   } <b>FT_Parameter</b>;
3532 </code></pre></div>
3533
3534 <p>A simple structure to pass more or less generic parameters to <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code> and <code><a href="ft2-base_interface.html#ft_face_properties">FT_Face_Properties</a></code>.</p>
3535 <h4>fields</h4>
3536
3537 <table class="fields">
3538 <tr><td class="val" id="tag">tag</td><td class="desc">
3539 <p>A four-byte identification tag.</p>
3540 </td></tr>
3541 <tr><td class="val" id="data">data</td><td class="desc">
3542 <p>A pointer to the parameter data.</p>
3543 </td></tr>
3544 </table>
3545
3546 <h4>note</h4>
3547
3548 <p>The ID and function of parameters are driver-specific. See section &lsquo;<a href="ft2-parameter_tags.html#parameter_tags">Parameter Tags</a>&rsquo; for more information.</p>
3549 <hr>
3550
3551 <h2 id="ft_attach_file">FT_Attach_File<a class="headerlink" href="#ft_attach_file" title="Permanent link">&para;</a></h2>
3552 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3553 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3554   <b>FT_Attach_File</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>      face,
3555                   <span class="keyword">const</span> <span class="keyword">char</span>*  filepathname );
3556 </code></pre></div>
3557
3558 <p>Call <code><a href="ft2-base_interface.html#ft_attach_stream">FT_Attach_Stream</a></code> to attach a file.</p>
3559 <h4>inout</h4>
3560
3561 <table class="fields">
3562 <tr><td class="val" id="face">face</td><td class="desc">
3563 <p>The target face object.</p>
3564 </td></tr>
3565 </table>
3566
3567 <h4>input</h4>
3568
3569 <table class="fields">
3570 <tr><td class="val" id="filepathname">filepathname</td><td class="desc">
3571 <p>The pathname.</p>
3572 </td></tr>
3573 </table>
3574
3575 <h4>return</h4>
3576
3577 <p>FreeType error code. 0&nbsp;means success.</p>
3578 <hr>
3579
3580 <h2 id="ft_attach_stream">FT_Attach_Stream<a class="headerlink" href="#ft_attach_stream" title="Permanent link">&para;</a></h2>
3581 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3582 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3583   <b>FT_Attach_Stream</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>        face,
3584                     <a href="ft2-base_interface.html#ft_open_args">FT_Open_Args</a>*  parameters );
3585 </code></pre></div>
3586
3587 <p>&lsquo;Attach&rsquo; data to a face object. Normally, this is used to read additional information for the face object. For example, you can attach an AFM file that comes with a Type&nbsp;1 font to get the kerning values and other metrics.</p>
3588 <h4>inout</h4>
3589
3590 <table class="fields">
3591 <tr><td class="val" id="face">face</td><td class="desc">
3592 <p>The target face object.</p>
3593 </td></tr>
3594 </table>
3595
3596 <h4>input</h4>
3597
3598 <table class="fields">
3599 <tr><td class="val" id="parameters">parameters</td><td class="desc">
3600 <p>A pointer to <code><a href="ft2-base_interface.html#ft_open_args">FT_Open_Args</a></code> that must be filled by the caller.</p>
3601 </td></tr>
3602 </table>
3603
3604 <h4>return</h4>
3605
3606 <p>FreeType error code. 0&nbsp;means success.</p>
3607 <h4>note</h4>
3608
3609 <p>The meaning of the &lsquo;attach&rsquo; (i.e., what really happens when the new file is read) is not fixed by FreeType itself. It really depends on the font format (and thus the font driver).</p>
3610 <p>Client applications are expected to know what they are doing when invoking this function. Most drivers simply do not implement file or stream attachments.</p>
3611 <hr>
3612
3613 <h2 id="ft_set_char_size">FT_Set_Char_Size<a class="headerlink" href="#ft_set_char_size" title="Permanent link">&para;</a></h2>
3614 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3615 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3616   <b>FT_Set_Char_Size</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
3617                     <a href="ft2-basic_types.html#ft_f26dot6">FT_F26Dot6</a>  char_width,
3618                     <a href="ft2-basic_types.html#ft_f26dot6">FT_F26Dot6</a>  char_height,
3619                     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     horz_resolution,
3620                     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     vert_resolution );
3621 </code></pre></div>
3622
3623 <p>Call <code><a href="ft2-base_interface.html#ft_request_size">FT_Request_Size</a></code> to request the nominal size (in points).</p>
3624 <h4>inout</h4>
3625
3626 <table class="fields">
3627 <tr><td class="val" id="face">face</td><td class="desc">
3628 <p>A handle to a target face object.</p>
3629 </td></tr>
3630 </table>
3631
3632 <h4>input</h4>
3633
3634 <table class="fields">
3635 <tr><td class="val" id="char_width">char_width</td><td class="desc">
3636 <p>The nominal width, in 26.6 fractional points.</p>
3637 </td></tr>
3638 <tr><td class="val" id="char_height">char_height</td><td class="desc">
3639 <p>The nominal height, in 26.6 fractional points.</p>
3640 </td></tr>
3641 <tr><td class="val" id="horz_resolution">horz_resolution</td><td class="desc">
3642 <p>The horizontal resolution in dpi.</p>
3643 </td></tr>
3644 <tr><td class="val" id="vert_resolution">vert_resolution</td><td class="desc">
3645 <p>The vertical resolution in dpi.</p>
3646 </td></tr>
3647 </table>
3648
3649 <h4>return</h4>
3650
3651 <p>FreeType error code. 0&nbsp;means success.</p>
3652 <h4>note</h4>
3653
3654 <p>While this function allows fractional points as input values, the resulting ppem value for the given resolution is always rounded to the nearest integer.</p>
3655 <p>If either the character width or height is zero, it is set equal to the other value.</p>
3656 <p>If either the horizontal or vertical resolution is zero, it is set equal to the other value.</p>
3657 <p>A character width or height smaller than 1pt is set to 1pt; if both resolution values are zero, they are set to 72dpi.</p>
3658 <p>Don't use this function if you are using the FreeType cache API.</p>
3659 <hr>
3660
3661 <h2 id="ft_set_pixel_sizes">FT_Set_Pixel_Sizes<a class="headerlink" href="#ft_set_pixel_sizes" title="Permanent link">&para;</a></h2>
3662 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3663 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3664   <b>FT_Set_Pixel_Sizes</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face,
3665                       <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>  pixel_width,
3666                       <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>  pixel_height );
3667 </code></pre></div>
3668
3669 <p>Call <code><a href="ft2-base_interface.html#ft_request_size">FT_Request_Size</a></code> to request the nominal size (in pixels).</p>
3670 <h4>inout</h4>
3671
3672 <table class="fields">
3673 <tr><td class="val" id="face">face</td><td class="desc">
3674 <p>A handle to the target face object.</p>
3675 </td></tr>
3676 </table>
3677
3678 <h4>input</h4>
3679
3680 <table class="fields">
3681 <tr><td class="val" id="pixel_width">pixel_width</td><td class="desc">
3682 <p>The nominal width, in pixels.</p>
3683 </td></tr>
3684 <tr><td class="val" id="pixel_height">pixel_height</td><td class="desc">
3685 <p>The nominal height, in pixels.</p>
3686 </td></tr>
3687 </table>
3688
3689 <h4>return</h4>
3690
3691 <p>FreeType error code. 0&nbsp;means success.</p>
3692 <h4>note</h4>
3693
3694 <p>You should not rely on the resulting glyphs matching or being constrained to this pixel size. Refer to <code><a href="ft2-base_interface.html#ft_request_size">FT_Request_Size</a></code> to understand how requested sizes relate to actual sizes.</p>
3695 <p>Don't use this function if you are using the FreeType cache API.</p>
3696 <hr>
3697
3698 <h2 id="ft_request_size">FT_Request_Size<a class="headerlink" href="#ft_request_size" title="Permanent link">&para;</a></h2>
3699 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3700 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3701   <b>FT_Request_Size</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>          face,
3702                    <a href="ft2-base_interface.html#ft_size_request">FT_Size_Request</a>  req );
3703 </code></pre></div>
3704
3705 <p>Resize the scale of the active <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object in a face.</p>
3706 <h4>inout</h4>
3707
3708 <table class="fields">
3709 <tr><td class="val" id="face">face</td><td class="desc">
3710 <p>A handle to a target face object.</p>
3711 </td></tr>
3712 </table>
3713
3714 <h4>input</h4>
3715
3716 <table class="fields">
3717 <tr><td class="val" id="req">req</td><td class="desc">
3718 <p>A pointer to a <code><a href="ft2-base_interface.html#ft_size_requestrec">FT_Size_RequestRec</a></code>.</p>
3719 </td></tr>
3720 </table>
3721
3722 <h4>return</h4>
3723
3724 <p>FreeType error code. 0&nbsp;means success.</p>
3725 <h4>note</h4>
3726
3727 <p>Although drivers may select the bitmap strike matching the request, you should not rely on this if you intend to select a particular bitmap strike. Use <code><a href="ft2-base_interface.html#ft_select_size">FT_Select_Size</a></code> instead in that case.</p>
3728 <p>The relation between the requested size and the resulting glyph size is dependent entirely on how the size is defined in the source face. The font designer chooses the final size of each glyph relative to this size. For more information refer to &lsquo;<a href="https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html">https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html</a>&rsquo;.</p>
3729 <p>Contrary to <code><a href="ft2-base_interface.html#ft_set_char_size">FT_Set_Char_Size</a></code>, this function doesn't have special code to normalize zero-valued widths, heights, or resolutions (which lead to errors in most cases).</p>
3730 <p>Don't use this function if you are using the FreeType cache API.</p>
3731 <hr>
3732
3733 <h2 id="ft_select_size">FT_Select_Size<a class="headerlink" href="#ft_select_size" title="Permanent link">&para;</a></h2>
3734 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3735 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3736   <b>FT_Select_Size</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face,
3737                   <a href="ft2-basic_types.html#ft_int">FT_Int</a>   strike_index );
3738 </code></pre></div>
3739
3740 <p>Select a bitmap strike. To be more precise, this function sets the scaling factors of the active <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object in a face so that bitmaps from this particular strike are taken by <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> and friends.</p>
3741 <h4>inout</h4>
3742
3743 <table class="fields">
3744 <tr><td class="val" id="face">face</td><td class="desc">
3745 <p>A handle to a target face object.</p>
3746 </td></tr>
3747 </table>
3748
3749 <h4>input</h4>
3750
3751 <table class="fields">
3752 <tr><td class="val" id="strike_index">strike_index</td><td class="desc">
3753 <p>The index of the bitmap strike in the <code>available_sizes</code> field of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> structure.</p>
3754 </td></tr>
3755 </table>
3756
3757 <h4>return</h4>
3758
3759 <p>FreeType error code. 0&nbsp;means success.</p>
3760 <h4>note</h4>
3761
3762 <p>For bitmaps embedded in outline fonts it is common that only a subset of the available glyphs at a given ppem value is available. FreeType silently uses outlines if there is no bitmap for a given glyph index.</p>
3763 <p>For GX and OpenType variation fonts, a bitmap strike makes sense only if the default instance is active (this is, no glyph variation takes place); otherwise, FreeType simply ignores bitmap strikes. The same is true for all named instances that are different from the default instance.</p>
3764 <p>Don't use this function if you are using the FreeType cache API.</p>
3765 <hr>
3766
3767 <h2 id="ft_size_request_type">FT_Size_Request_Type<a class="headerlink" href="#ft_size_request_type" title="Permanent link">&para;</a></h2>
3768 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3769 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Size_Request_Type_
3770   {
3771     <a href="ft2-base_interface.html#ft_size_request_type_nominal">FT_SIZE_REQUEST_TYPE_NOMINAL</a>,
3772     <a href="ft2-base_interface.html#ft_size_request_type_real_dim">FT_SIZE_REQUEST_TYPE_REAL_DIM</a>,
3773     <a href="ft2-base_interface.html#ft_size_request_type_bbox">FT_SIZE_REQUEST_TYPE_BBOX</a>,
3774     <a href="ft2-base_interface.html#ft_size_request_type_cell">FT_SIZE_REQUEST_TYPE_CELL</a>,
3775     <a href="ft2-base_interface.html#ft_size_request_type_scales">FT_SIZE_REQUEST_TYPE_SCALES</a>,
3776
3777     FT_SIZE_REQUEST_TYPE_MAX
3778
3779   } <b>FT_Size_Request_Type</b>;
3780 </code></pre></div>
3781
3782 <p>An enumeration type that lists the supported size request types, i.e., what input size (in font units) maps to the requested output size (in pixels, as computed from the arguments of <code><a href="ft2-base_interface.html#ft_size_request">FT_Size_Request</a></code>).</p>
3783 <h4>values</h4>
3784
3785 <table class="fields long">
3786 <tr><td class="val" id="ft_size_request_type_nominal">FT_SIZE_REQUEST_TYPE_NOMINAL</td><td class="desc">
3787 <p>The nominal size. The <code>units_per_EM</code> field of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> is used to determine both scaling values.</p>
3788 <p>This is the standard scaling found in most applications. In particular, use this size request type for TrueType fonts if they provide optical scaling or something similar. Note, however, that <code>units_per_EM</code> is a rather abstract value which bears no relation to the actual size of the glyphs in a font.</p>
3789 </td></tr>
3790 <tr><td class="val" id="ft_size_request_type_real_dim">FT_SIZE_REQUEST_TYPE_REAL_DIM</td><td class="desc">
3791 <p>The real dimension. The sum of the <code>ascender</code> and (minus of) the <code>descender</code> fields of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> is used to determine both scaling values.</p>
3792 </td></tr>
3793 <tr><td class="val" id="ft_size_request_type_bbox">FT_SIZE_REQUEST_TYPE_BBOX</td><td class="desc">
3794 <p>The font bounding box. The width and height of the <code>bbox</code> field of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> are used to determine the horizontal and vertical scaling value, respectively.</p>
3795 </td></tr>
3796 <tr><td class="val" id="ft_size_request_type_cell">FT_SIZE_REQUEST_TYPE_CELL</td><td class="desc">
3797 <p>The <code>max_advance_width</code> field of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> is used to determine the horizontal scaling value; the vertical scaling value is determined the same way as <code><a href="ft2-base_interface.html#ft_size_request_type">FT_SIZE_REQUEST_TYPE_REAL_DIM</a></code> does. Finally, both scaling values are set to the smaller one. This type is useful if you want to specify the font size for, say, a window of a given dimension and 80x24 cells.</p>
3798 </td></tr>
3799 <tr><td class="val" id="ft_size_request_type_scales">FT_SIZE_REQUEST_TYPE_SCALES</td><td class="desc">
3800 <p>Specify the scaling values directly.</p>
3801 </td></tr>
3802 </table>
3803
3804 <h4>note</h4>
3805
3806 <p>The above descriptions only apply to scalable formats. For bitmap formats, the behaviour is up to the driver.</p>
3807 <p>See the note section of <code><a href="ft2-base_interface.html#ft_size_metrics">FT_Size_Metrics</a></code> if you wonder how size requesting relates to scaling values.</p>
3808 <hr>
3809
3810 <h2 id="ft_size_requestrec">FT_Size_RequestRec<a class="headerlink" href="#ft_size_requestrec" title="Permanent link">&para;</a></h2>
3811 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3812 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Size_RequestRec_
3813   {
3814     <a href="ft2-base_interface.html#ft_size_request_type">FT_Size_Request_Type</a>  type;
3815     <a href="ft2-basic_types.html#ft_long">FT_Long</a>               width;
3816     <a href="ft2-basic_types.html#ft_long">FT_Long</a>               height;
3817     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>               horiResolution;
3818     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>               vertResolution;
3819
3820   } <b>FT_Size_RequestRec</b>;
3821 </code></pre></div>
3822
3823 <p>A structure to model a size request.</p>
3824 <h4>fields</h4>
3825
3826 <table class="fields">
3827 <tr><td class="val" id="type">type</td><td class="desc">
3828 <p>See <code><a href="ft2-base_interface.html#ft_size_request_type">FT_Size_Request_Type</a></code>.</p>
3829 </td></tr>
3830 <tr><td class="val" id="width">width</td><td class="desc">
3831 <p>The desired width, given as a 26.6 fractional point value (with 72pt = 1in).</p>
3832 </td></tr>
3833 <tr><td class="val" id="height">height</td><td class="desc">
3834 <p>The desired height, given as a 26.6 fractional point value (with 72pt = 1in).</p>
3835 </td></tr>
3836 <tr><td class="val" id="horiresolution">horiResolution</td><td class="desc">
3837 <p>The horizontal resolution (dpi, i.e., pixels per inch). If set to zero, <code>width</code> is treated as a 26.6 fractional <strong>pixel</strong> value, which gets internally rounded to an integer.</p>
3838 </td></tr>
3839 <tr><td class="val" id="vertresolution">vertResolution</td><td class="desc">
3840 <p>The vertical resolution (dpi, i.e., pixels per inch). If set to zero, <code>height</code> is treated as a 26.6 fractional <strong>pixel</strong> value, which gets internally rounded to an integer.</p>
3841 </td></tr>
3842 </table>
3843
3844 <h4>note</h4>
3845
3846 <p>If <code>width</code> is zero, the horizontal scaling value is set equal to the vertical scaling value, and vice versa.</p>
3847 <p>If <code>type</code> is <code>FT_SIZE_REQUEST_TYPE_SCALES</code>, <code>width</code> and <code>height</code> are interpreted directly as 16.16 fractional scaling values, without any further modification, and both <code>horiResolution</code> and <code>vertResolution</code> are ignored.</p>
3848 <hr>
3849
3850 <h2 id="ft_size_request">FT_Size_Request<a class="headerlink" href="#ft_size_request" title="Permanent link">&para;</a></h2>
3851 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3852 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Size_RequestRec_  *<b>FT_Size_Request</b>;
3853 </code></pre></div>
3854
3855 <p>A handle to a size request structure.</p>
3856 <hr>
3857
3858 <h2 id="ft_set_transform">FT_Set_Transform<a class="headerlink" href="#ft_set_transform" title="Permanent link">&para;</a></h2>
3859 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3860 <div class = "codehilite"><pre><code>  FT_EXPORT( <span class="keyword">void</span> )
3861   <b>FT_Set_Transform</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
3862                     <a href="ft2-basic_types.html#ft_matrix">FT_Matrix</a>*  matrix,
3863                     <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>*  delta );
3864 </code></pre></div>
3865
3866 <p>Set the transformation that is applied to glyph images when they are loaded into a glyph slot through <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
3867 <h4>inout</h4>
3868
3869 <table class="fields">
3870 <tr><td class="val" id="face">face</td><td class="desc">
3871 <p>A handle to the source face object.</p>
3872 </td></tr>
3873 </table>
3874
3875 <h4>input</h4>
3876
3877 <table class="fields">
3878 <tr><td class="val" id="matrix">matrix</td><td class="desc">
3879 <p>A pointer to the transformation's 2x2 matrix. Use <code>NULL</code> for the identity matrix.</p>
3880 </td></tr>
3881 <tr><td class="val" id="delta">delta</td><td class="desc">
3882 <p>A pointer to the translation vector. Use <code>NULL</code> for the null vector.</p>
3883 </td></tr>
3884 </table>
3885
3886 <h4>note</h4>
3887
3888 <p>This function is provided as a convenience, but keep in mind that <code><a href="ft2-basic_types.html#ft_matrix">FT_Matrix</a></code> coefficients are only 16.16 fixed point values, which can limit the accuracy of the results. Using floating-point computations to perform the transform directly in client code instead will always yield better numbers.</p>
3889 <p>The transformation is only applied to scalable image formats after the glyph has been loaded. It means that hinting is unaltered by the transformation and is performed on the character size given in the last call to <code><a href="ft2-base_interface.html#ft_set_char_size">FT_Set_Char_Size</a></code> or <code><a href="ft2-base_interface.html#ft_set_pixel_sizes">FT_Set_Pixel_Sizes</a></code>.</p>
3890 <p>Note that this also transforms the <code>face.glyph.advance</code> field, but <strong>not</strong> the values in <code>face.glyph.metrics</code>.</p>
3891 <hr>
3892
3893 <h2 id="ft_load_glyph">FT_Load_Glyph<a class="headerlink" href="#ft_load_glyph" title="Permanent link">&para;</a></h2>
3894 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3895 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
3896   <b>FT_Load_Glyph</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
3897                  <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>   glyph_index,
3898                  <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>  load_flags );
3899 </code></pre></div>
3900
3901 <p>Load a glyph into the glyph slot of a face object.</p>
3902 <h4>inout</h4>
3903
3904 <table class="fields">
3905 <tr><td class="val" id="face">face</td><td class="desc">
3906 <p>A handle to the target face object where the glyph is loaded.</p>
3907 </td></tr>
3908 </table>
3909
3910 <h4>input</h4>
3911
3912 <table class="fields">
3913 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
3914 <p>The index of the glyph in the font file. For CID-keyed fonts (either in PS or in CFF format) this argument specifies the CID value.</p>
3915 </td></tr>
3916 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
3917 <p>A flag indicating what to load for this glyph. The <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_XXX</a></code> constants can be used to control the glyph loading process (e.g., whether the outline should be scaled, whether to load bitmaps or not, whether to hint the outline, etc).</p>
3918 </td></tr>
3919 </table>
3920
3921 <h4>return</h4>
3922
3923 <p>FreeType error code. 0&nbsp;means success.</p>
3924 <h4>note</h4>
3925
3926 <p>The loaded glyph may be transformed. See <code><a href="ft2-base_interface.html#ft_set_transform">FT_Set_Transform</a></code> for the details.</p>
3927 <p>For subsetted CID-keyed fonts, <code>FT_Err_Invalid_Argument</code> is returned for invalid CID values (this is, for CID values that don't have a corresponding glyph in the font). See the discussion of the <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_CID_KEYED</a></code> flag for more details.</p>
3928 <p>If you receive <code>FT_Err_Glyph_Too_Big</code>, try getting the glyph outline at EM size, then scale it manually and fill it as a graphics operation.</p>
3929 <hr>
3930
3931 <h2 id="ft_get_char_index">FT_Get_Char_Index<a class="headerlink" href="#ft_get_char_index" title="Permanent link">&para;</a></h2>
3932 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3933 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> )
3934   <b>FT_Get_Char_Index</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
3935                      <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>  charcode );
3936 </code></pre></div>
3937
3938 <p>Return the glyph index of a given character code. This function uses the currently selected charmap to do the mapping.</p>
3939 <h4>input</h4>
3940
3941 <table class="fields">
3942 <tr><td class="val" id="face">face</td><td class="desc">
3943 <p>A handle to the source face object.</p>
3944 </td></tr>
3945 <tr><td class="val" id="charcode">charcode</td><td class="desc">
3946 <p>The character code.</p>
3947 </td></tr>
3948 </table>
3949
3950 <h4>return</h4>
3951
3952 <p>The glyph index. 0&nbsp;means &lsquo;undefined character code&rsquo;.</p>
3953 <h4>note</h4>
3954
3955 <p>If you use FreeType to manipulate the contents of font files directly, be aware that the glyph index returned by this function doesn't always correspond to the internal indices used within the file. This is done to ensure that value&nbsp;0 always corresponds to the &lsquo;missing glyph&rsquo;. If the first glyph is not named &lsquo;.notdef&rsquo;, then for Type&nbsp;1 and Type&nbsp;42 fonts, &lsquo;.notdef&rsquo; will be moved into the glyph ID&nbsp;0 position, and whatever was there will be moved to the position &lsquo;.notdef&rsquo; had. For Type&nbsp;1 fonts, if there is no &lsquo;.notdef&rsquo; glyph at all, then one will be created at index&nbsp;0 and whatever was there will be moved to the last index -- Type&nbsp;42 fonts are considered invalid under this condition.</p>
3956 <hr>
3957
3958 <h2 id="ft_get_first_char">FT_Get_First_Char<a class="headerlink" href="#ft_get_first_char" title="Permanent link">&para;</a></h2>
3959 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
3960 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a> )
3961   <b>FT_Get_First_Char</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
3962                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>  *agindex );
3963 </code></pre></div>
3964
3965 <p>Return the first character code in the current charmap of a given face, together with its corresponding glyph index.</p>
3966 <h4>input</h4>
3967
3968 <table class="fields">
3969 <tr><td class="val" id="face">face</td><td class="desc">
3970 <p>A handle to the source face object.</p>
3971 </td></tr>
3972 </table>
3973
3974 <h4>output</h4>
3975
3976 <table class="fields">
3977 <tr><td class="val" id="agindex">agindex</td><td class="desc">
3978 <p>Glyph index of first character code. 0&nbsp;if charmap is empty.</p>
3979 </td></tr>
3980 </table>
3981
3982 <h4>return</h4>
3983
3984 <p>The charmap's first character code.</p>
3985 <h4>note</h4>
3986
3987 <p>You should use this function together with <code><a href="ft2-base_interface.html#ft_get_next_char">FT_Get_Next_Char</a></code> to parse all character codes available in a given charmap. The code should look like this:
3988 <div class="highlight"><pre><span></span><code>  FT_ULong  charcode;
3989   FT_UInt   gindex;
3990
3991
3992   charcode = FT_Get_First_Char( face, &amp;gindex );
3993   while ( gindex != 0 )
3994   {
3995     ... do something with (charcode,gindex) pair ...
3996
3997     charcode = FT_Get_Next_Char( face, charcode, &amp;gindex );
3998   }
3999 </code></pre></div></p>
4000 <p>Be aware that character codes can have values up to 0xFFFFFFFF; this might happen for non-Unicode or malformed cmaps. However, even with regular Unicode encoding, so-called &lsquo;last resort fonts&rsquo; (using SFNT cmap format 13, see function <code><a href="ft2-truetype_tables.html#ft_get_cmap_format">FT_Get_CMap_Format</a></code>) normally have entries for all Unicode characters up to 0x1FFFFF, which can cause <em>a lot</em> of iterations.</p>
4001 <p>Note that <code>*agindex</code> is set to&nbsp;0 if the charmap is empty. The result itself can be&nbsp;0 in two cases: if the charmap is empty or if the value&nbsp;0 is the first valid character code.</p>
4002 <hr>
4003
4004 <h2 id="ft_get_next_char">FT_Get_Next_Char<a class="headerlink" href="#ft_get_next_char" title="Permanent link">&para;</a></h2>
4005 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4006 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a> )
4007   <b>FT_Get_Next_Char</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>    face,
4008                     <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>   char_code,
4009                     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>   *agindex );
4010 </code></pre></div>
4011
4012 <p>Return the next character code in the current charmap of a given face following the value <code>char_code</code>, as well as the corresponding glyph index.</p>
4013 <h4>input</h4>
4014
4015 <table class="fields">
4016 <tr><td class="val" id="face">face</td><td class="desc">
4017 <p>A handle to the source face object.</p>
4018 </td></tr>
4019 <tr><td class="val" id="char_code">char_code</td><td class="desc">
4020 <p>The starting character code.</p>
4021 </td></tr>
4022 </table>
4023
4024 <h4>output</h4>
4025
4026 <table class="fields">
4027 <tr><td class="val" id="agindex">agindex</td><td class="desc">
4028 <p>Glyph index of next character code. 0&nbsp;if charmap is empty.</p>
4029 </td></tr>
4030 </table>
4031
4032 <h4>return</h4>
4033
4034 <p>The charmap's next character code.</p>
4035 <h4>note</h4>
4036
4037 <p>You should use this function with <code><a href="ft2-base_interface.html#ft_get_first_char">FT_Get_First_Char</a></code> to walk over all character codes available in a given charmap. See the note for that function for a simple code example.</p>
4038 <p>Note that <code>*agindex</code> is set to&nbsp;0 when there are no more codes in the charmap.</p>
4039 <hr>
4040
4041 <h2 id="ft_get_name_index">FT_Get_Name_Index<a class="headerlink" href="#ft_get_name_index" title="Permanent link">&para;</a></h2>
4042 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4043 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> )
4044   <b>FT_Get_Name_Index</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face,
4045                      <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_string">FT_String</a>*  glyph_name );
4046 </code></pre></div>
4047
4048 <p>Return the glyph index of a given glyph name.</p>
4049 <h4>input</h4>
4050
4051 <table class="fields">
4052 <tr><td class="val" id="face">face</td><td class="desc">
4053 <p>A handle to the source face object.</p>
4054 </td></tr>
4055 <tr><td class="val" id="glyph_name">glyph_name</td><td class="desc">
4056 <p>The glyph name.</p>
4057 </td></tr>
4058 </table>
4059
4060 <h4>return</h4>
4061
4062 <p>The glyph index. 0&nbsp;means &lsquo;undefined character code&rsquo;.</p>
4063 <hr>
4064
4065 <h2 id="ft_load_char">FT_Load_Char<a class="headerlink" href="#ft_load_char" title="Permanent link">&para;</a></h2>
4066 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4067 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4068   <b>FT_Load_Char</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
4069                 <a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>  char_code,
4070                 <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>  load_flags );
4071 </code></pre></div>
4072
4073 <p>Load a glyph into the glyph slot of a face object, accessed by its character code.</p>
4074 <h4>inout</h4>
4075
4076 <table class="fields">
4077 <tr><td class="val" id="face">face</td><td class="desc">
4078 <p>A handle to a target face object where the glyph is loaded.</p>
4079 </td></tr>
4080 </table>
4081
4082 <h4>input</h4>
4083
4084 <table class="fields">
4085 <tr><td class="val" id="char_code">char_code</td><td class="desc">
4086 <p>The glyph's character code, according to the current charmap used in the face.</p>
4087 </td></tr>
4088 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
4089 <p>A flag indicating what to load for this glyph. The <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_XXX</a></code> constants can be used to control the glyph loading process (e.g., whether the outline should be scaled, whether to load bitmaps or not, whether to hint the outline, etc).</p>
4090 </td></tr>
4091 </table>
4092
4093 <h4>return</h4>
4094
4095 <p>FreeType error code. 0&nbsp;means success.</p>
4096 <h4>note</h4>
4097
4098 <p>This function simply calls <code><a href="ft2-base_interface.html#ft_get_char_index">FT_Get_Char_Index</a></code> and <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
4099 <p>Many fonts contain glyphs that can't be loaded by this function since its glyph indices are not listed in any of the font's charmaps.</p>
4100 <p>If no active cmap is set up (i.e., <code>face-&gt;charmap</code> is zero), the call to <code><a href="ft2-base_interface.html#ft_get_char_index">FT_Get_Char_Index</a></code> is omitted, and the function behaves identically to <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
4101 <hr>
4102
4103 <h2 id="ft_load_target_mode">FT_LOAD_TARGET_MODE<a class="headerlink" href="#ft_load_target_mode" title="Permanent link">&para;</a></h2>
4104 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4105 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_LOAD_TARGET_MODE</b>( x )  ( (<a href="ft2-base_interface.html#ft_render_mode">FT_Render_Mode</a>)( ( (x) &gt;&gt; 16 ) &amp; 15 ) )
4106 </code></pre></div>
4107
4108 <p>Return the <code><a href="ft2-base_interface.html#ft_render_mode">FT_Render_Mode</a></code> corresponding to a given <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_XXX</a></code> value.</p>
4109 <hr>
4110
4111 <h2 id="ft_render_glyph">FT_Render_Glyph<a class="headerlink" href="#ft_render_glyph" title="Permanent link">&para;</a></h2>
4112 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4113 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4114   <b>FT_Render_Glyph</b>( <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a>    slot,
4115                    <a href="ft2-base_interface.html#ft_render_mode">FT_Render_Mode</a>  render_mode );
4116 </code></pre></div>
4117
4118 <p>Convert a given glyph image to a bitmap. It does so by inspecting the glyph image format, finding the relevant renderer, and invoking it.</p>
4119 <h4>inout</h4>
4120
4121 <table class="fields">
4122 <tr><td class="val" id="slot">slot</td><td class="desc">
4123 <p>A handle to the glyph slot containing the image to convert.</p>
4124 </td></tr>
4125 </table>
4126
4127 <h4>input</h4>
4128
4129 <table class="fields">
4130 <tr><td class="val" id="render_mode">render_mode</td><td class="desc">
4131 <p>The render mode used to render the glyph image into a bitmap. See <code><a href="ft2-base_interface.html#ft_render_mode">FT_Render_Mode</a></code> for a list of possible values.</p>
4132 <p>If <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_NORMAL</a></code> is used, a previous call of <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> with flag <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_COLOR</a></code> makes FT_Render_Glyph provide a default blending of colored glyph layers associated with the current glyph slot (provided the font contains such layers) instead of rendering the glyph slot's outline. This is an experimental feature; see <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_COLOR</a></code> for more information.</p>
4133 </td></tr>
4134 </table>
4135
4136 <h4>return</h4>
4137
4138 <p>FreeType error code. 0&nbsp;means success.</p>
4139 <h4>note</h4>
4140
4141 <p>To get meaningful results, font scaling values must be set with functions like <code><a href="ft2-base_interface.html#ft_set_char_size">FT_Set_Char_Size</a></code> before calling <code>FT_Render_Glyph</code>.</p>
4142 <p>When FreeType outputs a bitmap of a glyph, it really outputs an alpha coverage map. If a pixel is completely covered by a filled-in outline, the bitmap contains 0xFF at that pixel, meaning that 0xFF/0xFF fraction of that pixel is covered, meaning the pixel is 100% black (or 0% bright). If a pixel is only 50% covered (value 0x80), the pixel is made 50% black (50% bright or a middle shade of grey). 0% covered means 0% black (100% bright or white).</p>
4143 <p>On high-DPI screens like on smartphones and tablets, the pixels are so small that their chance of being completely covered and therefore completely black are fairly good. On the low-DPI screens, however, the situation is different. The pixels are too large for most of the details of a glyph and shades of gray are the norm rather than the exception.</p>
4144 <p>This is relevant because all our screens have a second problem: they are not linear. 1&nbsp;+&nbsp;1 is not&nbsp;2. Twice the value does not result in twice the brightness. When a pixel is only 50% covered, the coverage map says 50% black, and this translates to a pixel value of 128 when you use 8&nbsp;bits per channel (0-255). However, this does not translate to 50% brightness for that pixel on our sRGB and gamma&nbsp;2.2 screens. Due to their non-linearity, they dwell longer in the darks and only a pixel value of about 186 results in 50% brightness -- 128 ends up too dark on both bright and dark backgrounds. The net result is that dark text looks burnt-out, pixely and blotchy on bright background, bright text too frail on dark backgrounds, and colored text on colored background (for example, red on green) seems to have dark halos or &lsquo;dirt&rsquo; around it. The situation is especially ugly for diagonal stems like in &lsquo;w&rsquo; glyph shapes where the quality of FreeType's anti-aliasing depends on the correct display of grays. On high-DPI screens where smaller, fully black pixels reign supreme, this doesn't matter, but on our low-DPI screens with all the gray shades, it does. 0% and 100% brightness are the same things in linear and non-linear space, just all the shades in-between aren't.</p>
4145 <p>The blending function for placing text over a background is
4146 <div class="highlight"><pre><span></span><code>  dst = alpha * src + (1 - alpha) * dst    ,
4147 </code></pre></div></p>
4148 <p>which is known as the OVER operator.</p>
4149 <p>To correctly composite an antialiased pixel of a glyph onto a surface,</p>
4150 <ol>
4151 <li>
4152 <p>take the foreground and background colors (e.g., in sRGB space) and apply gamma to get them in a linear space,</p>
4153 </li>
4154 <li>
4155 <p>use OVER to blend the two linear colors using the glyph pixel as the alpha value (remember, the glyph bitmap is an alpha coverage bitmap), and</p>
4156 </li>
4157 <li>
4158 <p>apply inverse gamma to the blended pixel and write it back to the image.</p>
4159 </li>
4160 </ol>
4161 <p>Internal testing at Adobe found that a target inverse gamma of&nbsp;1.8 for step&nbsp;3 gives good results across a wide range of displays with an sRGB gamma curve or a similar one.</p>
4162 <p>This process can cost performance. There is an approximation that does not need to know about the background color; see <a href="https://bel.fi/alankila/lcd/">https://bel.fi/alankila/lcd/</a> and <a href="https://bel.fi/alankila/lcd/alpcor.html">https://bel.fi/alankila/lcd/alpcor.html</a> for details.</p>
4163 <p><strong>ATTENTION</strong>: Linear blending is even more important when dealing with subpixel-rendered glyphs to prevent color-fringing! A subpixel-rendered glyph must first be filtered with a filter that gives equal weight to the three color primaries and does not exceed a sum of 0x100, see section &lsquo;<a href="ft2-lcd_rendering.html#lcd_rendering">Subpixel Rendering</a>&rsquo;. Then the only difference to gray linear blending is that subpixel-rendered linear blending is done 3&nbsp;times per pixel: red foreground subpixel to red background subpixel and so on for green and blue.</p>
4164 <hr>
4165
4166 <h2 id="ft_render_mode">FT_Render_Mode<a class="headerlink" href="#ft_render_mode" title="Permanent link">&para;</a></h2>
4167 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4168 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Render_Mode_
4169   {
4170     <a href="ft2-base_interface.html#ft_render_mode_normal">FT_RENDER_MODE_NORMAL</a> = 0,
4171     <a href="ft2-base_interface.html#ft_render_mode_light">FT_RENDER_MODE_LIGHT</a>,
4172     <a href="ft2-base_interface.html#ft_render_mode_mono">FT_RENDER_MODE_MONO</a>,
4173     <a href="ft2-base_interface.html#ft_render_mode_lcd">FT_RENDER_MODE_LCD</a>,
4174     <a href="ft2-base_interface.html#ft_render_mode_lcd_v">FT_RENDER_MODE_LCD_V</a>,
4175
4176     FT_RENDER_MODE_MAX
4177
4178   } <b>FT_Render_Mode</b>;
4179
4180
4181   /* these constants are deprecated; use the corresponding */
4182   /* `<b>FT_Render_Mode</b>` values instead                       */
4183 #<span class="keyword">define</span> ft_render_mode_normal  <a href="ft2-base_interface.html#ft_render_mode_normal">FT_RENDER_MODE_NORMAL</a>
4184 #<span class="keyword">define</span> ft_render_mode_mono    <a href="ft2-base_interface.html#ft_render_mode_mono">FT_RENDER_MODE_MONO</a>
4185 </code></pre></div>
4186
4187 <p>Render modes supported by FreeType&nbsp;2. Each mode corresponds to a specific type of scanline conversion performed on the outline.</p>
4188 <p>For bitmap fonts and embedded bitmaps the <code>bitmap-&gt;pixel_mode</code> field in the <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure gives the format of the returned bitmap.</p>
4189 <p>All modes except <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_MONO</a></code> use 256 levels of opacity, indicating pixel coverage. Use linear alpha blending and gamma correction to correctly render non-monochrome glyph bitmaps onto a surface; see <code><a href="ft2-base_interface.html#ft_render_glyph">FT_Render_Glyph</a></code>.</p>
4190 <h4>values</h4>
4191
4192 <table class="fields">
4193 <tr><td class="val" id="ft_render_mode_normal">FT_RENDER_MODE_NORMAL</td><td class="desc">
4194 <p>Default render mode; it corresponds to 8-bit anti-aliased bitmaps.</p>
4195 </td></tr>
4196 <tr><td class="val" id="ft_render_mode_light">FT_RENDER_MODE_LIGHT</td><td class="desc">
4197 <p>This is equivalent to <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_NORMAL</a></code>. It is only defined as a separate value because render modes are also used indirectly to define hinting algorithm selectors. See <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_XXX</a></code> for details.</p>
4198 </td></tr>
4199 <tr><td class="val" id="ft_render_mode_mono">FT_RENDER_MODE_MONO</td><td class="desc">
4200 <p>This mode corresponds to 1-bit bitmaps (with 2&nbsp;levels of opacity).</p>
4201 </td></tr>
4202 <tr><td class="val" id="ft_render_mode_lcd">FT_RENDER_MODE_LCD</td><td class="desc">
4203 <p>This mode corresponds to horizontal RGB and BGR subpixel displays like LCD screens. It produces 8-bit bitmaps that are 3&nbsp;times the width of the original glyph outline in pixels, and which use the <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_LCD</a></code> mode.</p>
4204 </td></tr>
4205 <tr><td class="val" id="ft_render_mode_lcd_v">FT_RENDER_MODE_LCD_V</td><td class="desc">
4206 <p>This mode corresponds to vertical RGB and BGR subpixel displays (like PDA screens, rotated LCD displays, etc.). It produces 8-bit bitmaps that are 3&nbsp;times the height of the original glyph outline in pixels and use the <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_LCD_V</a></code> mode.</p>
4207 </td></tr>
4208 </table>
4209
4210 <h4>note</h4>
4211
4212 <p>The selected render mode only affects vector glyphs of a font. Embedded bitmaps often have a different pixel mode like <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_MONO</a></code>. You can use <code><a href="ft2-bitmap_handling.html#ft_bitmap_convert">FT_Bitmap_Convert</a></code> to transform them into 8-bit pixmaps.</p>
4213 <hr>
4214
4215 <h2 id="ft_get_kerning">FT_Get_Kerning<a class="headerlink" href="#ft_get_kerning" title="Permanent link">&para;</a></h2>
4216 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4217 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4218   <b>FT_Get_Kerning</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
4219                   <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     left_glyph,
4220                   <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     right_glyph,
4221                   <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     kern_mode,
4222                   <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>  *akerning );
4223 </code></pre></div>
4224
4225 <p>Return the kerning vector between two glyphs of the same face.</p>
4226 <h4>input</h4>
4227
4228 <table class="fields">
4229 <tr><td class="val" id="face">face</td><td class="desc">
4230 <p>A handle to a source face object.</p>
4231 </td></tr>
4232 <tr><td class="val" id="left_glyph">left_glyph</td><td class="desc">
4233 <p>The index of the left glyph in the kern pair.</p>
4234 </td></tr>
4235 <tr><td class="val" id="right_glyph">right_glyph</td><td class="desc">
4236 <p>The index of the right glyph in the kern pair.</p>
4237 </td></tr>
4238 <tr><td class="val" id="kern_mode">kern_mode</td><td class="desc">
4239 <p>See <code><a href="ft2-base_interface.html#ft_kerning_mode">FT_Kerning_Mode</a></code> for more information. Determines the scale and dimension of the returned kerning vector.</p>
4240 </td></tr>
4241 </table>
4242
4243 <h4>output</h4>
4244
4245 <table class="fields">
4246 <tr><td class="val" id="akerning">akerning</td><td class="desc">
4247 <p>The kerning vector. This is either in font units, fractional pixels (26.6 format), or pixels for scalable formats, and in pixels for fixed-sizes formats.</p>
4248 </td></tr>
4249 </table>
4250
4251 <h4>return</h4>
4252
4253 <p>FreeType error code. 0&nbsp;means success.</p>
4254 <h4>note</h4>
4255
4256 <p>Only horizontal layouts (left-to-right &amp; right-to-left) are supported by this method. Other layouts, or more sophisticated kernings, are out of the scope of this API function -- they can be implemented through format-specific interfaces.</p>
4257 <p>Kerning for OpenType fonts implemented in a &lsquo;GPOS&rsquo; table is not supported; use <code><a href="ft2-base_interface.html#ft_has_kerning">FT_HAS_KERNING</a></code> to find out whether a font has data that can be extracted with <code>FT_Get_Kerning</code>.</p>
4258 <hr>
4259
4260 <h2 id="ft_kerning_mode">FT_Kerning_Mode<a class="headerlink" href="#ft_kerning_mode" title="Permanent link">&para;</a></h2>
4261 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4262 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Kerning_Mode_
4263   {
4264     <a href="ft2-base_interface.html#ft_kerning_default">FT_KERNING_DEFAULT</a> = 0,
4265     <a href="ft2-base_interface.html#ft_kerning_unfitted">FT_KERNING_UNFITTED</a>,
4266     <a href="ft2-base_interface.html#ft_kerning_unscaled">FT_KERNING_UNSCALED</a>
4267
4268   } <b>FT_Kerning_Mode</b>;
4269
4270
4271   /* these constants are deprecated; use the corresponding */
4272   /* `<b>FT_Kerning_Mode</b>` values instead                      */
4273 #<span class="keyword">define</span> ft_kerning_default   <a href="ft2-base_interface.html#ft_kerning_default">FT_KERNING_DEFAULT</a>
4274 #<span class="keyword">define</span> ft_kerning_unfitted  <a href="ft2-base_interface.html#ft_kerning_unfitted">FT_KERNING_UNFITTED</a>
4275 #<span class="keyword">define</span> ft_kerning_unscaled  <a href="ft2-base_interface.html#ft_kerning_unscaled">FT_KERNING_UNSCALED</a>
4276 </code></pre></div>
4277
4278 <p>An enumeration to specify the format of kerning values returned by <code><a href="ft2-base_interface.html#ft_get_kerning">FT_Get_Kerning</a></code>.</p>
4279 <h4>values</h4>
4280
4281 <table class="fields">
4282 <tr><td class="val" id="ft_kerning_default">FT_KERNING_DEFAULT</td><td class="desc">
4283 <p>Return grid-fitted kerning distances in 26.6 fractional pixels.</p>
4284 </td></tr>
4285 <tr><td class="val" id="ft_kerning_unfitted">FT_KERNING_UNFITTED</td><td class="desc">
4286 <p>Return un-grid-fitted kerning distances in 26.6 fractional pixels.</p>
4287 </td></tr>
4288 <tr><td class="val" id="ft_kerning_unscaled">FT_KERNING_UNSCALED</td><td class="desc">
4289 <p>Return the kerning vector in original font units.</p>
4290 </td></tr>
4291 </table>
4292
4293 <h4>note</h4>
4294
4295 <p><code>FT_KERNING_DEFAULT</code> returns full pixel values; it also makes FreeType heuristically scale down kerning distances at small ppem values so that they don't become too big.</p>
4296 <p>Both <code>FT_KERNING_DEFAULT</code> and <code>FT_KERNING_UNFITTED</code> use the current horizontal scaling factor (as set e.g. with <code><a href="ft2-base_interface.html#ft_set_char_size">FT_Set_Char_Size</a></code>) to convert font units to pixels.</p>
4297 <hr>
4298
4299 <h2 id="ft_get_track_kerning">FT_Get_Track_Kerning<a class="headerlink" href="#ft_get_track_kerning" title="Permanent link">&para;</a></h2>
4300 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4301 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4302   <b>FT_Get_Track_Kerning</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>    face,
4303                         <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>   point_size,
4304                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>     degree,
4305                         <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>*  akerning );
4306 </code></pre></div>
4307
4308 <p>Return the track kerning for a given face object at a given size.</p>
4309 <h4>input</h4>
4310
4311 <table class="fields">
4312 <tr><td class="val" id="face">face</td><td class="desc">
4313 <p>A handle to a source face object.</p>
4314 </td></tr>
4315 <tr><td class="val" id="point_size">point_size</td><td class="desc">
4316 <p>The point size in 16.16 fractional points.</p>
4317 </td></tr>
4318 <tr><td class="val" id="degree">degree</td><td class="desc">
4319 <p>The degree of tightness. Increasingly negative values represent tighter track kerning, while increasingly positive values represent looser track kerning. Value zero means no track kerning.</p>
4320 </td></tr>
4321 </table>
4322
4323 <h4>output</h4>
4324
4325 <table class="fields">
4326 <tr><td class="val" id="akerning">akerning</td><td class="desc">
4327 <p>The kerning in 16.16 fractional points, to be uniformly applied between all glyphs.</p>
4328 </td></tr>
4329 </table>
4330
4331 <h4>return</h4>
4332
4333 <p>FreeType error code. 0&nbsp;means success.</p>
4334 <h4>note</h4>
4335
4336 <p>Currently, only the Type&nbsp;1 font driver supports track kerning, using data from AFM files (if attached with <code><a href="ft2-base_interface.html#ft_attach_file">FT_Attach_File</a></code> or <code><a href="ft2-base_interface.html#ft_attach_stream">FT_Attach_Stream</a></code>).</p>
4337 <p>Only very few AFM files come with track kerning data; please refer to Adobe's AFM specification for more details.</p>
4338 <hr>
4339
4340 <h2 id="ft_get_glyph_name">FT_Get_Glyph_Name<a class="headerlink" href="#ft_get_glyph_name" title="Permanent link">&para;</a></h2>
4341 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4342 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4343   <b>FT_Get_Glyph_Name</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
4344                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     glyph_index,
4345                      <a href="ft2-basic_types.html#ft_pointer">FT_Pointer</a>  buffer,
4346                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     buffer_max );
4347 </code></pre></div>
4348
4349 <p>Retrieve the ASCII name of a given glyph in a face. This only works for those faces where <code><a href="ft2-base_interface.html#ft_has_glyph_names">FT_HAS_GLYPH_NAMES</a></code>(face) returns&nbsp;1.</p>
4350 <h4>input</h4>
4351
4352 <table class="fields">
4353 <tr><td class="val" id="face">face</td><td class="desc">
4354 <p>A handle to a source face object.</p>
4355 </td></tr>
4356 <tr><td class="val" id="glyph_index">glyph_index</td><td class="desc">
4357 <p>The glyph index.</p>
4358 </td></tr>
4359 <tr><td class="val" id="buffer_max">buffer_max</td><td class="desc">
4360 <p>The maximum number of bytes available in the buffer.</p>
4361 </td></tr>
4362 </table>
4363
4364 <h4>output</h4>
4365
4366 <table class="fields">
4367 <tr><td class="val" id="buffer">buffer</td><td class="desc">
4368 <p>A pointer to a target buffer where the name is copied to.</p>
4369 </td></tr>
4370 </table>
4371
4372 <h4>return</h4>
4373
4374 <p>FreeType error code. 0&nbsp;means success.</p>
4375 <h4>note</h4>
4376
4377 <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>
4378 <p>The glyph name is truncated to fit within the buffer if it is too long. The returned string is always zero-terminated.</p>
4379 <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>
4380 <p>This function always returns an error if the config macro <code>FT_CONFIG_OPTION_NO_GLYPH_NAMES</code> is not defined in <code>ftoption.h</code>.</p>
4381 <hr>
4382
4383 <h2 id="ft_get_postscript_name">FT_Get_Postscript_Name<a class="headerlink" href="#ft_get_postscript_name" title="Permanent link">&para;</a></h2>
4384 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4385 <div class = "codehilite"><pre><code>  FT_EXPORT( <span class="keyword">const</span> <span class="keyword">char</span>* )
4386   <b>FT_Get_Postscript_Name</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face );
4387 </code></pre></div>
4388
4389 <p>Retrieve the ASCII PostScript name of a given face, if available. This only works with PostScript, TrueType, and OpenType fonts.</p>
4390 <h4>input</h4>
4391
4392 <table class="fields">
4393 <tr><td class="val" id="face">face</td><td class="desc">
4394 <p>A handle to the source face object.</p>
4395 </td></tr>
4396 </table>
4397
4398 <h4>return</h4>
4399
4400 <p>A pointer to the face's PostScript name. <code>NULL</code> if unavailable.</p>
4401 <h4>note</h4>
4402
4403 <p>The returned pointer is owned by the face and is destroyed with it.</p>
4404 <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>
4405 <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>
4406 <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). If <code><a href="ft2-base_interface.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>
4407 <hr>
4408
4409 <h2 id="ft_charmaprec">FT_CharMapRec<a class="headerlink" href="#ft_charmaprec" title="Permanent link">&para;</a></h2>
4410 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4411 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_CharMapRec_
4412   {
4413     <a href="ft2-base_interface.html#ft_face">FT_Face</a>      face;
4414     <a href="ft2-base_interface.html#ft_encoding">FT_Encoding</a>  encoding;
4415     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>    platform_id;
4416     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>    encoding_id;
4417
4418   } <b>FT_CharMapRec</b>;
4419 </code></pre></div>
4420
4421 <p>The base charmap structure.</p>
4422 <h4>fields</h4>
4423
4424 <table class="fields">
4425 <tr><td class="val" id="face">face</td><td class="desc">
4426 <p>A handle to the parent face object.</p>
4427 </td></tr>
4428 <tr><td class="val" id="encoding">encoding</td><td class="desc">
4429 <p>An <code><a href="ft2-base_interface.html#ft_encoding">FT_Encoding</a></code> tag identifying the charmap. Use this with <code><a href="ft2-base_interface.html#ft_select_charmap">FT_Select_Charmap</a></code>.</p>
4430 </td></tr>
4431 <tr><td class="val" id="platform_id">platform_id</td><td class="desc">
4432 <p>An ID number describing the platform for the following encoding ID. This comes directly from the TrueType specification and gets emulated for other formats.</p>
4433 </td></tr>
4434 <tr><td class="val" id="encoding_id">encoding_id</td><td class="desc">
4435 <p>A platform-specific encoding number. This also comes from the TrueType specification and gets emulated similarly.</p>
4436 </td></tr>
4437 </table>
4438
4439 <hr>
4440
4441 <h2 id="ft_select_charmap">FT_Select_Charmap<a class="headerlink" href="#ft_select_charmap" title="Permanent link">&para;</a></h2>
4442 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4443 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4444   <b>FT_Select_Charmap</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>      face,
4445                      <a href="ft2-base_interface.html#ft_encoding">FT_Encoding</a>  encoding );
4446 </code></pre></div>
4447
4448 <p>Select a given charmap by its encoding tag (as listed in <code>freetype.h</code>).</p>
4449 <h4>inout</h4>
4450
4451 <table class="fields">
4452 <tr><td class="val" id="face">face</td><td class="desc">
4453 <p>A handle to the source face object.</p>
4454 </td></tr>
4455 </table>
4456
4457 <h4>input</h4>
4458
4459 <table class="fields">
4460 <tr><td class="val" id="encoding">encoding</td><td class="desc">
4461 <p>A handle to the selected encoding.</p>
4462 </td></tr>
4463 </table>
4464
4465 <h4>return</h4>
4466
4467 <p>FreeType error code. 0&nbsp;means success.</p>
4468 <h4>note</h4>
4469
4470 <p>This function returns an error if no charmap in the face corresponds to the encoding queried here.</p>
4471 <p>Because many fonts contain more than a single cmap for Unicode encoding, this function has some special code to select the one that covers Unicode best (&lsquo;best&rsquo; in the sense that a UCS-4 cmap is preferred to a UCS-2 cmap). It is thus preferable to <code><a href="ft2-base_interface.html#ft_set_charmap">FT_Set_Charmap</a></code> in this case.</p>
4472 <hr>
4473
4474 <h2 id="ft_set_charmap">FT_Set_Charmap<a class="headerlink" href="#ft_set_charmap" title="Permanent link">&para;</a></h2>
4475 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4476 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4477   <b>FT_Set_Charmap</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
4478                   <a href="ft2-base_interface.html#ft_charmap">FT_CharMap</a>  charmap );
4479 </code></pre></div>
4480
4481 <p>Select a given charmap for character code to glyph index mapping.</p>
4482 <h4>inout</h4>
4483
4484 <table class="fields">
4485 <tr><td class="val" id="face">face</td><td class="desc">
4486 <p>A handle to the source face object.</p>
4487 </td></tr>
4488 </table>
4489
4490 <h4>input</h4>
4491
4492 <table class="fields">
4493 <tr><td class="val" id="charmap">charmap</td><td class="desc">
4494 <p>A handle to the selected charmap.</p>
4495 </td></tr>
4496 </table>
4497
4498 <h4>return</h4>
4499
4500 <p>FreeType error code. 0&nbsp;means success.</p>
4501 <h4>note</h4>
4502
4503 <p>This function returns an error if the charmap is not part of the face (i.e., if it is not listed in the <code>face-&gt;charmaps</code> table).</p>
4504 <p>It also fails if an OpenType type&nbsp;14 charmap is selected (which doesn't map character codes to glyph indices at all).</p>
4505 <hr>
4506
4507 <h2 id="ft_get_charmap_index">FT_Get_Charmap_Index<a class="headerlink" href="#ft_get_charmap_index" title="Permanent link">&para;</a></h2>
4508 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4509 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_int">FT_Int</a> )
4510   <b>FT_Get_Charmap_Index</b>( <a href="ft2-base_interface.html#ft_charmap">FT_CharMap</a>  charmap );
4511 </code></pre></div>
4512
4513 <p>Retrieve index of a given charmap.</p>
4514 <h4>input</h4>
4515
4516 <table class="fields">
4517 <tr><td class="val" id="charmap">charmap</td><td class="desc">
4518 <p>A handle to a charmap.</p>
4519 </td></tr>
4520 </table>
4521
4522 <h4>return</h4>
4523
4524 <p>The index into the array of character maps within the face to which <code>charmap</code> belongs. If an error occurs, -1 is returned.</p>
4525 <hr>
4526
4527 <h2 id="ft_get_fstype_flags">FT_Get_FSType_Flags<a class="headerlink" href="#ft_get_fstype_flags" title="Permanent link">&para;</a></h2>
4528 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4529 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> )
4530   <b>FT_Get_FSType_Flags</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>  face );
4531 </code></pre></div>
4532
4533 <p>Return the <code>fsType</code> flags for a font.</p>
4534 <h4>input</h4>
4535
4536 <table class="fields">
4537 <tr><td class="val" id="face">face</td><td class="desc">
4538 <p>A handle to the source face object.</p>
4539 </td></tr>
4540 </table>
4541
4542 <h4>return</h4>
4543
4544 <p>The <code>fsType</code> flags, see <code><a href="ft2-base_interface.html#ft_fstype_xxx">FT_FSTYPE_XXX</a></code>.</p>
4545 <h4>note</h4>
4546
4547 <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>
4548 <h4>since</h4>
4549
4550 <p>2.3.8</p>
4551 <hr>
4552
4553 <h2 id="ft_get_subglyph_info">FT_Get_SubGlyph_Info<a class="headerlink" href="#ft_get_subglyph_info" title="Permanent link">&para;</a></h2>
4554 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4555 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
4556   <b>FT_Get_SubGlyph_Info</b>( <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a>  glyph,
4557                         <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>       sub_index,
4558                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_index,
4559                         <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>      *p_flags,
4560                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_arg1,
4561                         <a href="ft2-basic_types.html#ft_int">FT_Int</a>       *p_arg2,
4562                         <a href="ft2-basic_types.html#ft_matrix">FT_Matrix</a>    *p_transform );
4563 </code></pre></div>
4564
4565 <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>
4566 <h4>input</h4>
4567
4568 <table class="fields">
4569 <tr><td class="val" id="glyph">glyph</td><td class="desc">
4570 <p>The source glyph slot.</p>
4571 </td></tr>
4572 <tr><td class="val" id="sub_index">sub_index</td><td class="desc">
4573 <p>The index of the subglyph. Must be less than <code>glyph-&gt;num_subglyphs</code>.</p>
4574 </td></tr>
4575 </table>
4576
4577 <h4>output</h4>
4578
4579 <table class="fields">
4580 <tr><td class="val" id="p_index">p_index</td><td class="desc">
4581 <p>The glyph index of the subglyph.</p>
4582 </td></tr>
4583 <tr><td class="val" id="p_flags">p_flags</td><td class="desc">
4584 <p>The subglyph flags, see <code><a href="ft2-base_interface.html#ft_subglyph_flag_xxx">FT_SUBGLYPH_FLAG_XXX</a></code>.</p>
4585 </td></tr>
4586 <tr><td class="val" id="p_arg1">p_arg1</td><td class="desc">
4587 <p>The subglyph's first argument (if any).</p>
4588 </td></tr>
4589 <tr><td class="val" id="p_arg2">p_arg2</td><td class="desc">
4590 <p>The subglyph's second argument (if any).</p>
4591 </td></tr>
4592 <tr><td class="val" id="p_transform">p_transform</td><td class="desc">
4593 <p>The subglyph transformation (if any).</p>
4594 </td></tr>
4595 </table>
4596
4597 <h4>return</h4>
4598
4599 <p>FreeType error code. 0&nbsp;means success.</p>
4600 <h4>note</h4>
4601
4602 <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>
4603 <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>
4604 <hr>
4605
4606 <h2 id="ft_face_internal">FT_Face_Internal<a class="headerlink" href="#ft_face_internal" title="Permanent link">&para;</a></h2>
4607 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4608 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Face_InternalRec_*  <b>FT_Face_Internal</b>;
4609 </code></pre></div>
4610
4611 <p>An opaque handle to an <code>FT_Face_InternalRec</code> structure that models the private data of a given <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> object.</p>
4612 <p>This structure might change between releases of FreeType&nbsp;2 and is not generally available to client applications.</p>
4613 <hr>
4614
4615 <h2 id="ft_size_internal">FT_Size_Internal<a class="headerlink" href="#ft_size_internal" title="Permanent link">&para;</a></h2>
4616 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4617 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Size_InternalRec_*  <b>FT_Size_Internal</b>;
4618 </code></pre></div>
4619
4620 <p>An opaque handle to an <code>FT_Size_InternalRec</code> structure, used to model private data of a given <code><a href="ft2-base_interface.html#ft_size">FT_Size</a></code> object.</p>
4621 <hr>
4622
4623 <h2 id="ft_slot_internal">FT_Slot_Internal<a class="headerlink" href="#ft_slot_internal" title="Permanent link">&para;</a></h2>
4624 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4625 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Slot_InternalRec_*  <b>FT_Slot_Internal</b>;
4626 </code></pre></div>
4627
4628 <p>An opaque handle to an <code>FT_Slot_InternalRec</code> structure, used to model private data of a given <code><a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a></code> object.</p>
4629 <hr>
4630
4631 <h2 id="ft_face_flag_xxx">FT_FACE_FLAG_XXX<a class="headerlink" href="#ft_face_flag_xxx" title="Permanent link">&para;</a></h2>
4632 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4633 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_scalable">FT_FACE_FLAG_SCALABLE</a>          ( 1L &lt;&lt;  0 )
4634 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_fixed_sizes">FT_FACE_FLAG_FIXED_SIZES</a>       ( 1L &lt;&lt;  1 )
4635 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_fixed_width">FT_FACE_FLAG_FIXED_WIDTH</a>       ( 1L &lt;&lt;  2 )
4636 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_sfnt">FT_FACE_FLAG_SFNT</a>              ( 1L &lt;&lt;  3 )
4637 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_horizontal">FT_FACE_FLAG_HORIZONTAL</a>        ( 1L &lt;&lt;  4 )
4638 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_vertical">FT_FACE_FLAG_VERTICAL</a>          ( 1L &lt;&lt;  5 )
4639 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_kerning">FT_FACE_FLAG_KERNING</a>           ( 1L &lt;&lt;  6 )
4640 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_fast_glyphs">FT_FACE_FLAG_FAST_GLYPHS</a>       ( 1L &lt;&lt;  7 )
4641 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_multiple_masters">FT_FACE_FLAG_MULTIPLE_MASTERS</a>  ( 1L &lt;&lt;  8 )
4642 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_glyph_names">FT_FACE_FLAG_GLYPH_NAMES</a>       ( 1L &lt;&lt;  9 )
4643 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_external_stream">FT_FACE_FLAG_EXTERNAL_STREAM</a>   ( 1L &lt;&lt; 10 )
4644 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_hinter">FT_FACE_FLAG_HINTER</a>            ( 1L &lt;&lt; 11 )
4645 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_cid_keyed">FT_FACE_FLAG_CID_KEYED</a>         ( 1L &lt;&lt; 12 )
4646 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_tricky">FT_FACE_FLAG_TRICKY</a>            ( 1L &lt;&lt; 13 )
4647 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_color">FT_FACE_FLAG_COLOR</a>             ( 1L &lt;&lt; 14 )
4648 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_face_flag_variation">FT_FACE_FLAG_VARIATION</a>         ( 1L &lt;&lt; 15 )
4649 </code></pre></div>
4650
4651 <p>A list of bit flags used in the <code>face_flags</code> field of the <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code> structure. They inform client applications of properties of the corresponding face.</p>
4652 <h4>values</h4>
4653
4654 <table class="fields long">
4655 <tr><td class="val" id="ft_face_flag_scalable">FT_FACE_FLAG_SCALABLE</td><td class="desc">
4656 <p>The face contains outline glyphs. Note that a face can contain bitmap strikes also, i.e., a face can have both this flag and <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_FIXED_SIZES</a></code> set.</p>
4657 </td></tr>
4658 <tr><td class="val" id="ft_face_flag_fixed_sizes">FT_FACE_FLAG_FIXED_SIZES</td><td class="desc">
4659 <p>The face contains bitmap strikes. See also the <code>num_fixed_sizes</code> and <code>available_sizes</code> fields of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code>.</p>
4660 </td></tr>
4661 <tr><td class="val" id="ft_face_flag_fixed_width">FT_FACE_FLAG_FIXED_WIDTH</td><td class="desc">
4662 <p>The face contains fixed-width characters (like Courier, Lucida, MonoType, etc.).</p>
4663 </td></tr>
4664 <tr><td class="val" id="ft_face_flag_sfnt">FT_FACE_FLAG_SFNT</td><td class="desc">
4665 <p>The face uses the SFNT storage scheme. For now, this means TrueType and OpenType.</p>
4666 </td></tr>
4667 <tr><td class="val" id="ft_face_flag_horizontal">FT_FACE_FLAG_HORIZONTAL</td><td class="desc">
4668 <p>The face contains horizontal glyph metrics. This should be set for all common formats.</p>
4669 </td></tr>
4670 <tr><td class="val" id="ft_face_flag_vertical">FT_FACE_FLAG_VERTICAL</td><td class="desc">
4671 <p>The face contains vertical glyph metrics. This is only available in some formats, not all of them.</p>
4672 </td></tr>
4673 <tr><td class="val" id="ft_face_flag_kerning">FT_FACE_FLAG_KERNING</td><td class="desc">
4674 <p>The face contains kerning information. If set, the kerning distance can be retrieved using the function <code><a href="ft2-base_interface.html#ft_get_kerning">FT_Get_Kerning</a></code>. Otherwise the function always return the vector (0,0). Note that FreeType doesn't handle kerning data from the SFNT &lsquo;GPOS&rsquo; table (as present in many OpenType fonts).</p>
4675 </td></tr>
4676 <tr><td class="val" id="ft_face_flag_fast_glyphs">FT_FACE_FLAG_FAST_GLYPHS</td><td class="desc">
4677 <p>THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT.</p>
4678 </td></tr>
4679 <tr><td class="val" id="ft_face_flag_multiple_masters">FT_FACE_FLAG_MULTIPLE_MASTERS</td><td class="desc">
4680 <p>The face contains multiple masters and is capable of interpolating between them. Supported formats are Adobe MM, TrueType GX, and OpenType variation fonts.</p>
4681 <p>See section &lsquo;<a href="ft2-multiple_masters.html#multiple_masters">Multiple Masters</a>&rsquo; for API details.</p>
4682 </td></tr>
4683 <tr><td class="val" id="ft_face_flag_glyph_names">FT_FACE_FLAG_GLYPH_NAMES</td><td class="desc">
4684 <p>The face contains glyph names, which can be retrieved using <code><a href="ft2-base_interface.html#ft_get_glyph_name">FT_Get_Glyph_Name</a></code>. Note that some TrueType fonts contain broken glyph name tables. Use the function <code><a href="ft2-type1_tables.html#ft_has_ps_glyph_names">FT_Has_PS_Glyph_Names</a></code> when needed.</p>
4685 </td></tr>
4686 <tr><td class="val" id="ft_face_flag_external_stream">FT_FACE_FLAG_EXTERNAL_STREAM</td><td class="desc">
4687 <p>Used internally by FreeType to indicate that a face's stream was provided by the client application and should not be destroyed when <code><a href="ft2-base_interface.html#ft_done_face">FT_Done_Face</a></code> is called. Don't read or test this flag.</p>
4688 </td></tr>
4689 <tr><td class="val" id="ft_face_flag_hinter">FT_FACE_FLAG_HINTER</td><td class="desc">
4690 <p>The font driver has a hinting machine of its own. For example, with TrueType fonts, it makes sense to use data from the SFNT &lsquo;gasp&rsquo; table only if the native TrueType hinting engine (with the bytecode interpreter) is available and active.</p>
4691 </td></tr>
4692 <tr><td class="val" id="ft_face_flag_cid_keyed">FT_FACE_FLAG_CID_KEYED</td><td class="desc">
4693 <p>The face is CID-keyed. In that case, the face is not accessed by glyph indices but by CID values. For subsetted CID-keyed fonts this has the consequence that not all index values are a valid argument to <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>. Only the CID values for which corresponding glyphs in the subsetted font exist make <code>FT_Load_Glyph</code> return successfully; in all other cases you get an <code>FT_Err_Invalid_Argument</code> error.</p>
4694 <p>Note that CID-keyed fonts that are in an SFNT wrapper (this is, all OpenType/CFF fonts) don't have this flag set since the glyphs are accessed in the normal way (using contiguous indices); the &lsquo;CID-ness&rsquo; isn't visible to the application.</p>
4695 </td></tr>
4696 <tr><td class="val" id="ft_face_flag_tricky">FT_FACE_FLAG_TRICKY</td><td class="desc">
4697 <p>The face is &lsquo;tricky&rsquo;, this is, it always needs the font format's native hinting engine to get a reasonable result. A typical example is the old Chinese font <code>mingli.ttf</code> (but not <code>mingliu.ttc</code>) that uses TrueType bytecode instructions to move and scale all of its subglyphs.</p>
4698 <p>It is not possible to auto-hint such fonts using <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_FORCE_AUTOHINT</a></code>; it will also ignore <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code>. You have to set both <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code> and <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_AUTOHINT</a></code> to really disable hinting; however, you probably never want this except for demonstration purposes.</p>
4699 <p>Currently, there are about a dozen TrueType fonts in the list of tricky fonts; they are hard-coded in file <code>ttobjs.c</code>.</p>
4700 </td></tr>
4701 <tr><td class="val" id="ft_face_flag_color">FT_FACE_FLAG_COLOR</td><td class="desc">
4702 <p>[Since 2.5.1] The face has color glyph tables. See <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_COLOR</a></code> for more information.</p>
4703 </td></tr>
4704 <tr><td class="val" id="ft_face_flag_variation">FT_FACE_FLAG_VARIATION</td><td class="desc">
4705 <p>[Since 2.9] Set if the current face (or named instance) has been altered with <code><a href="ft2-multiple_masters.html#ft_set_mm_design_coordinates">FT_Set_MM_Design_Coordinates</a></code>, <code><a href="ft2-multiple_masters.html#ft_set_var_design_coordinates">FT_Set_Var_Design_Coordinates</a></code>, or <code><a href="ft2-multiple_masters.html#ft_set_var_blend_coordinates">FT_Set_Var_Blend_Coordinates</a></code>. This flag is unset by a call to <code><a href="ft2-multiple_masters.html#ft_set_named_instance">FT_Set_Named_Instance</a></code>.</p>
4706 </td></tr>
4707 </table>
4708
4709 <hr>
4710
4711 <h2 id="ft_style_flag_xxx">FT_STYLE_FLAG_XXX<a class="headerlink" href="#ft_style_flag_xxx" title="Permanent link">&para;</a></h2>
4712 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4713 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_style_flag_italic">FT_STYLE_FLAG_ITALIC</a>  ( 1 &lt;&lt; 0 )
4714 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_style_flag_bold">FT_STYLE_FLAG_BOLD</a>    ( 1 &lt;&lt; 1 )
4715 </code></pre></div>
4716
4717 <p>A list of bit flags to indicate the style of a given face. These are used in the <code>style_flags</code> field of <code><a href="ft2-base_interface.html#ft_facerec">FT_FaceRec</a></code>.</p>
4718 <h4>values</h4>
4719
4720 <table class="fields">
4721 <tr><td class="val" id="ft_style_flag_italic">FT_STYLE_FLAG_ITALIC</td><td class="desc">
4722 <p>The face style is italic or oblique.</p>
4723 </td></tr>
4724 <tr><td class="val" id="ft_style_flag_bold">FT_STYLE_FLAG_BOLD</td><td class="desc">
4725 <p>The face is bold.</p>
4726 </td></tr>
4727 </table>
4728
4729 <h4>note</h4>
4730
4731 <p>The style information as provided by FreeType is very basic. More details are beyond the scope and should be done on a higher level (for example, by analyzing various fields of the &lsquo;OS/2&rsquo; table in SFNT based fonts).</p>
4732 <hr>
4733
4734 <h2 id="ft_open_xxx">FT_OPEN_XXX<a class="headerlink" href="#ft_open_xxx" title="Permanent link">&para;</a></h2>
4735 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4736 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_open_memory">FT_OPEN_MEMORY</a>    0x1
4737 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_open_stream">FT_OPEN_STREAM</a>    0x2
4738 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_open_pathname">FT_OPEN_PATHNAME</a>  0x4
4739 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_open_driver">FT_OPEN_DRIVER</a>    0x8
4740 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_open_params">FT_OPEN_PARAMS</a>    0x10
4741
4742   /* these constants are deprecated; use the corresponding `<b>FT_OPEN_XXX</b>` */
4743   /* values instead                                                      */
4744 #<span class="keyword">define</span> ft_open_memory    <a href="ft2-base_interface.html#ft_open_memory">FT_OPEN_MEMORY</a>
4745 #<span class="keyword">define</span> ft_open_stream    <a href="ft2-base_interface.html#ft_open_stream">FT_OPEN_STREAM</a>
4746 #<span class="keyword">define</span> ft_open_pathname  <a href="ft2-base_interface.html#ft_open_pathname">FT_OPEN_PATHNAME</a>
4747 #<span class="keyword">define</span> ft_open_driver    <a href="ft2-base_interface.html#ft_open_driver">FT_OPEN_DRIVER</a>
4748 #<span class="keyword">define</span> ft_open_params    <a href="ft2-base_interface.html#ft_open_params">FT_OPEN_PARAMS</a>
4749 </code></pre></div>
4750
4751 <p>A list of bit field constants used within the <code>flags</code> field of the <code><a href="ft2-base_interface.html#ft_open_args">FT_Open_Args</a></code> structure.</p>
4752 <h4>values</h4>
4753
4754 <table class="fields">
4755 <tr><td class="val" id="ft_open_memory">FT_OPEN_MEMORY</td><td class="desc">
4756 <p>This is a memory-based stream.</p>
4757 </td></tr>
4758 <tr><td class="val" id="ft_open_stream">FT_OPEN_STREAM</td><td class="desc">
4759 <p>Copy the stream from the <code>stream</code> field.</p>
4760 </td></tr>
4761 <tr><td class="val" id="ft_open_pathname">FT_OPEN_PATHNAME</td><td class="desc">
4762 <p>Create a new input stream from a C&nbsp;path name.</p>
4763 </td></tr>
4764 <tr><td class="val" id="ft_open_driver">FT_OPEN_DRIVER</td><td class="desc">
4765 <p>Use the <code>driver</code> field.</p>
4766 </td></tr>
4767 <tr><td class="val" id="ft_open_params">FT_OPEN_PARAMS</td><td class="desc">
4768 <p>Use the <code>num_params</code> and <code>params</code> fields.</p>
4769 </td></tr>
4770 </table>
4771
4772 <h4>note</h4>
4773
4774 <p>The <code>FT_OPEN_MEMORY</code>, <code>FT_OPEN_STREAM</code>, and <code>FT_OPEN_PATHNAME</code> flags are mutually exclusive.</p>
4775 <hr>
4776
4777 <h2 id="ft_load_xxx">FT_LOAD_XXX<a class="headerlink" href="#ft_load_xxx" title="Permanent link">&para;</a></h2>
4778 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4779 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_default">FT_LOAD_DEFAULT</a>                      0x0
4780 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_no_scale">FT_LOAD_NO_SCALE</a>                     ( 1L &lt;&lt; 0 )
4781 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_no_hinting">FT_LOAD_NO_HINTING</a>                   ( 1L &lt;&lt; 1 )
4782 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_render">FT_LOAD_RENDER</a>                       ( 1L &lt;&lt; 2 )
4783 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_no_bitmap">FT_LOAD_NO_BITMAP</a>                    ( 1L &lt;&lt; 3 )
4784 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_vertical_layout">FT_LOAD_VERTICAL_LAYOUT</a>              ( 1L &lt;&lt; 4 )
4785 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_force_autohint">FT_LOAD_FORCE_AUTOHINT</a>               ( 1L &lt;&lt; 5 )
4786 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_crop_bitmap">FT_LOAD_CROP_BITMAP</a>                  ( 1L &lt;&lt; 6 )
4787 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_pedantic">FT_LOAD_PEDANTIC</a>                     ( 1L &lt;&lt; 7 )
4788 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_ignore_global_advance_width">FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH</a>  ( 1L &lt;&lt; 9 )
4789 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_no_recurse">FT_LOAD_NO_RECURSE</a>                   ( 1L &lt;&lt; 10 )
4790 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_ignore_transform">FT_LOAD_IGNORE_TRANSFORM</a>             ( 1L &lt;&lt; 11 )
4791 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_monochrome">FT_LOAD_MONOCHROME</a>                   ( 1L &lt;&lt; 12 )
4792 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_linear_design">FT_LOAD_LINEAR_DESIGN</a>                ( 1L &lt;&lt; 13 )
4793 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_no_autohint">FT_LOAD_NO_AUTOHINT</a>                  ( 1L &lt;&lt; 15 )
4794   /* Bits 16-19 are used by `FT_LOAD_TARGET_` */
4795 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_color">FT_LOAD_COLOR</a>                        ( 1L &lt;&lt; 20 )
4796 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_compute_metrics">FT_LOAD_COMPUTE_METRICS</a>              ( 1L &lt;&lt; 21 )
4797 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_bitmap_metrics_only">FT_LOAD_BITMAP_METRICS_ONLY</a>          ( 1L &lt;&lt; 22 )
4798 </code></pre></div>
4799
4800 <p>A list of bit field constants for <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> to indicate what kind of operations to perform during glyph loading.</p>
4801 <h4>values</h4>
4802
4803 <table class="fields long">
4804 <tr><td class="val" id="ft_load_default">FT_LOAD_DEFAULT</td><td class="desc">
4805 <p>Corresponding to&nbsp;0, this value is used as the default glyph load operation. In this case, the following happens:</p>
4806 <ol>
4807 <li><p>FreeType looks for a bitmap for the glyph corresponding to the face's current size. If one is found, the function returns. The bitmap data can be accessed from the glyph slot (see note below).</p>
4808 </li>
4809 <li><p>If no embedded bitmap is searched for or found, FreeType looks for a scalable outline. If one is found, it is loaded from the font file, scaled to device pixels, then &lsquo;hinted&rsquo; to the pixel grid in order to optimize it. The outline data can be accessed from the glyph slot (see note below).</p>
4810 </li>
4811 </ol>
4812 <p>Note that by default the glyph loader doesn't render outlines into bitmaps. The following flags are used to modify this default behaviour to more specific and useful cases.</p>
4813 </td></tr>
4814 <tr><td class="val" id="ft_load_no_scale">FT_LOAD_NO_SCALE</td><td class="desc">
4815 <p>Don't scale the loaded outline glyph but keep it in font units.</p>
4816 <p>This flag implies <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code> and <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_BITMAP</a></code>, and unsets <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_RENDER</a></code>.</p>
4817 <p>If the font is &lsquo;tricky&rsquo; (see <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_TRICKY</a></code> for more), using <code>FT_LOAD_NO_SCALE</code> usually yields meaningless outlines because the subglyphs must be scaled and positioned with hinting instructions. This can be solved by loading the font without <code>FT_LOAD_NO_SCALE</code> and setting the character size to <code>font-&gt;units_per_EM</code>.</p>
4818 </td></tr>
4819 <tr><td class="val" id="ft_load_no_hinting">FT_LOAD_NO_HINTING</td><td class="desc">
4820 <p>Disable hinting. This generally generates &lsquo;blurrier&rsquo; bitmap glyphs when the glyph are rendered in any of the anti-aliased modes. See also the note below.</p>
4821 <p>This flag is implied by <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>.</p>
4822 </td></tr>
4823 <tr><td class="val" id="ft_load_render">FT_LOAD_RENDER</td><td class="desc">
4824 <p>Call <code><a href="ft2-base_interface.html#ft_render_glyph">FT_Render_Glyph</a></code> after the glyph is loaded. By default, the glyph is rendered in <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_NORMAL</a></code> mode. This can be overridden by <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_XXX</a></code> or <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_MONOCHROME</a></code>.</p>
4825 <p>This flag is unset by <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>.</p>
4826 </td></tr>
4827 <tr><td class="val" id="ft_load_no_bitmap">FT_LOAD_NO_BITMAP</td><td class="desc">
4828 <p>Ignore bitmap strikes when loading. Bitmap-only fonts ignore this flag.</p>
4829 <p><code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> always sets this flag.</p>
4830 </td></tr>
4831 <tr><td class="val" id="ft_load_vertical_layout">FT_LOAD_VERTICAL_LAYOUT</td><td class="desc">
4832 <p>Load the glyph for vertical text layout. In particular, the <code>advance</code> value in the <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure is set to the <code>vertAdvance</code> value of the <code>metrics</code> field.</p>
4833 <p>In case <code><a href="ft2-base_interface.html#ft_has_vertical">FT_HAS_VERTICAL</a></code> doesn't return true, you shouldn't use this flag currently. Reason is that in this case vertical metrics get synthesized, and those values are not always consistent across various font formats.</p>
4834 </td></tr>
4835 <tr><td class="val" id="ft_load_force_autohint">FT_LOAD_FORCE_AUTOHINT</td><td class="desc">
4836 <p>Prefer the auto-hinter over the font's native hinter. See also the note below.</p>
4837 </td></tr>
4838 <tr><td class="val" id="ft_load_pedantic">FT_LOAD_PEDANTIC</td><td class="desc">
4839 <p>Make the font driver perform pedantic verifications during glyph loading and hinting. This is mostly used to detect broken glyphs in fonts. By default, FreeType tries to handle broken fonts also.</p>
4840 <p>In particular, errors from the TrueType bytecode engine are not passed to the application if this flag is not set; this might result in partially hinted or distorted glyphs in case a glyph's bytecode is buggy.</p>
4841 </td></tr>
4842 <tr><td class="val" id="ft_load_no_recurse">FT_LOAD_NO_RECURSE</td><td class="desc">
4843 <p>Don't load composite glyphs recursively. Instead, the font driver fills the <code>num_subglyph</code> and <code>subglyphs</code> values of the glyph slot; it also sets <code>glyph-&gt;format</code> to <code><a href="ft2-basic_types.html#ft_glyph_format">FT_GLYPH_FORMAT_COMPOSITE</a></code>. The description of subglyphs can then be accessed with <code><a href="ft2-base_interface.html#ft_get_subglyph_info">FT_Get_SubGlyph_Info</a></code>.</p>
4844 <p>Don't use this flag for retrieving metrics information since some font drivers only return rudimentary data.</p>
4845 <p>This flag implies <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> and <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_IGNORE_TRANSFORM</a></code>.</p>
4846 </td></tr>
4847 <tr><td class="val" id="ft_load_ignore_transform">FT_LOAD_IGNORE_TRANSFORM</td><td class="desc">
4848 <p>Ignore the transform matrix set by <code><a href="ft2-base_interface.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
4849 </td></tr>
4850 <tr><td class="val" id="ft_load_monochrome">FT_LOAD_MONOCHROME</td><td class="desc">
4851 <p>This flag is used with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_RENDER</a></code> to indicate that you want to render an outline glyph to a 1-bit monochrome bitmap glyph, with 8&nbsp;pixels packed into each byte of the bitmap data.</p>
4852 <p>Note that this has no effect on the hinting algorithm used. You should rather use <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_MONO</a></code> so that the monochrome-optimized hinting algorithm is used.</p>
4853 </td></tr>
4854 <tr><td class="val" id="ft_load_linear_design">FT_LOAD_LINEAR_DESIGN</td><td class="desc">
4855 <p>Keep <code>linearHoriAdvance</code> and <code>linearVertAdvance</code> fields of <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> in font units. See <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> for details.</p>
4856 </td></tr>
4857 <tr><td class="val" id="ft_load_no_autohint">FT_LOAD_NO_AUTOHINT</td><td class="desc">
4858 <p>Disable the auto-hinter. See also the note below.</p>
4859 </td></tr>
4860 <tr><td class="val" id="ft_load_color">FT_LOAD_COLOR</td><td class="desc">
4861 <p>Load colored glyphs. There are slight differences depending on the font format.</p>
4862 <p>[Since 2.5] Load embedded color bitmap images. The resulting color bitmaps, if available, will have the <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_BGRA</a></code> format, with pre-multiplied color channels. If the flag is not set and color bitmaps are found, they are converted to 256-level gray bitmaps, using the <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY</a></code> format.</p>
4863 <p>[Since 2.10, experimental] If the glyph index contains an entry in the face's &lsquo;COLR&rsquo; table with a &lsquo;CPAL&rsquo; palette table (as defined in the OpenType specification), make <code><a href="ft2-base_interface.html#ft_render_glyph">FT_Render_Glyph</a></code> provide a default blending of the color glyph layers associated with the glyph index, using the same bitmap format as embedded color bitmap images. This is mainly for convenience; for full control of color layers use <code><a href="ft2-layer_management.html#ft_get_color_glyph_layer">FT_Get_Color_Glyph_Layer</a></code> and FreeType's color functions like <code><a href="ft2-color_management.html#ft_palette_select">FT_Palette_Select</a></code> instead of setting <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_COLOR</a></code> for rendering so that the client application can handle blending by itself.</p>
4864 </td></tr>
4865 <tr><td class="val" id="ft_load_compute_metrics">FT_LOAD_COMPUTE_METRICS</td><td class="desc">
4866 <p>[Since 2.6.1] Compute glyph metrics from the glyph data, without the use of bundled metrics tables (for example, the &lsquo;hdmx&rsquo; table in TrueType fonts). This flag is mainly used by font validating or font editing applications, which need to ignore, verify, or edit those tables.</p>
4867 <p>Currently, this flag is only implemented for TrueType fonts.</p>
4868 </td></tr>
4869 <tr><td class="val" id="ft_load_bitmap_metrics_only">FT_LOAD_BITMAP_METRICS_ONLY</td><td class="desc">
4870 <p>[Since 2.7.1] Request loading of the metrics and bitmap image information of a (possibly embedded) bitmap glyph without allocating or copying the bitmap image data itself. No effect if the target glyph is not a bitmap image.</p>
4871 <p>This flag unsets <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_RENDER</a></code>.</p>
4872 </td></tr>
4873 <tr><td class="val" id="ft_load_crop_bitmap">FT_LOAD_CROP_BITMAP</td><td class="desc">
4874 <p>Ignored. Deprecated.</p>
4875 </td></tr>
4876 <tr><td class="val" id="ft_load_ignore_global_advance_width">FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH</td><td class="desc">
4877 <p>Ignored. Deprecated.</p>
4878 </td></tr>
4879 </table>
4880
4881 <h4>note</h4>
4882
4883 <p>By default, hinting is enabled and the font's native hinter (see <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_HINTER</a></code>) is preferred over the auto-hinter. You can disable hinting by setting <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_HINTING</a></code> or change the precedence by setting <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_FORCE_AUTOHINT</a></code>. You can also set <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_AUTOHINT</a></code> in case you don't want the auto-hinter to be used at all.</p>
4884 <p>See the description of <code><a href="ft2-base_interface.html#ft_face_flag_xxx">FT_FACE_FLAG_TRICKY</a></code> for a special exception (affecting only a handful of Asian fonts).</p>
4885 <p>Besides deciding which hinter to use, you can also decide which hinting algorithm to use. See <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_XXX</a></code> for details.</p>
4886 <p>Note that the auto-hinter needs a valid Unicode cmap (either a native one or synthesized by FreeType) for producing correct results. If a font provides an incorrect mapping (for example, assigning the character code U+005A, LATIN CAPITAL LETTER&nbsp;Z, to a glyph depicting a mathematical integral sign), the auto-hinter might produce useless results.</p>
4887 <hr>
4888
4889 <h2 id="ft_load_target_xxx">FT_LOAD_TARGET_XXX<a class="headerlink" href="#ft_load_target_xxx" title="Permanent link">&para;</a></h2>
4890 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4891 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> FT_LOAD_TARGET_( x )   ( (<a href="ft2-basic_types.html#ft_int32">FT_Int32</a>)( (x) &amp; 15 ) &lt;&lt; 16 )
4892
4893 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_target_normal">FT_LOAD_TARGET_NORMAL</a>  FT_LOAD_TARGET_( <a href="ft2-base_interface.html#ft_render_mode_normal">FT_RENDER_MODE_NORMAL</a> )
4894 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_target_light">FT_LOAD_TARGET_LIGHT</a>   FT_LOAD_TARGET_( <a href="ft2-base_interface.html#ft_render_mode_light">FT_RENDER_MODE_LIGHT</a>  )
4895 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_target_mono">FT_LOAD_TARGET_MONO</a>    FT_LOAD_TARGET_( <a href="ft2-base_interface.html#ft_render_mode_mono">FT_RENDER_MODE_MONO</a>   )
4896 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_target_lcd">FT_LOAD_TARGET_LCD</a>     FT_LOAD_TARGET_( <a href="ft2-base_interface.html#ft_render_mode_lcd">FT_RENDER_MODE_LCD</a>    )
4897 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_load_target_lcd_v">FT_LOAD_TARGET_LCD_V</a>   FT_LOAD_TARGET_( <a href="ft2-base_interface.html#ft_render_mode_lcd_v">FT_RENDER_MODE_LCD_V</a>  )
4898 </code></pre></div>
4899
4900 <p>A list of values to select a specific hinting algorithm for the hinter. You should OR one of these values to your <code>load_flags</code> when calling <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
4901 <p>Note that a font's native hinters may ignore the hinting algorithm you have specified (e.g., the TrueType bytecode interpreter). You can set <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_FORCE_AUTOHINT</a></code> to ensure that the auto-hinter is used.</p>
4902 <h4>values</h4>
4903
4904 <table class="fields">
4905 <tr><td class="val" id="ft_load_target_normal">FT_LOAD_TARGET_NORMAL</td><td class="desc">
4906 <p>The default hinting algorithm, optimized for standard gray-level rendering. For monochrome output, use <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_MONO</a></code> instead.</p>
4907 </td></tr>
4908 <tr><td class="val" id="ft_load_target_light">FT_LOAD_TARGET_LIGHT</td><td class="desc">
4909 <p>A lighter hinting algorithm for gray-level modes. Many generated glyphs are fuzzier but better resemble their original shape. This is achieved by snapping glyphs to the pixel grid only vertically (Y-axis), as is done by FreeType's new CFF engine or Microsoft's ClearType font renderer. This preserves inter-glyph spacing in horizontal text. The snapping is done either by the native font driver, if the driver itself and the font support it, or by the auto-hinter.</p>
4910 <p>Advance widths are rounded to integer values; however, using the <code>lsb_delta</code> and <code>rsb_delta</code> fields of <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code>, it is possible to get fractional advance widths for subpixel positioning (which is recommended to use).</p>
4911 <p>If configuration option <code>AF_CONFIG_OPTION_TT_SIZE_METRICS</code> is active, TrueType-like metrics are used to make this mode behave similarly as in unpatched FreeType versions between 2.4.6 and 2.7.1 (inclusive).</p>
4912 </td></tr>
4913 <tr><td class="val" id="ft_load_target_mono">FT_LOAD_TARGET_MONO</td><td class="desc">
4914 <p>Strong hinting algorithm that should only be used for monochrome output. The result is probably unpleasant if the glyph is rendered in non-monochrome modes.</p>
4915 <p>Note that for outline fonts only the TrueType font driver has proper monochrome hinting support, provided the TTFs contain hints for B/W rendering (which most fonts no longer provide). If these conditions are not met it is very likely that you get ugly results at smaller sizes.</p>
4916 </td></tr>
4917 <tr><td class="val" id="ft_load_target_lcd">FT_LOAD_TARGET_LCD</td><td class="desc">
4918 <p>A variant of <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_LIGHT</a></code> optimized for horizontally decimated LCD displays.</p>
4919 </td></tr>
4920 <tr><td class="val" id="ft_load_target_lcd_v">FT_LOAD_TARGET_LCD_V</td><td class="desc">
4921 <p>A variant of <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_NORMAL</a></code> optimized for vertically decimated LCD displays.</p>
4922 </td></tr>
4923 </table>
4924
4925 <h4>note</h4>
4926
4927 <p>You should use only <em>one</em> of the <code>FT_LOAD_TARGET_XXX</code> values in your <code>load_flags</code>. They can't be ORed.</p>
4928 <p>If <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_RENDER</a></code> is also set, the glyph is rendered in the corresponding mode (i.e., the mode that matches the used algorithm best). An exception is <code>FT_LOAD_TARGET_MONO</code> since it implies <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_MONOCHROME</a></code>.</p>
4929 <p>You can use a hinting algorithm that doesn't correspond to the same rendering mode. As an example, it is possible to use the &lsquo;light&rsquo; hinting algorithm and have the results rendered in horizontal LCD pixel mode, with code like
4930 <div class="highlight"><pre><span></span><code>  FT_Load_Glyph( face, glyph_index,
4931                  load_flags | FT_LOAD_TARGET_LIGHT );
4932
4933   FT_Render_Glyph( face-&gt;glyph, FT_RENDER_MODE_LCD );
4934 </code></pre></div></p>
4935 <p>In general, you should stick with one rendering mode. For example, switching between <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_NORMAL</a></code> and <code><a href="ft2-base_interface.html#ft_load_target_xxx">FT_LOAD_TARGET_MONO</a></code> enforces a lot of recomputation for TrueType fonts, which is slow. Another reason is caching: Selecting a different mode usually causes changes in both the outlines and the rasterized bitmaps; it is thus necessary to empty the cache after a mode switch to avoid false hits.</p>
4936 <hr>
4937
4938 <h2 id="ft_subglyph_flag_xxx">FT_SUBGLYPH_FLAG_XXX<a class="headerlink" href="#ft_subglyph_flag_xxx" title="Permanent link">&para;</a></h2>
4939 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4940 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_args_are_words">FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS</a>          1
4941 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_args_are_xy_values">FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES</a>      2
4942 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_round_xy_to_grid">FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID</a>        4
4943 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_scale">FT_SUBGLYPH_FLAG_SCALE</a>                   8
4944 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_xy_scale">FT_SUBGLYPH_FLAG_XY_SCALE</a>             0x40
4945 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_2x2">FT_SUBGLYPH_FLAG_2X2</a>                  0x80
4946 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_subglyph_flag_use_my_metrics">FT_SUBGLYPH_FLAG_USE_MY_METRICS</a>      0x200
4947 </code></pre></div>
4948
4949 <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>
4950 <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>
4951 <h4>values</h4>
4952
4953 <table class="fields long">
4954 <tr><td class="val" id="ft_subglyph_flag_args_are_words">FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS</td><td class="desc">
4955
4956 </td></tr>
4957 <tr><td class="val" id="ft_subglyph_flag_args_are_xy_values">FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES</td><td class="desc">
4958
4959 </td></tr>
4960 <tr><td class="val" id="ft_subglyph_flag_round_xy_to_grid">FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID</td><td class="desc">
4961
4962 </td></tr>
4963 <tr><td class="val" id="ft_subglyph_flag_scale">FT_SUBGLYPH_FLAG_SCALE</td><td class="desc">
4964
4965 </td></tr>
4966 <tr><td class="val" id="ft_subglyph_flag_xy_scale">FT_SUBGLYPH_FLAG_XY_SCALE</td><td class="desc">
4967
4968 </td></tr>
4969 <tr><td class="val" id="ft_subglyph_flag_2x2">FT_SUBGLYPH_FLAG_2X2</td><td class="desc">
4970
4971 </td></tr>
4972 <tr><td class="val" id="ft_subglyph_flag_use_my_metrics">FT_SUBGLYPH_FLAG_USE_MY_METRICS</td><td class="desc">
4973
4974 </td></tr>
4975 </table>
4976
4977 <hr>
4978
4979 <h2 id="ft_fstype_xxx">FT_FSTYPE_XXX<a class="headerlink" href="#ft_fstype_xxx" title="Permanent link">&para;</a></h2>
4980 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
4981 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_installable_embedding">FT_FSTYPE_INSTALLABLE_EMBEDDING</a>         0x0000
4982 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_restricted_license_embedding">FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING</a>  0x0002
4983 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_preview_and_print_embedding">FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING</a>   0x0004
4984 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_editable_embedding">FT_FSTYPE_EDITABLE_EMBEDDING</a>            0x0008
4985 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_no_subsetting">FT_FSTYPE_NO_SUBSETTING</a>                 0x0100
4986 #<span class="keyword">define</span> <a href="ft2-base_interface.html#ft_fstype_bitmap_embedding_only">FT_FSTYPE_BITMAP_EMBEDDING_ONLY</a>         0x0200
4987 </code></pre></div>
4988
4989 <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-base_interface.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>
4990 <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>
4991 <h4>values</h4>
4992
4993 <table class="fields long">
4994 <tr><td class="val" id="ft_fstype_installable_embedding">FT_FSTYPE_INSTALLABLE_EMBEDDING</td><td class="desc">
4995 <p>Fonts with no fsType bit set may be embedded and permanently installed on the remote system by an application.</p>
4996 </td></tr>
4997 <tr><td class="val" id="ft_fstype_restricted_license_embedding">FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING</td><td class="desc">
4998 <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>
4999 </td></tr>
5000 <tr><td class="val" id="ft_fstype_preview_and_print_embedding">FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING</td><td class="desc">
5001 <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>
5002 </td></tr>
5003 <tr><td class="val" id="ft_fstype_editable_embedding">FT_FSTYPE_EDITABLE_EMBEDDING</td><td class="desc">
5004 <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>
5005 </td></tr>
5006 <tr><td class="val" id="ft_fstype_no_subsetting">FT_FSTYPE_NO_SUBSETTING</td><td class="desc">
5007 <p>The font may not be subsetted prior to embedding.</p>
5008 </td></tr>
5009 <tr><td class="val" id="ft_fstype_bitmap_embedding_only">FT_FSTYPE_BITMAP_EMBEDDING_ONLY</td><td class="desc">
5010 <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>
5011 </td></tr>
5012 </table>
5013
5014 <h4>note</h4>
5015
5016 <p>The flags are ORed together, thus more than a single value can be returned.</p>
5017 <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>
5018 <hr>
5019
5020 <h2 id="ft_has_fast_glyphs">FT_HAS_FAST_GLYPHS<a class="headerlink" href="#ft_has_fast_glyphs" title="Permanent link">&para;</a></h2>
5021 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
5022 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_HAS_FAST_GLYPHS</b>( face )  0
5023 </code></pre></div>
5024
5025 <p>Deprecated.</p>
5026 <hr>
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037             </article>
5038           </div>
5039         </div>
5040       </main>
5041
5042
5043 <footer class="md-footer">
5044
5045     <div class="md-footer-nav">
5046       <nav class="md-footer-nav__inner md-grid">
5047
5048           <a href="ft2-basic_types.html" title="Basic Data Types" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
5049             <div class="md-flex__cell md-flex__cell--shrink">
5050               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
5051             </div>
5052             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
5053               <span class="md-flex__ellipsis">
5054                 <span class="md-footer-nav__direction">
5055                   Previous
5056                 </span>
5057                 Basic Data Types
5058               </span>
5059             </div>
5060           </a>
5061
5062
5063           <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
5064             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
5065               <span class="md-flex__ellipsis">
5066                 <span class="md-footer-nav__direction">
5067                   Next
5068                 </span>
5069                 Unicode Variation Sequences
5070               </span>
5071             </div>
5072             <div class="md-flex__cell md-flex__cell--shrink">
5073               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
5074             </div>
5075           </a>
5076
5077       </nav>
5078     </div>
5079
5080   <div class="md-footer-meta md-typeset">
5081     <div class="md-footer-meta__inner md-grid">
5082       <div class="md-footer-copyright">
5083
5084           <div class="md-footer-copyright__highlight">
5085             Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
5086           </div>
5087
5088         powered by
5089         <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
5090         and
5091         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
5092           Material for MkDocs</a>
5093       </div>
5094
5095     </div>
5096   </div>
5097 </footer>
5098
5099     </div>
5100
5101       <script src="assets/javascripts/application.c33a9706.js"></script>
5102
5103       <script>app.initialize({version:"1.1",url:{base:"."}})</script>
5104
5105         <script src="javascripts/extra.js"></script>
5106
5107
5108   </body>
5109 </html>