• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>PFR Fonts - 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="#pfr-fonts" 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                PFR Fonts
119
120            </span>
121
122        </div>
123      </div>
124      <div class="md-flex__cell md-flex__cell--shrink">
125
126          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
127
128<div class="md-search" data-md-component="search" role="dialog">
129  <label class="md-search__overlay" for="__search"></label>
130  <div class="md-search__inner" role="search">
131    <form class="md-search__form" name="search">
132      <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
133      <label class="md-icon md-search__icon" for="__search"></label>
134      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
135        &#xE5CD;
136      </button>
137    </form>
138    <div class="md-search__output">
139      <div class="md-search__scrollwrap" data-md-scrollfix>
140        <div class="md-search-result" data-md-component="result">
141          <div class="md-search-result__meta">
142            Type to start searching
143          </div>
144          <ol class="md-search-result__list"></ol>
145        </div>
146      </div>
147    </div>
148  </div>
149</div>
150
151      </div>
152
153    </div>
154  </nav>
155</header>
156
157    <div class="md-container">
158
159
160
161
162      <main class="md-main" role="main">
163        <div class="md-main__inner md-grid" data-md-component="container">
164
165
166              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
167                <div class="md-sidebar__scrollwrap">
168                  <div class="md-sidebar__inner">
169                    <nav class="md-nav md-nav--primary" data-md-level="0">
170  <label class="md-nav__title md-nav__title--site" for="__drawer">
171    <a href="." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
172
173        <img alt="logo" src="images/favico.ico" width="48" height="48">
174
175    </a>
176    FreeType-2.10.4 API Reference
177  </label>
178
179  <ul class="md-nav__list" data-md-scrollfix>
180
181
182
183
184
185
186  <li class="md-nav__item">
187    <a href="index.html" title="TOC" class="md-nav__link">
188      TOC
189    </a>
190  </li>
191
192
193
194
195
196
197
198  <li class="md-nav__item">
199    <a href="ft2-index.html" title="Index" class="md-nav__link">
200      Index
201    </a>
202  </li>
203
204
205
206
207
208
209
210  <li class="md-nav__item md-nav__item--nested">
211
212      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
213
214    <label class="md-nav__link" for="nav-3">
215      General Remarks
216    </label>
217    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
218      <label class="md-nav__title" for="nav-3">
219        General Remarks
220      </label>
221      <ul class="md-nav__list" data-md-scrollfix>
222
223
224
225
226
227
228
229  <li class="md-nav__item">
230    <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
231      FreeType's header inclusion scheme
232    </a>
233  </li>
234
235
236
237
238
239
240
241  <li class="md-nav__item">
242    <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link">
243      User allocation
244    </a>
245  </li>
246
247
248      </ul>
249    </nav>
250  </li>
251
252
253
254
255
256
257
258  <li class="md-nav__item md-nav__item--nested">
259
260      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
261
262    <label class="md-nav__link" for="nav-4">
263      Core API
264    </label>
265    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
266      <label class="md-nav__title" for="nav-4">
267        Core API
268      </label>
269      <ul class="md-nav__list" data-md-scrollfix>
270
271
272
273
274
275
276
277  <li class="md-nav__item">
278    <a href="ft2-version.html" title="FreeType Version" class="md-nav__link">
279      FreeType Version
280    </a>
281  </li>
282
283
284
285
286
287
288
289  <li class="md-nav__item">
290    <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
291      Basic Data Types
292    </a>
293  </li>
294
295
296
297
298
299
300
301  <li class="md-nav__item">
302    <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link">
303      Base Interface
304    </a>
305  </li>
306
307
308
309
310
311
312
313  <li class="md-nav__item">
314    <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
315      Unicode Variation Sequences
316    </a>
317  </li>
318
319
320
321
322
323
324
325  <li class="md-nav__item">
326    <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
327      Glyph Color Management
328    </a>
329  </li>
330
331
332
333
334
335
336
337  <li class="md-nav__item">
338    <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
339      Glyph Layer Management
340    </a>
341  </li>
342
343
344
345
346
347
348
349  <li class="md-nav__item">
350    <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
351      Glyph Management
352    </a>
353  </li>
354
355
356
357
358
359
360
361  <li class="md-nav__item">
362    <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
363      Mac Specific Interface
364    </a>
365  </li>
366
367
368
369
370
371
372
373  <li class="md-nav__item">
374    <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link">
375      Size Management
376    </a>
377  </li>
378
379
380
381
382
383
384
385  <li class="md-nav__item">
386    <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
387      Header File Macros
388    </a>
389  </li>
390
391
392      </ul>
393    </nav>
394  </li>
395
396
397
398
399
400
401
402
403
404  <li class="md-nav__item md-nav__item--active md-nav__item--nested">
405
406      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
407
408    <label class="md-nav__link" for="nav-5">
409      Format-Specific API
410    </label>
411    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
412      <label class="md-nav__title" for="nav-5">
413        Format-Specific API
414      </label>
415      <ul class="md-nav__list" data-md-scrollfix>
416
417
418
419
420
421
422
423  <li class="md-nav__item">
424    <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
425      Multiple Masters
426    </a>
427  </li>
428
429
430
431
432
433
434
435  <li class="md-nav__item">
436    <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
437      TrueType Tables
438    </a>
439  </li>
440
441
442
443
444
445
446
447  <li class="md-nav__item">
448    <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
449      Type 1 Tables
450    </a>
451  </li>
452
453
454
455
456
457
458
459  <li class="md-nav__item">
460    <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
461      SFNT Names
462    </a>
463  </li>
464
465
466
467
468
469
470
471  <li class="md-nav__item">
472    <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
473      BDF and PCF Files
474    </a>
475  </li>
476
477
478
479
480
481
482
483  <li class="md-nav__item">
484    <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
485      CID Fonts
486    </a>
487  </li>
488
489
490
491
492
493
494
495
496
497  <li class="md-nav__item md-nav__item--active">
498
499    <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
500
501
502
503
504      <label class="md-nav__link md-nav__link--active" for="__toc">
505        PFR Fonts
506      </label>
507
508    <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link md-nav__link--active">
509      PFR Fonts
510    </a>
511
512
513<nav class="md-nav md-nav--secondary">
514
515
516
517
518
519    <label class="md-nav__title" for="__toc">Table of contents</label>
520    <ul class="md-nav__list" data-md-scrollfix>
521
522        <li class="md-nav__item">
523  <a href="#synopsis" class="md-nav__link">
524    Synopsis
525  </a>
526
527</li>
528
529        <li class="md-nav__item">
530  <a href="#ft_get_pfr_metrics" class="md-nav__link">
531    FT_Get_PFR_Metrics
532  </a>
533
534</li>
535
536        <li class="md-nav__item">
537  <a href="#ft_get_pfr_kerning" class="md-nav__link">
538    FT_Get_PFR_Kerning
539  </a>
540
541</li>
542
543        <li class="md-nav__item">
544  <a href="#ft_get_pfr_advance" class="md-nav__link">
545    FT_Get_PFR_Advance
546  </a>
547
548</li>
549
550
551
552
553
554    </ul>
555
556</nav>
557
558  </li>
559
560
561
562
563
564
565
566  <li class="md-nav__item">
567    <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
568      Window FNT Files
569    </a>
570  </li>
571
572
573
574
575
576
577
578  <li class="md-nav__item">
579    <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
580      Font Formats
581    </a>
582  </li>
583
584
585
586
587
588
589
590  <li class="md-nav__item">
591    <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
592      Gasp Table
593    </a>
594  </li>
595
596
597      </ul>
598    </nav>
599  </li>
600
601
602
603
604
605
606
607  <li class="md-nav__item md-nav__item--nested">
608
609      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
610
611    <label class="md-nav__link" for="nav-6">
612      Controlling FreeType Modules
613    </label>
614    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
615      <label class="md-nav__title" for="nav-6">
616        Controlling FreeType Modules
617      </label>
618      <ul class="md-nav__list" data-md-scrollfix>
619
620
621
622
623
624
625
626  <li class="md-nav__item">
627    <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
628      The auto-hinter
629    </a>
630  </li>
631
632
633
634
635
636
637
638  <li class="md-nav__item">
639    <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
640      The CFF driver
641    </a>
642  </li>
643
644
645
646
647
648
649
650  <li class="md-nav__item">
651    <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
652      The Type 1 and CID drivers
653    </a>
654  </li>
655
656
657
658
659
660
661
662  <li class="md-nav__item">
663    <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
664      The TrueType driver
665    </a>
666  </li>
667
668
669
670
671
672
673
674  <li class="md-nav__item">
675    <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
676      The PCF driver
677    </a>
678  </li>
679
680
681
682
683
684
685
686  <li class="md-nav__item">
687    <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
688      Driver properties
689    </a>
690  </li>
691
692
693
694
695
696
697
698  <li class="md-nav__item">
699    <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
700      Parameter Tags
701    </a>
702  </li>
703
704
705
706
707
708
709
710  <li class="md-nav__item">
711    <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
712      Subpixel Rendering
713    </a>
714  </li>
715
716
717      </ul>
718    </nav>
719  </li>
720
721
722
723
724
725
726
727  <li class="md-nav__item md-nav__item--nested">
728
729      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
730
731    <label class="md-nav__link" for="nav-7">
732      Cache Sub-System
733    </label>
734    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
735      <label class="md-nav__title" for="nav-7">
736        Cache Sub-System
737      </label>
738      <ul class="md-nav__list" data-md-scrollfix>
739
740
741
742
743
744
745
746  <li class="md-nav__item">
747    <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
748      Cache Sub-System
749    </a>
750  </li>
751
752
753      </ul>
754    </nav>
755  </li>
756
757
758
759
760
761
762
763  <li class="md-nav__item md-nav__item--nested">
764
765      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
766
767    <label class="md-nav__link" for="nav-8">
768      Support API
769    </label>
770    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
771      <label class="md-nav__title" for="nav-8">
772        Support API
773      </label>
774      <ul class="md-nav__list" data-md-scrollfix>
775
776
777
778
779
780
781
782  <li class="md-nav__item">
783    <a href="ft2-computations.html" title="Computations" class="md-nav__link">
784      Computations
785    </a>
786  </li>
787
788
789
790
791
792
793
794  <li class="md-nav__item">
795    <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
796      List Processing
797    </a>
798  </li>
799
800
801
802
803
804
805
806  <li class="md-nav__item">
807    <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
808      Outline Processing
809    </a>
810  </li>
811
812
813
814
815
816
817
818  <li class="md-nav__item">
819    <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
820      Quick retrieval of advance values
821    </a>
822  </li>
823
824
825
826
827
828
829
830  <li class="md-nav__item">
831    <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
832      Bitmap Handling
833    </a>
834  </li>
835
836
837
838
839
840
841
842  <li class="md-nav__item">
843    <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
844      Scanline Converter
845    </a>
846  </li>
847
848
849
850
851
852
853
854  <li class="md-nav__item">
855    <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
856      Glyph Stroker
857    </a>
858  </li>
859
860
861
862
863
864
865
866  <li class="md-nav__item">
867    <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
868      System Interface
869    </a>
870  </li>
871
872
873
874
875
876
877
878  <li class="md-nav__item">
879    <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
880      Module Management
881    </a>
882  </li>
883
884
885
886
887
888
889
890  <li class="md-nav__item">
891    <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
892      GZIP Streams
893    </a>
894  </li>
895
896
897
898
899
900
901
902  <li class="md-nav__item">
903    <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
904      LZW Streams
905    </a>
906  </li>
907
908
909
910
911
912
913
914  <li class="md-nav__item">
915    <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
916      BZIP2 Streams
917    </a>
918  </li>
919
920
921      </ul>
922    </nav>
923  </li>
924
925
926
927
928
929
930
931  <li class="md-nav__item md-nav__item--nested">
932
933      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
934
935    <label class="md-nav__link" for="nav-9">
936      Error Codes
937    </label>
938    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
939      <label class="md-nav__title" for="nav-9">
940        Error Codes
941      </label>
942      <ul class="md-nav__list" data-md-scrollfix>
943
944
945
946
947
948
949
950  <li class="md-nav__item">
951    <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
952      Error Enumerations
953    </a>
954  </li>
955
956
957
958
959
960
961
962  <li class="md-nav__item">
963    <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
964      Error Code Values
965    </a>
966  </li>
967
968
969      </ul>
970    </nav>
971  </li>
972
973
974
975
976
977
978
979  <li class="md-nav__item md-nav__item--nested">
980
981      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
982
983    <label class="md-nav__link" for="nav-10">
984      Miscellaneous
985    </label>
986    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
987      <label class="md-nav__title" for="nav-10">
988        Miscellaneous
989      </label>
990      <ul class="md-nav__list" data-md-scrollfix>
991
992
993
994
995
996
997
998  <li class="md-nav__item">
999    <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1000      TrueTypeGX/AAT Validation
1001    </a>
1002  </li>
1003
1004
1005
1006
1007
1008
1009
1010  <li class="md-nav__item">
1011    <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1012      Incremental Loading
1013    </a>
1014  </li>
1015
1016
1017
1018
1019
1020
1021
1022  <li class="md-nav__item">
1023    <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1024      The TrueType Engine
1025    </a>
1026  </li>
1027
1028
1029
1030
1031
1032
1033
1034  <li class="md-nav__item">
1035    <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1036      OpenType Validation
1037    </a>
1038  </li>
1039
1040
1041      </ul>
1042    </nav>
1043  </li>
1044
1045
1046  </ul>
1047</nav>
1048                  </div>
1049                </div>
1050              </div>
1051
1052
1053              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1054                <div class="md-sidebar__scrollwrap">
1055                  <div class="md-sidebar__inner">
1056
1057<nav class="md-nav md-nav--secondary">
1058
1059
1060
1061
1062
1063    <label class="md-nav__title" for="__toc">Table of contents</label>
1064    <ul class="md-nav__list" data-md-scrollfix>
1065
1066        <li class="md-nav__item">
1067  <a href="#synopsis" class="md-nav__link">
1068    Synopsis
1069  </a>
1070
1071</li>
1072
1073        <li class="md-nav__item">
1074  <a href="#ft_get_pfr_metrics" class="md-nav__link">
1075    FT_Get_PFR_Metrics
1076  </a>
1077
1078</li>
1079
1080        <li class="md-nav__item">
1081  <a href="#ft_get_pfr_kerning" class="md-nav__link">
1082    FT_Get_PFR_Kerning
1083  </a>
1084
1085</li>
1086
1087        <li class="md-nav__item">
1088  <a href="#ft_get_pfr_advance" class="md-nav__link">
1089    FT_Get_PFR_Advance
1090  </a>
1091
1092</li>
1093
1094
1095
1096
1097
1098    </ul>
1099
1100</nav>
1101                  </div>
1102                </div>
1103              </div>
1104
1105
1106          <div class="md-content">
1107            <article class="md-content__inner md-typeset">
1108
1109
1110
1111                <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#format-specific-api">Format-Specific API</a> &raquo; PFR Fonts</p>
1112<hr />
1113<h1 id="pfr-fonts">PFR Fonts<a class="headerlink" href="#pfr-fonts" title="Permanent link">&para;</a></h1>
1114<h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1115<p>This section contains the declaration of PFR-specific functions.</p>
1116<h2 id="ft_get_pfr_metrics">FT_Get_PFR_Metrics<a class="headerlink" href="#ft_get_pfr_metrics" title="Permanent link">&para;</a></h2>
1117<p>Defined in FT_PFR_H (freetype/ftpfr.h).</p>
1118<div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1119  <b>FT_Get_PFR_Metrics</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>    face,
1120                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>   *aoutline_resolution,
1121                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>   *ametrics_resolution,
1122                      <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *ametrics_x_scale,
1123                      <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *ametrics_y_scale );
1124</code></pre></div>
1125
1126<p>Return the outline and metrics resolutions of a given PFR face.</p>
1127<h4>input</h4>
1128
1129<table class="fields">
1130<tr><td class="val" id="face">face</td><td class="desc">
1131<p>Handle to the input face. It can be a non-PFR face.</p>
1132</td></tr>
1133</table>
1134
1135<h4>output</h4>
1136
1137<table class="fields">
1138<tr><td class="val" id="aoutline_resolution">aoutline_resolution</td><td class="desc">
1139<p>Outline resolution. This is equivalent to <code>face-&gt;units_per_EM</code> for non-PFR fonts. Optional (parameter can be <code>NULL</code>).</p>
1140</td></tr>
1141<tr><td class="val" id="ametrics_resolution">ametrics_resolution</td><td class="desc">
1142<p>Metrics resolution. This is equivalent to <code>outline_resolution</code> for non-PFR fonts. Optional (parameter can be <code>NULL</code>).</p>
1143</td></tr>
1144<tr><td class="val" id="ametrics_x_scale">ametrics_x_scale</td><td class="desc">
1145<p>A 16.16 fixed-point number used to scale distance expressed in metrics units to device subpixels. This is equivalent to <code>face-&gt;size-&gt;x_scale</code>, but for metrics only. Optional (parameter can be <code>NULL</code>).</p>
1146</td></tr>
1147<tr><td class="val" id="ametrics_y_scale">ametrics_y_scale</td><td class="desc">
1148<p>Same as <code>ametrics_x_scale</code> but for the vertical direction. optional (parameter can be <code>NULL</code>).</p>
1149</td></tr>
1150</table>
1151
1152<h4>return</h4>
1153
1154<p>FreeType error code. 0&nbsp;means success.</p>
1155<h4>note</h4>
1156
1157<p>If the input face is not a PFR, this function will return an error. However, in all cases, it will return valid values.</p>
1158<hr>
1159
1160<h2 id="ft_get_pfr_kerning">FT_Get_PFR_Kerning<a class="headerlink" href="#ft_get_pfr_kerning" title="Permanent link">&para;</a></h2>
1161<p>Defined in FT_PFR_H (freetype/ftpfr.h).</p>
1162<div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1163  <b>FT_Get_PFR_Kerning</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>     face,
1164                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     left,
1165                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>     right,
1166                      <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>  *avector );
1167</code></pre></div>
1168
1169<p>Return the kerning pair corresponding to two glyphs in a PFR face. The distance is expressed in metrics units, unlike the result of <code><a href="ft2-base_interface.html#ft_get_kerning">FT_Get_Kerning</a></code>.</p>
1170<h4>input</h4>
1171
1172<table class="fields">
1173<tr><td class="val" id="face">face</td><td class="desc">
1174<p>A handle to the input face.</p>
1175</td></tr>
1176<tr><td class="val" id="left">left</td><td class="desc">
1177<p>Index of the left glyph.</p>
1178</td></tr>
1179<tr><td class="val" id="right">right</td><td class="desc">
1180<p>Index of the right glyph.</p>
1181</td></tr>
1182</table>
1183
1184<h4>output</h4>
1185
1186<table class="fields">
1187<tr><td class="val" id="avector">avector</td><td class="desc">
1188<p>A kerning vector.</p>
1189</td></tr>
1190</table>
1191
1192<h4>return</h4>
1193
1194<p>FreeType error code. 0&nbsp;means success.</p>
1195<h4>note</h4>
1196
1197<p>This function always return distances in original PFR metrics units. This is unlike <code><a href="ft2-base_interface.html#ft_get_kerning">FT_Get_Kerning</a></code> with the <code><a href="ft2-base_interface.html#ft_kerning_mode">FT_KERNING_UNSCALED</a></code> mode, which always returns distances converted to outline units.</p>
1198<p>You can use the value of the <code>x_scale</code> and <code>y_scale</code> parameters returned by <code><a href="ft2-pfr_fonts.html#ft_get_pfr_metrics">FT_Get_PFR_Metrics</a></code> to scale these to device subpixels.</p>
1199<hr>
1200
1201<h2 id="ft_get_pfr_advance">FT_Get_PFR_Advance<a class="headerlink" href="#ft_get_pfr_advance" title="Permanent link">&para;</a></h2>
1202<p>Defined in FT_PFR_H (freetype/ftpfr.h).</p>
1203<div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1204  <b>FT_Get_PFR_Advance</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>   face,
1205                      <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>   gindex,
1206                      <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>   *aadvance );
1207</code></pre></div>
1208
1209<p>Return a given glyph advance, expressed in original metrics units, from a PFR font.</p>
1210<h4>input</h4>
1211
1212<table class="fields">
1213<tr><td class="val" id="face">face</td><td class="desc">
1214<p>A handle to the input face.</p>
1215</td></tr>
1216<tr><td class="val" id="gindex">gindex</td><td class="desc">
1217<p>The glyph index.</p>
1218</td></tr>
1219</table>
1220
1221<h4>output</h4>
1222
1223<table class="fields">
1224<tr><td class="val" id="aadvance">aadvance</td><td class="desc">
1225<p>The glyph advance in metrics units.</p>
1226</td></tr>
1227</table>
1228
1229<h4>return</h4>
1230
1231<p>FreeType error code. 0&nbsp;means success.</p>
1232<h4>note</h4>
1233
1234<p>You can use the <code>x_scale</code> or <code>y_scale</code> results of <code><a href="ft2-pfr_fonts.html#ft_get_pfr_metrics">FT_Get_PFR_Metrics</a></code> to convert the advance to device subpixels (i.e., 1/64<sup>th</sup> of pixels).</p>
1235<hr>
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246            </article>
1247          </div>
1248        </div>
1249      </main>
1250
1251
1252<footer class="md-footer">
1253
1254    <div class="md-footer-nav">
1255      <nav class="md-footer-nav__inner md-grid">
1256
1257          <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1258            <div class="md-flex__cell md-flex__cell--shrink">
1259              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1260            </div>
1261            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1262              <span class="md-flex__ellipsis">
1263                <span class="md-footer-nav__direction">
1264                  Previous
1265                </span>
1266                CID Fonts
1267              </span>
1268            </div>
1269          </a>
1270
1271
1272          <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
1273            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1274              <span class="md-flex__ellipsis">
1275                <span class="md-footer-nav__direction">
1276                  Next
1277                </span>
1278                Window FNT Files
1279              </span>
1280            </div>
1281            <div class="md-flex__cell md-flex__cell--shrink">
1282              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1283            </div>
1284          </a>
1285
1286      </nav>
1287    </div>
1288
1289  <div class="md-footer-meta md-typeset">
1290    <div class="md-footer-meta__inner md-grid">
1291      <div class="md-footer-copyright">
1292
1293          <div class="md-footer-copyright__highlight">
1294            Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1295          </div>
1296
1297        powered by
1298        <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1299        and
1300        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1301          Material for MkDocs</a>
1302      </div>
1303
1304    </div>
1305  </div>
1306</footer>
1307
1308    </div>
1309
1310      <script src="assets/javascripts/application.c33a9706.js"></script>
1311
1312      <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1313
1314        <script src="javascripts/extra.js"></script>
1315
1316
1317  </body>
1318</html>