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