• 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>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
93      <header class="md-header" data-md-component="header">
94  <nav class="md-header-nav md-grid">
95    <div class="md-flex">
96      <div class="md-flex__cell md-flex__cell--shrink">
97        <a href="/." title="FreeType-2.10.4 API Reference" aria-label="FreeType-2.10.4 API Reference" class="md-header-nav__button md-logo">
98
99            <img alt="logo" src="/images/favico.ico" width="24" height="24">
100
101        </a>
102      </div>
103      <div class="md-flex__cell md-flex__cell--shrink">
104        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
105      </div>
106      <div class="md-flex__cell md-flex__cell--stretch">
107        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
108
109            <span class="md-header-nav__topic">
110              FreeType-2.10.4 API Reference
111            </span>
112            <span class="md-header-nav__topic">
113
114
115
116            </span>
117
118        </div>
119      </div>
120      <div class="md-flex__cell md-flex__cell--shrink">
121
122          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
123
124<div class="md-search" data-md-component="search" role="dialog">
125  <label class="md-search__overlay" for="__search"></label>
126  <div class="md-search__inner" role="search">
127    <form class="md-search__form" name="search">
128      <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">
129      <label class="md-icon md-search__icon" for="__search"></label>
130      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
131        &#xE5CD;
132      </button>
133    </form>
134    <div class="md-search__output">
135      <div class="md-search__scrollwrap" data-md-scrollfix>
136        <div class="md-search-result" data-md-component="result">
137          <div class="md-search-result__meta">
138            Type to start searching
139          </div>
140          <ol class="md-search-result__list"></ol>
141        </div>
142      </div>
143    </div>
144  </div>
145</div>
146
147      </div>
148
149    </div>
150  </nav>
151</header>
152
153    <div class="md-container">
154
155
156
157
158      <main class="md-main" role="main">
159        <div class="md-main__inner md-grid" data-md-component="container">
160
161
162              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
163                <div class="md-sidebar__scrollwrap">
164                  <div class="md-sidebar__inner">
165                    <nav class="md-nav md-nav--primary" data-md-level="0">
166  <label class="md-nav__title md-nav__title--site" for="__drawer">
167    <a href="/." title="FreeType-2.10.4 API Reference" class="md-nav__button md-logo">
168
169        <img alt="logo" src="/images/favico.ico" width="48" height="48">
170
171    </a>
172    FreeType-2.10.4 API Reference
173  </label>
174
175  <ul class="md-nav__list" data-md-scrollfix>
176
177
178
179
180
181
182  <li class="md-nav__item">
183    <a href="/index.html" title="TOC" class="md-nav__link">
184      TOC
185    </a>
186  </li>
187
188
189
190
191
192
193
194  <li class="md-nav__item">
195    <a href="/ft2-index.html" title="Index" class="md-nav__link">
196      Index
197    </a>
198  </li>
199
200
201
202
203
204
205
206  <li class="md-nav__item md-nav__item--nested">
207
208      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
209
210    <label class="md-nav__link" for="nav-3">
211      General Remarks
212    </label>
213    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
214      <label class="md-nav__title" for="nav-3">
215        General Remarks
216      </label>
217      <ul class="md-nav__list" data-md-scrollfix>
218
219
220
221
222
223
224
225  <li class="md-nav__item">
226    <a href="/ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link">
227      FreeType's header inclusion scheme
228    </a>
229  </li>
230
231
232
233
234
235
236
237  <li class="md-nav__item">
238    <a href="/ft2-user_allocation.html" title="User allocation" class="md-nav__link">
239      User allocation
240    </a>
241  </li>
242
243
244      </ul>
245    </nav>
246  </li>
247
248
249
250
251
252
253
254  <li class="md-nav__item md-nav__item--nested">
255
256      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
257
258    <label class="md-nav__link" for="nav-4">
259      Core API
260    </label>
261    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
262      <label class="md-nav__title" for="nav-4">
263        Core API
264      </label>
265      <ul class="md-nav__list" data-md-scrollfix>
266
267
268
269
270
271
272
273  <li class="md-nav__item">
274    <a href="/ft2-version.html" title="FreeType Version" class="md-nav__link">
275      FreeType Version
276    </a>
277  </li>
278
279
280
281
282
283
284
285  <li class="md-nav__item">
286    <a href="/ft2-basic_types.html" title="Basic Data Types" class="md-nav__link">
287      Basic Data Types
288    </a>
289  </li>
290
291
292
293
294
295
296
297  <li class="md-nav__item">
298    <a href="/ft2-base_interface.html" title="Base Interface" class="md-nav__link">
299      Base Interface
300    </a>
301  </li>
302
303
304
305
306
307
308
309  <li class="md-nav__item">
310    <a href="/ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link">
311      Unicode Variation Sequences
312    </a>
313  </li>
314
315
316
317
318
319
320
321  <li class="md-nav__item">
322    <a href="/ft2-color_management.html" title="Glyph Color Management" class="md-nav__link">
323      Glyph Color Management
324    </a>
325  </li>
326
327
328
329
330
331
332
333  <li class="md-nav__item">
334    <a href="/ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link">
335      Glyph Layer Management
336    </a>
337  </li>
338
339
340
341
342
343
344
345  <li class="md-nav__item">
346    <a href="/ft2-glyph_management.html" title="Glyph Management" class="md-nav__link">
347      Glyph Management
348    </a>
349  </li>
350
351
352
353
354
355
356
357  <li class="md-nav__item">
358    <a href="/ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link">
359      Mac Specific Interface
360    </a>
361  </li>
362
363
364
365
366
367
368
369  <li class="md-nav__item">
370    <a href="/ft2-sizes_management.html" title="Size Management" class="md-nav__link">
371      Size Management
372    </a>
373  </li>
374
375
376
377
378
379
380
381  <li class="md-nav__item">
382    <a href="/ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link">
383      Header File Macros
384    </a>
385  </li>
386
387
388      </ul>
389    </nav>
390  </li>
391
392
393
394
395
396
397
398  <li class="md-nav__item md-nav__item--nested">
399
400      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
401
402    <label class="md-nav__link" for="nav-5">
403      Format-Specific API
404    </label>
405    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
406      <label class="md-nav__title" for="nav-5">
407        Format-Specific API
408      </label>
409      <ul class="md-nav__list" data-md-scrollfix>
410
411
412
413
414
415
416
417  <li class="md-nav__item">
418    <a href="/ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link">
419      Multiple Masters
420    </a>
421  </li>
422
423
424
425
426
427
428
429  <li class="md-nav__item">
430    <a href="/ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link">
431      TrueType Tables
432    </a>
433  </li>
434
435
436
437
438
439
440
441  <li class="md-nav__item">
442    <a href="/ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link">
443      Type 1 Tables
444    </a>
445  </li>
446
447
448
449
450
451
452
453  <li class="md-nav__item">
454    <a href="/ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link">
455      SFNT Names
456    </a>
457  </li>
458
459
460
461
462
463
464
465  <li class="md-nav__item">
466    <a href="/ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link">
467      BDF and PCF Files
468    </a>
469  </li>
470
471
472
473
474
475
476
477  <li class="md-nav__item">
478    <a href="/ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
479      CID Fonts
480    </a>
481  </li>
482
483
484
485
486
487
488
489  <li class="md-nav__item">
490    <a href="/ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
491      PFR Fonts
492    </a>
493  </li>
494
495
496
497
498
499
500
501  <li class="md-nav__item">
502    <a href="/ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
503      Window FNT Files
504    </a>
505  </li>
506
507
508
509
510
511
512
513  <li class="md-nav__item">
514    <a href="/ft2-font_formats.html" title="Font Formats" class="md-nav__link">
515      Font Formats
516    </a>
517  </li>
518
519
520
521
522
523
524
525  <li class="md-nav__item">
526    <a href="/ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
527      Gasp Table
528    </a>
529  </li>
530
531
532      </ul>
533    </nav>
534  </li>
535
536
537
538
539
540
541
542  <li class="md-nav__item md-nav__item--nested">
543
544      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
545
546    <label class="md-nav__link" for="nav-6">
547      Controlling FreeType Modules
548    </label>
549    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
550      <label class="md-nav__title" for="nav-6">
551        Controlling FreeType Modules
552      </label>
553      <ul class="md-nav__list" data-md-scrollfix>
554
555
556
557
558
559
560
561  <li class="md-nav__item">
562    <a href="/ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
563      The auto-hinter
564    </a>
565  </li>
566
567
568
569
570
571
572
573  <li class="md-nav__item">
574    <a href="/ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
575      The CFF driver
576    </a>
577  </li>
578
579
580
581
582
583
584
585  <li class="md-nav__item">
586    <a href="/ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
587      The Type 1 and CID drivers
588    </a>
589  </li>
590
591
592
593
594
595
596
597  <li class="md-nav__item">
598    <a href="/ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
599      The TrueType driver
600    </a>
601  </li>
602
603
604
605
606
607
608
609  <li class="md-nav__item">
610    <a href="/ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
611      The PCF driver
612    </a>
613  </li>
614
615
616
617
618
619
620
621  <li class="md-nav__item">
622    <a href="/ft2-properties.html" title="Driver properties" class="md-nav__link">
623      Driver properties
624    </a>
625  </li>
626
627
628
629
630
631
632
633  <li class="md-nav__item">
634    <a href="/ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
635      Parameter Tags
636    </a>
637  </li>
638
639
640
641
642
643
644
645  <li class="md-nav__item">
646    <a href="/ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
647      Subpixel Rendering
648    </a>
649  </li>
650
651
652      </ul>
653    </nav>
654  </li>
655
656
657
658
659
660
661
662  <li class="md-nav__item md-nav__item--nested">
663
664      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
665
666    <label class="md-nav__link" for="nav-7">
667      Cache Sub-System
668    </label>
669    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
670      <label class="md-nav__title" for="nav-7">
671        Cache Sub-System
672      </label>
673      <ul class="md-nav__list" data-md-scrollfix>
674
675
676
677
678
679
680
681  <li class="md-nav__item">
682    <a href="/ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
683      Cache Sub-System
684    </a>
685  </li>
686
687
688      </ul>
689    </nav>
690  </li>
691
692
693
694
695
696
697
698  <li class="md-nav__item md-nav__item--nested">
699
700      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
701
702    <label class="md-nav__link" for="nav-8">
703      Support API
704    </label>
705    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
706      <label class="md-nav__title" for="nav-8">
707        Support API
708      </label>
709      <ul class="md-nav__list" data-md-scrollfix>
710
711
712
713
714
715
716
717  <li class="md-nav__item">
718    <a href="/ft2-computations.html" title="Computations" class="md-nav__link">
719      Computations
720    </a>
721  </li>
722
723
724
725
726
727
728
729  <li class="md-nav__item">
730    <a href="/ft2-list_processing.html" title="List Processing" class="md-nav__link">
731      List Processing
732    </a>
733  </li>
734
735
736
737
738
739
740
741  <li class="md-nav__item">
742    <a href="/ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
743      Outline Processing
744    </a>
745  </li>
746
747
748
749
750
751
752
753  <li class="md-nav__item">
754    <a href="/ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
755      Quick retrieval of advance values
756    </a>
757  </li>
758
759
760
761
762
763
764
765  <li class="md-nav__item">
766    <a href="/ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
767      Bitmap Handling
768    </a>
769  </li>
770
771
772
773
774
775
776
777  <li class="md-nav__item">
778    <a href="/ft2-raster.html" title="Scanline Converter" class="md-nav__link">
779      Scanline Converter
780    </a>
781  </li>
782
783
784
785
786
787
788
789  <li class="md-nav__item">
790    <a href="/ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
791      Glyph Stroker
792    </a>
793  </li>
794
795
796
797
798
799
800
801  <li class="md-nav__item">
802    <a href="/ft2-system_interface.html" title="System Interface" class="md-nav__link">
803      System Interface
804    </a>
805  </li>
806
807
808
809
810
811
812
813  <li class="md-nav__item">
814    <a href="/ft2-module_management.html" title="Module Management" class="md-nav__link">
815      Module Management
816    </a>
817  </li>
818
819
820
821
822
823
824
825  <li class="md-nav__item">
826    <a href="/ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
827      GZIP Streams
828    </a>
829  </li>
830
831
832
833
834
835
836
837  <li class="md-nav__item">
838    <a href="/ft2-lzw.html" title="LZW Streams" class="md-nav__link">
839      LZW Streams
840    </a>
841  </li>
842
843
844
845
846
847
848
849  <li class="md-nav__item">
850    <a href="/ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
851      BZIP2 Streams
852    </a>
853  </li>
854
855
856      </ul>
857    </nav>
858  </li>
859
860
861
862
863
864
865
866  <li class="md-nav__item md-nav__item--nested">
867
868      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
869
870    <label class="md-nav__link" for="nav-9">
871      Error Codes
872    </label>
873    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
874      <label class="md-nav__title" for="nav-9">
875        Error Codes
876      </label>
877      <ul class="md-nav__list" data-md-scrollfix>
878
879
880
881
882
883
884
885  <li class="md-nav__item">
886    <a href="/ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
887      Error Enumerations
888    </a>
889  </li>
890
891
892
893
894
895
896
897  <li class="md-nav__item">
898    <a href="/ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
899      Error Code Values
900    </a>
901  </li>
902
903
904      </ul>
905    </nav>
906  </li>
907
908
909
910
911
912
913
914  <li class="md-nav__item md-nav__item--nested">
915
916      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
917
918    <label class="md-nav__link" for="nav-10">
919      Miscellaneous
920    </label>
921    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
922      <label class="md-nav__title" for="nav-10">
923        Miscellaneous
924      </label>
925      <ul class="md-nav__list" data-md-scrollfix>
926
927
928
929
930
931
932
933  <li class="md-nav__item">
934    <a href="/ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
935      TrueTypeGX/AAT Validation
936    </a>
937  </li>
938
939
940
941
942
943
944
945  <li class="md-nav__item">
946    <a href="/ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
947      Incremental Loading
948    </a>
949  </li>
950
951
952
953
954
955
956
957  <li class="md-nav__item">
958    <a href="/ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
959      The TrueType Engine
960    </a>
961  </li>
962
963
964
965
966
967
968
969  <li class="md-nav__item">
970    <a href="/ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
971      OpenType Validation
972    </a>
973  </li>
974
975
976      </ul>
977    </nav>
978  </li>
979
980
981  </ul>
982</nav>
983                  </div>
984                </div>
985              </div>
986
987
988
989          <div class="md-content">
990            <article class="md-content__inner md-typeset">
991
992  <h1>404 - Not found</h1>
993
994
995
996
997
998
999            </article>
1000          </div>
1001        </div>
1002      </main>
1003
1004
1005<footer class="md-footer">
1006
1007  <div class="md-footer-meta md-typeset">
1008    <div class="md-footer-meta__inner md-grid">
1009      <div class="md-footer-copyright">
1010
1011          <div class="md-footer-copyright__highlight">
1012            Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1013          </div>
1014
1015        powered by
1016        <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1017        and
1018        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1019          Material for MkDocs</a>
1020      </div>
1021
1022    </div>
1023  </div>
1024</footer>
1025
1026    </div>
1027
1028      <script src="/assets/javascripts/application.c33a9706.js"></script>
1029
1030      <script>app.initialize({version:"1.1",url:{base:"/"}})</script>
1031
1032        <script src="/javascripts/extra.js"></script>
1033
1034
1035  </body>
1036</html>