• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2<!doctype html>
3<html lang="en" class="no-js">
4  <head>
5
6      <meta charset="utf-8">
7      <meta name="viewport" content="width=device-width,initial-scale=1">
8
9        <meta name="description" content="API Reference Documentation for FreeType-2.12.1">
10
11
12
13        <meta name="author" content="FreeType Contributors">
14
15
16      <link rel="icon" href="images/favico.ico">
17      <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9">
18
19
20
21        <title>Preamble - FreeType-2.12.1 API Reference</title>
22
23
24
25      <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css">
26
27
28        <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css">
29
30
31
32          <meta name="theme-color" content="#4cae4f">
33
34
35
36
37
38
39
40        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
41        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
42        <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style>
43
44
45
46
47      <link rel="stylesheet" href="stylesheets/extra.css">
48
49
50
51
52
53
54
55  </head>
56
57
58
59
60
61
62
63    <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green">
64
65
66    <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
67
68    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
69    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
70    <label class="md-overlay" for="__drawer"></label>
71    <div data-md-component="skip">
72
73
74        <a href="#preamble" class="md-skip">
75          Skip to content
76        </a>
77
78    </div>
79    <div data-md-component="announce">
80
81    </div>
82
83      <header class="md-header" data-md-component="header">
84  <nav class="md-header__inner md-grid" aria-label="Header">
85    <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo">
86
87  <img src="images/favico.ico" alt="logo">
88
89    </a>
90    <label class="md-header__button md-icon" for="__drawer">
91      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
92    </label>
93    <div class="md-header__title" data-md-component="header-title">
94      <div class="md-header__ellipsis">
95        <div class="md-header__topic">
96          <span class="md-ellipsis">
97            FreeType-2.12.1 API Reference
98          </span>
99        </div>
100        <div class="md-header__topic" data-md-component="header-topic">
101          <span class="md-ellipsis">
102
103              Preamble
104
105          </span>
106        </div>
107      </div>
108    </div>
109
110
111
112      <label class="md-header__button md-icon" for="__search">
113        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
114      </label>
115
116<div class="md-search" data-md-component="search" role="dialog">
117  <label class="md-search__overlay" for="__search"></label>
118  <div class="md-search__inner" role="search">
119    <form class="md-search__form" name="search">
120      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
121      <label class="md-search__icon md-icon" for="__search">
122        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
123        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124      </label>
125      <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
126        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
127      </button>
128    </form>
129    <div class="md-search__output">
130      <div class="md-search__scrollwrap" data-md-scrollfix>
131        <div class="md-search-result" data-md-component="search-result">
132          <div class="md-search-result__meta">
133            Initializing search
134          </div>
135          <ol class="md-search-result__list"></ol>
136        </div>
137      </div>
138    </div>
139  </div>
140</div>
141
142
143  </nav>
144</header>
145
146    <div class="md-container" data-md-component="container">
147
148
149
150
151      <main class="md-main" data-md-component="main">
152        <div class="md-main__inner md-grid">
153
154
155
156              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
157                <div class="md-sidebar__scrollwrap">
158                  <div class="md-sidebar__inner">
159
160
161
162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163  <label class="md-nav__title" for="__drawer">
164    <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo">
165
166  <img src="images/favico.ico" alt="logo">
167
168    </a>
169    FreeType-2.12.1 API Reference
170  </label>
171
172  <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181    <li class="md-nav__item">
182      <a href="index.html" class="md-nav__link">
183        TOC
184      </a>
185    </li>
186
187
188
189
190
191
192
193
194
195
196    <li class="md-nav__item">
197      <a href="ft2-index.html" class="md-nav__link">
198        Index
199      </a>
200    </li>
201
202
203
204
205
206
207
208
209
210
211
212
213
214    <li class="md-nav__item md-nav__item--active md-nav__item--nested">
215
216
217        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
218
219      <label class="md-nav__link" for="__nav_3">
220        General Remarks
221        <span class="md-nav__icon md-icon"></span>
222      </label>
223      <nav class="md-nav" aria-label="General Remarks" data-md-level="1">
224        <label class="md-nav__title" for="__nav_3">
225          <span class="md-nav__icon md-icon"></span>
226          General Remarks
227        </label>
228        <ul class="md-nav__list" data-md-scrollfix>
229
230
231
232
233
234
235
236    <li class="md-nav__item md-nav__item--active">
237
238      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
239
240
241
242
243
244        <label class="md-nav__link md-nav__link--active" for="__toc">
245          Preamble
246          <span class="md-nav__icon md-icon"></span>
247        </label>
248
249      <a href="ft2-preamble.html" class="md-nav__link md-nav__link--active">
250        Preamble
251      </a>
252
253
254<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
255
256
257
258
259
260
261    <label class="md-nav__title" for="__toc">
262      <span class="md-nav__icon md-icon"></span>
263      Table of contents
264    </label>
265    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
266
267        <li class="md-nav__item">
268  <a href="#synopsis" class="md-nav__link">
269    Synopsis
270  </a>
271
272</li>
273
274    </ul>
275
276</nav>
277
278    </li>
279
280
281
282
283
284
285
286    <li class="md-nav__item">
287      <a href="ft2-header_inclusion.html" class="md-nav__link">
288        FreeType's header inclusion scheme
289      </a>
290    </li>
291
292
293
294
295
296
297
298    <li class="md-nav__item">
299      <a href="ft2-user_allocation.html" class="md-nav__link">
300        User allocation
301      </a>
302    </li>
303
304
305
306        </ul>
307      </nav>
308    </li>
309
310
311
312
313
314
315
316
317
318
319
320    <li class="md-nav__item md-nav__item--nested">
321
322
323        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
324
325      <label class="md-nav__link" for="__nav_4">
326        Core API
327        <span class="md-nav__icon md-icon"></span>
328      </label>
329      <nav class="md-nav" aria-label="Core API" data-md-level="1">
330        <label class="md-nav__title" for="__nav_4">
331          <span class="md-nav__icon md-icon"></span>
332          Core API
333        </label>
334        <ul class="md-nav__list" data-md-scrollfix>
335
336
337
338
339
340    <li class="md-nav__item">
341      <a href="ft2-version.html" class="md-nav__link">
342        FreeType Version
343      </a>
344    </li>
345
346
347
348
349
350
351
352    <li class="md-nav__item">
353      <a href="ft2-basic_types.html" class="md-nav__link">
354        Basic Data Types
355      </a>
356    </li>
357
358
359
360
361
362
363
364    <li class="md-nav__item">
365      <a href="ft2-base_interface.html" class="md-nav__link">
366        Base Interface
367      </a>
368    </li>
369
370
371
372
373
374
375
376    <li class="md-nav__item">
377      <a href="ft2-glyph_variants.html" class="md-nav__link">
378        Unicode Variation Sequences
379      </a>
380    </li>
381
382
383
384
385
386
387
388    <li class="md-nav__item">
389      <a href="ft2-color_management.html" class="md-nav__link">
390        Glyph Color Management
391      </a>
392    </li>
393
394
395
396
397
398
399
400    <li class="md-nav__item">
401      <a href="ft2-layer_management.html" class="md-nav__link">
402        Glyph Layer Management
403      </a>
404    </li>
405
406
407
408
409
410
411
412    <li class="md-nav__item">
413      <a href="ft2-glyph_management.html" class="md-nav__link">
414        Glyph Management
415      </a>
416    </li>
417
418
419
420
421
422
423
424    <li class="md-nav__item">
425      <a href="ft2-mac_specific.html" class="md-nav__link">
426        Mac Specific Interface
427      </a>
428    </li>
429
430
431
432
433
434
435
436    <li class="md-nav__item">
437      <a href="ft2-sizes_management.html" class="md-nav__link">
438        Size Management
439      </a>
440    </li>
441
442
443
444
445
446
447
448    <li class="md-nav__item">
449      <a href="ft2-header_file_macros.html" class="md-nav__link">
450        Header File Macros
451      </a>
452    </li>
453
454
455
456        </ul>
457      </nav>
458    </li>
459
460
461
462
463
464
465
466
467
468
469
470    <li class="md-nav__item md-nav__item--nested">
471
472
473        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
474
475      <label class="md-nav__link" for="__nav_5">
476        Format-Specific API
477        <span class="md-nav__icon md-icon"></span>
478      </label>
479      <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
480        <label class="md-nav__title" for="__nav_5">
481          <span class="md-nav__icon md-icon"></span>
482          Format-Specific API
483        </label>
484        <ul class="md-nav__list" data-md-scrollfix>
485
486
487
488
489
490    <li class="md-nav__item">
491      <a href="ft2-multiple_masters.html" class="md-nav__link">
492        Multiple Masters
493      </a>
494    </li>
495
496
497
498
499
500
501
502    <li class="md-nav__item">
503      <a href="ft2-truetype_tables.html" class="md-nav__link">
504        TrueType Tables
505      </a>
506    </li>
507
508
509
510
511
512
513
514    <li class="md-nav__item">
515      <a href="ft2-type1_tables.html" class="md-nav__link">
516        Type 1 Tables
517      </a>
518    </li>
519
520
521
522
523
524
525
526    <li class="md-nav__item">
527      <a href="ft2-sfnt_names.html" class="md-nav__link">
528        SFNT Names
529      </a>
530    </li>
531
532
533
534
535
536
537
538    <li class="md-nav__item">
539      <a href="ft2-bdf_fonts.html" class="md-nav__link">
540        BDF and PCF Files
541      </a>
542    </li>
543
544
545
546
547
548
549
550    <li class="md-nav__item">
551      <a href="ft2-cid_fonts.html" class="md-nav__link">
552        CID Fonts
553      </a>
554    </li>
555
556
557
558
559
560
561
562    <li class="md-nav__item">
563      <a href="ft2-pfr_fonts.html" class="md-nav__link">
564        PFR Fonts
565      </a>
566    </li>
567
568
569
570
571
572
573
574    <li class="md-nav__item">
575      <a href="ft2-winfnt_fonts.html" class="md-nav__link">
576        Window FNT Files
577      </a>
578    </li>
579
580
581
582
583
584
585
586    <li class="md-nav__item">
587      <a href="ft2-svg_fonts.html" class="md-nav__link">
588        OpenType SVG Fonts
589      </a>
590    </li>
591
592
593
594
595
596
597
598    <li class="md-nav__item">
599      <a href="ft2-font_formats.html" class="md-nav__link">
600        Font Formats
601      </a>
602    </li>
603
604
605
606
607
608
609
610    <li class="md-nav__item">
611      <a href="ft2-gasp_table.html" class="md-nav__link">
612        Gasp Table
613      </a>
614    </li>
615
616
617
618        </ul>
619      </nav>
620    </li>
621
622
623
624
625
626
627
628
629
630
631
632    <li class="md-nav__item md-nav__item--nested">
633
634
635        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
636
637      <label class="md-nav__link" for="__nav_6">
638        Controlling FreeType Modules
639        <span class="md-nav__icon md-icon"></span>
640      </label>
641      <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
642        <label class="md-nav__title" for="__nav_6">
643          <span class="md-nav__icon md-icon"></span>
644          Controlling FreeType Modules
645        </label>
646        <ul class="md-nav__list" data-md-scrollfix>
647
648
649
650
651
652    <li class="md-nav__item">
653      <a href="ft2-auto_hinter.html" class="md-nav__link">
654        The auto-hinter
655      </a>
656    </li>
657
658
659
660
661
662
663
664    <li class="md-nav__item">
665      <a href="ft2-cff_driver.html" class="md-nav__link">
666        The CFF driver
667      </a>
668    </li>
669
670
671
672
673
674
675
676    <li class="md-nav__item">
677      <a href="ft2-t1_cid_driver.html" class="md-nav__link">
678        The Type 1 and CID drivers
679      </a>
680    </li>
681
682
683
684
685
686
687
688    <li class="md-nav__item">
689      <a href="ft2-tt_driver.html" class="md-nav__link">
690        The TrueType driver
691      </a>
692    </li>
693
694
695
696
697
698
699
700    <li class="md-nav__item">
701      <a href="ft2-pcf_driver.html" class="md-nav__link">
702        The PCF driver
703      </a>
704    </li>
705
706
707
708
709
710
711
712    <li class="md-nav__item">
713      <a href="ft2-ot_svg_driver.html" class="md-nav__link">
714        The SVG driver
715      </a>
716    </li>
717
718
719
720
721
722
723
724    <li class="md-nav__item">
725      <a href="ft2-properties.html" class="md-nav__link">
726        Driver properties
727      </a>
728    </li>
729
730
731
732
733
734
735
736    <li class="md-nav__item">
737      <a href="ft2-parameter_tags.html" class="md-nav__link">
738        Parameter Tags
739      </a>
740    </li>
741
742
743
744
745
746
747
748    <li class="md-nav__item">
749      <a href="ft2-lcd_rendering.html" class="md-nav__link">
750        Subpixel Rendering
751      </a>
752    </li>
753
754
755
756        </ul>
757      </nav>
758    </li>
759
760
761
762
763
764
765
766
767
768
769
770    <li class="md-nav__item md-nav__item--nested">
771
772
773        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
774
775      <label class="md-nav__link" for="__nav_7">
776        Cache Sub-System
777        <span class="md-nav__icon md-icon"></span>
778      </label>
779      <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
780        <label class="md-nav__title" for="__nav_7">
781          <span class="md-nav__icon md-icon"></span>
782          Cache Sub-System
783        </label>
784        <ul class="md-nav__list" data-md-scrollfix>
785
786
787
788
789
790    <li class="md-nav__item">
791      <a href="ft2-cache_subsystem.html" class="md-nav__link">
792        Cache Sub-System
793      </a>
794    </li>
795
796
797
798        </ul>
799      </nav>
800    </li>
801
802
803
804
805
806
807
808
809
810
811
812    <li class="md-nav__item md-nav__item--nested">
813
814
815        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
816
817      <label class="md-nav__link" for="__nav_8">
818        Support API
819        <span class="md-nav__icon md-icon"></span>
820      </label>
821      <nav class="md-nav" aria-label="Support API" data-md-level="1">
822        <label class="md-nav__title" for="__nav_8">
823          <span class="md-nav__icon md-icon"></span>
824          Support API
825        </label>
826        <ul class="md-nav__list" data-md-scrollfix>
827
828
829
830
831
832    <li class="md-nav__item">
833      <a href="ft2-computations.html" class="md-nav__link">
834        Computations
835      </a>
836    </li>
837
838
839
840
841
842
843
844    <li class="md-nav__item">
845      <a href="ft2-list_processing.html" class="md-nav__link">
846        List Processing
847      </a>
848    </li>
849
850
851
852
853
854
855
856    <li class="md-nav__item">
857      <a href="ft2-outline_processing.html" class="md-nav__link">
858        Outline Processing
859      </a>
860    </li>
861
862
863
864
865
866
867
868    <li class="md-nav__item">
869      <a href="ft2-quick_advance.html" class="md-nav__link">
870        Quick retrieval of advance values
871      </a>
872    </li>
873
874
875
876
877
878
879
880    <li class="md-nav__item">
881      <a href="ft2-bitmap_handling.html" class="md-nav__link">
882        Bitmap Handling
883      </a>
884    </li>
885
886
887
888
889
890
891
892    <li class="md-nav__item">
893      <a href="ft2-raster.html" class="md-nav__link">
894        Scanline Converter
895      </a>
896    </li>
897
898
899
900
901
902
903
904    <li class="md-nav__item">
905      <a href="ft2-glyph_stroker.html" class="md-nav__link">
906        Glyph Stroker
907      </a>
908    </li>
909
910
911
912
913
914
915
916    <li class="md-nav__item">
917      <a href="ft2-system_interface.html" class="md-nav__link">
918        System Interface
919      </a>
920    </li>
921
922
923
924
925
926
927
928    <li class="md-nav__item">
929      <a href="ft2-module_management.html" class="md-nav__link">
930        Module Management
931      </a>
932    </li>
933
934
935
936
937
938
939
940    <li class="md-nav__item">
941      <a href="ft2-gzip.html" class="md-nav__link">
942        GZIP Streams
943      </a>
944    </li>
945
946
947
948
949
950
951
952    <li class="md-nav__item">
953      <a href="ft2-lzw.html" class="md-nav__link">
954        LZW Streams
955      </a>
956    </li>
957
958
959
960
961
962
963
964    <li class="md-nav__item">
965      <a href="ft2-bzip2.html" class="md-nav__link">
966        BZIP2 Streams
967      </a>
968    </li>
969
970
971
972
973
974
975
976    <li class="md-nav__item">
977      <a href="ft2-debugging_apis.html" class="md-nav__link">
978        External Debugging APIs
979      </a>
980    </li>
981
982
983
984        </ul>
985      </nav>
986    </li>
987
988
989
990
991
992
993
994
995
996
997
998    <li class="md-nav__item md-nav__item--nested">
999
1000
1001        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
1002
1003      <label class="md-nav__link" for="__nav_9">
1004        Error Codes
1005        <span class="md-nav__icon md-icon"></span>
1006      </label>
1007      <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1008        <label class="md-nav__title" for="__nav_9">
1009          <span class="md-nav__icon md-icon"></span>
1010          Error Codes
1011        </label>
1012        <ul class="md-nav__list" data-md-scrollfix>
1013
1014
1015
1016
1017
1018    <li class="md-nav__item">
1019      <a href="ft2-error_enumerations.html" class="md-nav__link">
1020        Error Enumerations
1021      </a>
1022    </li>
1023
1024
1025
1026
1027
1028
1029
1030    <li class="md-nav__item">
1031      <a href="ft2-error_code_values.html" class="md-nav__link">
1032        Error Code Values
1033      </a>
1034    </li>
1035
1036
1037
1038        </ul>
1039      </nav>
1040    </li>
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052    <li class="md-nav__item md-nav__item--nested">
1053
1054
1055        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
1056
1057      <label class="md-nav__link" for="__nav_10">
1058        Miscellaneous
1059        <span class="md-nav__icon md-icon"></span>
1060      </label>
1061      <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1062        <label class="md-nav__title" for="__nav_10">
1063          <span class="md-nav__icon md-icon"></span>
1064          Miscellaneous
1065        </label>
1066        <ul class="md-nav__list" data-md-scrollfix>
1067
1068
1069
1070
1071
1072    <li class="md-nav__item">
1073      <a href="ft2-gx_validation.html" class="md-nav__link">
1074        TrueTypeGX/AAT Validation
1075      </a>
1076    </li>
1077
1078
1079
1080
1081
1082
1083
1084    <li class="md-nav__item">
1085      <a href="ft2-incremental.html" class="md-nav__link">
1086        Incremental Loading
1087      </a>
1088    </li>
1089
1090
1091
1092
1093
1094
1095
1096    <li class="md-nav__item">
1097      <a href="ft2-truetype_engine.html" class="md-nav__link">
1098        The TrueType Engine
1099      </a>
1100    </li>
1101
1102
1103
1104
1105
1106
1107
1108    <li class="md-nav__item">
1109      <a href="ft2-ot_validation.html" class="md-nav__link">
1110        OpenType Validation
1111      </a>
1112    </li>
1113
1114
1115
1116        </ul>
1117      </nav>
1118    </li>
1119
1120
1121
1122  </ul>
1123</nav>
1124                  </div>
1125                </div>
1126              </div>
1127
1128
1129
1130              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1131                <div class="md-sidebar__scrollwrap">
1132                  <div class="md-sidebar__inner">
1133
1134<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1135
1136
1137
1138
1139
1140
1141    <label class="md-nav__title" for="__toc">
1142      <span class="md-nav__icon md-icon"></span>
1143      Table of contents
1144    </label>
1145    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1146
1147        <li class="md-nav__item">
1148  <a href="#synopsis" class="md-nav__link">
1149    Synopsis
1150  </a>
1151
1152</li>
1153
1154    </ul>
1155
1156</nav>
1157                  </div>
1158                </div>
1159              </div>
1160
1161
1162          <div class="md-content" data-md-component="content">
1163            <article class="md-content__inner md-typeset">
1164
1165
1166
1167                <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#general-remarks">General Remarks</a> &raquo; Preamble</p>
1168<hr />
1169<h1 id="preamble">Preamble<a class="headerlink" href="#preamble" title="Permanent link">&para;</a></h1>
1170<h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1171<p>FreeType is a library that provides access to glyphs in font files. It scales the glyph images and their metrics to a requested size, and it rasterizes the glyph images to produce pixel or subpixel alpha coverage bitmaps.</p>
1172<p>Note that FreeType is <em>not</em> a text layout engine. You have to use higher-level libraries like HarfBuzz, Pango, or ICU for that.</p>
1173<p>Note also that FreeType does <em>not</em> perform alpha blending or compositing the resulting bitmaps or pixmaps by itself. Use your favourite graphics library (for example, Cairo or Skia) to further process FreeType's output.</p>
1174
1175
1176
1177
1178
1179
1180
1181            </article>
1182          </div>
1183        </div>
1184
1185      </main>
1186
1187
1188<footer class="md-footer">
1189
1190    <nav class="md-footer__inner md-grid" aria-label="Footer">
1191
1192
1193        <a href="ft2-index.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Index" rel="prev">
1194          <div class="md-footer__button md-icon">
1195            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
1196          </div>
1197          <div class="md-footer__title">
1198            <div class="md-ellipsis">
1199              <span class="md-footer__direction">
1200                Previous
1201              </span>
1202              Index
1203            </div>
1204          </div>
1205        </a>
1206
1207
1208
1209        <a href="ft2-header_inclusion.html" class="md-footer__link md-footer__link--next" aria-label="Next: FreeType&#39;s header inclusion scheme" rel="next">
1210          <div class="md-footer__title">
1211            <div class="md-ellipsis">
1212              <span class="md-footer__direction">
1213                Next
1214              </span>
1215              FreeType's header inclusion scheme
1216            </div>
1217          </div>
1218          <div class="md-footer__button md-icon">
1219            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
1220          </div>
1221        </a>
1222
1223    </nav>
1224
1225  <div class="md-footer-meta md-typeset">
1226    <div class="md-footer-meta__inner md-grid">
1227      <div class="md-footer-copyright">
1228
1229          <div class="md-footer-copyright__highlight">
1230            Copyright 2022 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1231          </div>
1232
1233        Made with
1234        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1235          Material for MkDocs
1236        </a>
1237
1238      </div>
1239
1240    </div>
1241  </div>
1242</footer>
1243
1244    </div>
1245    <div class="md-dialog" data-md-component="dialog">
1246      <div class="md-dialog__inner md-typeset"></div>
1247    </div>
1248    <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script>
1249
1250
1251      <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
1252
1253        <script src="javascripts/extra.js"></script>
1254
1255
1256  </body>
1257</html>