Imported Upstream version 2.10.4
[platform/upstream/freetype2.git] / docs / reference / 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.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>BDF and PCF Files - 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="#bdf-and-pcf-files" 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                 BDF and PCF Files
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
472
473   <li class="md-nav__item md-nav__item--active">
474     
475     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
476     
477       
478     
479     
480       <label class="md-nav__link md-nav__link--active" for="__toc">
481         BDF and PCF Files
482       </label>
483     
484     <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link md-nav__link--active">
485       BDF and PCF Files
486     </a>
487     
488       
489 <nav class="md-nav md-nav--secondary">
490   
491   
492     
493   
494   
495     <label class="md-nav__title" for="__toc">Table of contents</label>
496     <ul class="md-nav__list" data-md-scrollfix>
497       
498         <li class="md-nav__item">
499   <a href="#synopsis" class="md-nav__link">
500     Synopsis
501   </a>
502   
503 </li>
504       
505         <li class="md-nav__item">
506   <a href="#bdf_propertytype" class="md-nav__link">
507     BDF_PropertyType
508   </a>
509   
510 </li>
511       
512         <li class="md-nav__item">
513   <a href="#bdf_property" class="md-nav__link">
514     BDF_Property
515   </a>
516   
517 </li>
518       
519         <li class="md-nav__item">
520   <a href="#bdf_propertyrec" class="md-nav__link">
521     BDF_PropertyRec
522   </a>
523   
524 </li>
525       
526         <li class="md-nav__item">
527   <a href="#ft_get_bdf_charset_id" class="md-nav__link">
528     FT_Get_BDF_Charset_ID
529   </a>
530   
531 </li>
532       
533         <li class="md-nav__item">
534   <a href="#ft_get_bdf_property" class="md-nav__link">
535     FT_Get_BDF_Property
536   </a>
537   
538 </li>
539       
540       
541       
542       
543       
544     </ul>
545   
546 </nav>
547     
548   </li>
549
550         
551           
552           
553           
554
555
556   <li class="md-nav__item">
557     <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link">
558       CID Fonts
559     </a>
560   </li>
561
562         
563           
564           
565           
566
567
568   <li class="md-nav__item">
569     <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link">
570       PFR Fonts
571     </a>
572   </li>
573
574         
575           
576           
577           
578
579
580   <li class="md-nav__item">
581     <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link">
582       Window FNT Files
583     </a>
584   </li>
585
586         
587           
588           
589           
590
591
592   <li class="md-nav__item">
593     <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link">
594       Font Formats
595     </a>
596   </li>
597
598         
599           
600           
601           
602
603
604   <li class="md-nav__item">
605     <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link">
606       Gasp Table
607     </a>
608   </li>
609
610         
611       </ul>
612     </nav>
613   </li>
614
615     
616       
617       
618       
619
620
621   <li class="md-nav__item md-nav__item--nested">
622     
623       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
624     
625     <label class="md-nav__link" for="nav-6">
626       Controlling FreeType Modules
627     </label>
628     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
629       <label class="md-nav__title" for="nav-6">
630         Controlling FreeType Modules
631       </label>
632       <ul class="md-nav__list" data-md-scrollfix>
633         
634         
635           
636           
637           
638
639
640   <li class="md-nav__item">
641     <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link">
642       The auto-hinter
643     </a>
644   </li>
645
646         
647           
648           
649           
650
651
652   <li class="md-nav__item">
653     <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link">
654       The CFF driver
655     </a>
656   </li>
657
658         
659           
660           
661           
662
663
664   <li class="md-nav__item">
665     <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link">
666       The Type 1 and CID drivers
667     </a>
668   </li>
669
670         
671           
672           
673           
674
675
676   <li class="md-nav__item">
677     <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link">
678       The TrueType driver
679     </a>
680   </li>
681
682         
683           
684           
685           
686
687
688   <li class="md-nav__item">
689     <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link">
690       The PCF driver
691     </a>
692   </li>
693
694         
695           
696           
697           
698
699
700   <li class="md-nav__item">
701     <a href="ft2-properties.html" title="Driver properties" class="md-nav__link">
702       Driver properties
703     </a>
704   </li>
705
706         
707           
708           
709           
710
711
712   <li class="md-nav__item">
713     <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link">
714       Parameter Tags
715     </a>
716   </li>
717
718         
719           
720           
721           
722
723
724   <li class="md-nav__item">
725     <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link">
726       Subpixel Rendering
727     </a>
728   </li>
729
730         
731       </ul>
732     </nav>
733   </li>
734
735     
736       
737       
738       
739
740
741   <li class="md-nav__item md-nav__item--nested">
742     
743       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
744     
745     <label class="md-nav__link" for="nav-7">
746       Cache Sub-System
747     </label>
748     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
749       <label class="md-nav__title" for="nav-7">
750         Cache Sub-System
751       </label>
752       <ul class="md-nav__list" data-md-scrollfix>
753         
754         
755           
756           
757           
758
759
760   <li class="md-nav__item">
761     <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link">
762       Cache Sub-System
763     </a>
764   </li>
765
766         
767       </ul>
768     </nav>
769   </li>
770
771     
772       
773       
774       
775
776
777   <li class="md-nav__item md-nav__item--nested">
778     
779       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
780     
781     <label class="md-nav__link" for="nav-8">
782       Support API
783     </label>
784     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
785       <label class="md-nav__title" for="nav-8">
786         Support API
787       </label>
788       <ul class="md-nav__list" data-md-scrollfix>
789         
790         
791           
792           
793           
794
795
796   <li class="md-nav__item">
797     <a href="ft2-computations.html" title="Computations" class="md-nav__link">
798       Computations
799     </a>
800   </li>
801
802         
803           
804           
805           
806
807
808   <li class="md-nav__item">
809     <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link">
810       List Processing
811     </a>
812   </li>
813
814         
815           
816           
817           
818
819
820   <li class="md-nav__item">
821     <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link">
822       Outline Processing
823     </a>
824   </li>
825
826         
827           
828           
829           
830
831
832   <li class="md-nav__item">
833     <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link">
834       Quick retrieval of advance values
835     </a>
836   </li>
837
838         
839           
840           
841           
842
843
844   <li class="md-nav__item">
845     <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link">
846       Bitmap Handling
847     </a>
848   </li>
849
850         
851           
852           
853           
854
855
856   <li class="md-nav__item">
857     <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link">
858       Scanline Converter
859     </a>
860   </li>
861
862         
863           
864           
865           
866
867
868   <li class="md-nav__item">
869     <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link">
870       Glyph Stroker
871     </a>
872   </li>
873
874         
875           
876           
877           
878
879
880   <li class="md-nav__item">
881     <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link">
882       System Interface
883     </a>
884   </li>
885
886         
887           
888           
889           
890
891
892   <li class="md-nav__item">
893     <a href="ft2-module_management.html" title="Module Management" class="md-nav__link">
894       Module Management
895     </a>
896   </li>
897
898         
899           
900           
901           
902
903
904   <li class="md-nav__item">
905     <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link">
906       GZIP Streams
907     </a>
908   </li>
909
910         
911           
912           
913           
914
915
916   <li class="md-nav__item">
917     <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link">
918       LZW Streams
919     </a>
920   </li>
921
922         
923           
924           
925           
926
927
928   <li class="md-nav__item">
929     <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link">
930       BZIP2 Streams
931     </a>
932   </li>
933
934         
935       </ul>
936     </nav>
937   </li>
938
939     
940       
941       
942       
943
944
945   <li class="md-nav__item md-nav__item--nested">
946     
947       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
948     
949     <label class="md-nav__link" for="nav-9">
950       Error Codes
951     </label>
952     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
953       <label class="md-nav__title" for="nav-9">
954         Error Codes
955       </label>
956       <ul class="md-nav__list" data-md-scrollfix>
957         
958         
959           
960           
961           
962
963
964   <li class="md-nav__item">
965     <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link">
966       Error Enumerations
967     </a>
968   </li>
969
970         
971           
972           
973           
974
975
976   <li class="md-nav__item">
977     <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link">
978       Error Code Values
979     </a>
980   </li>
981
982         
983       </ul>
984     </nav>
985   </li>
986
987     
988       
989       
990       
991
992
993   <li class="md-nav__item md-nav__item--nested">
994     
995       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
996     
997     <label class="md-nav__link" for="nav-10">
998       Miscellaneous
999     </label>
1000     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
1001       <label class="md-nav__title" for="nav-10">
1002         Miscellaneous
1003       </label>
1004       <ul class="md-nav__list" data-md-scrollfix>
1005         
1006         
1007           
1008           
1009           
1010
1011
1012   <li class="md-nav__item">
1013     <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link">
1014       TrueTypeGX/AAT Validation
1015     </a>
1016   </li>
1017
1018         
1019           
1020           
1021           
1022
1023
1024   <li class="md-nav__item">
1025     <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link">
1026       Incremental Loading
1027     </a>
1028   </li>
1029
1030         
1031           
1032           
1033           
1034
1035
1036   <li class="md-nav__item">
1037     <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link">
1038       The TrueType Engine
1039     </a>
1040   </li>
1041
1042         
1043           
1044           
1045           
1046
1047
1048   <li class="md-nav__item">
1049     <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link">
1050       OpenType Validation
1051     </a>
1052   </li>
1053
1054         
1055       </ul>
1056     </nav>
1057   </li>
1058
1059     
1060   </ul>
1061 </nav>
1062                   </div>
1063                 </div>
1064               </div>
1065             
1066             
1067               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1068                 <div class="md-sidebar__scrollwrap">
1069                   <div class="md-sidebar__inner">
1070                     
1071 <nav class="md-nav md-nav--secondary">
1072   
1073   
1074     
1075   
1076   
1077     <label class="md-nav__title" for="__toc">Table of contents</label>
1078     <ul class="md-nav__list" data-md-scrollfix>
1079       
1080         <li class="md-nav__item">
1081   <a href="#synopsis" class="md-nav__link">
1082     Synopsis
1083   </a>
1084   
1085 </li>
1086       
1087         <li class="md-nav__item">
1088   <a href="#bdf_propertytype" class="md-nav__link">
1089     BDF_PropertyType
1090   </a>
1091   
1092 </li>
1093       
1094         <li class="md-nav__item">
1095   <a href="#bdf_property" class="md-nav__link">
1096     BDF_Property
1097   </a>
1098   
1099 </li>
1100       
1101         <li class="md-nav__item">
1102   <a href="#bdf_propertyrec" class="md-nav__link">
1103     BDF_PropertyRec
1104   </a>
1105   
1106 </li>
1107       
1108         <li class="md-nav__item">
1109   <a href="#ft_get_bdf_charset_id" class="md-nav__link">
1110     FT_Get_BDF_Charset_ID
1111   </a>
1112   
1113 </li>
1114       
1115         <li class="md-nav__item">
1116   <a href="#ft_get_bdf_property" class="md-nav__link">
1117     FT_Get_BDF_Property
1118   </a>
1119   
1120 </li>
1121       
1122       
1123       
1124       
1125       
1126     </ul>
1127   
1128 </nav>
1129                   </div>
1130                 </div>
1131               </div>
1132             
1133           
1134           <div class="md-content">
1135             <article class="md-content__inner md-typeset">
1136               
1137                 
1138                 
1139                 <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>
1140 <hr />
1141 <h1 id="bdf-and-pcf-files">BDF and PCF Files<a class="headerlink" href="#bdf-and-pcf-files" title="Permanent link">&para;</a></h1>
1142 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1143 <p>This section contains the declaration of functions specific to BDF and PCF fonts.</p>
1144 <h2 id="bdf_propertytype">BDF_PropertyType<a class="headerlink" href="#bdf_propertytype" title="Permanent link">&para;</a></h2>
1145 <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
1146 <div class = "codehilite"><pre><code>  <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 </code></pre></div>
1155
1156 <p>A list of BDF property types.</p>
1157 <h4>values</h4>
1158
1159 <table class="fields long">
1160 <tr><td class="val" id="bdf_property_type_none">BDF_PROPERTY_TYPE_NONE</td><td class="desc">
1161 <p>Value&nbsp;0 is used to indicate a missing property.</p>
1162 </td></tr>
1163 <tr><td class="val" id="bdf_property_type_atom">BDF_PROPERTY_TYPE_ATOM</td><td class="desc">
1164 <p>Property is a string atom.</p>
1165 </td></tr>
1166 <tr><td class="val" id="bdf_property_type_integer">BDF_PROPERTY_TYPE_INTEGER</td><td class="desc">
1167 <p>Property is a 32-bit signed integer.</p>
1168 </td></tr>
1169 <tr><td class="val" id="bdf_property_type_cardinal">BDF_PROPERTY_TYPE_CARDINAL</td><td class="desc">
1170 <p>Property is a 32-bit unsigned integer.</p>
1171 </td></tr>
1172 </table>
1173
1174 <hr>
1175
1176 <h2 id="bdf_property">BDF_Property<a class="headerlink" href="#bdf_property" title="Permanent link">&para;</a></h2>
1177 <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
1178 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span> BDF_PropertyRec_*  <b>BDF_Property</b>;
1179 </code></pre></div>
1180
1181 <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>
1182 <hr>
1183
1184 <h2 id="bdf_propertyrec">BDF_PropertyRec<a class="headerlink" href="#bdf_propertyrec" title="Permanent link">&para;</a></h2>
1185 <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
1186 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  BDF_PropertyRec_
1187   {
1188     <a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PropertyType</a>  type;
1189     <span class="keyword">union</span> {
1190       <span class="keyword">const</span> <span class="keyword">char</span>*     atom;
1191       <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>        integer;
1192       <a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>       cardinal;
1193
1194     } u;
1195
1196   } <b>BDF_PropertyRec</b>;
1197 </code></pre></div>
1198
1199 <p>This structure models a given BDF/PCF property.</p>
1200 <h4>fields</h4>
1201
1202 <table class="fields">
1203 <tr><td class="val" id="type">type</td><td class="desc">
1204 <p>The property type.</p>
1205 </td></tr>
1206 <tr><td class="val" id="u.atom">u.atom</td><td class="desc">
1207 <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>
1208 </td></tr>
1209 <tr><td class="val" id="u.integer">u.integer</td><td class="desc">
1210 <p>A signed integer, if type is <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_INTEGER</a></code>.</p>
1211 </td></tr>
1212 <tr><td class="val" id="u.cardinal">u.cardinal</td><td class="desc">
1213 <p>An unsigned integer, if type is <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_CARDINAL</a></code>.</p>
1214 </td></tr>
1215 </table>
1216
1217 <hr>
1218
1219 <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>
1220 <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
1221 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1222   <b>FT_Get_BDF_Charset_ID</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>       face,
1223                          <span class="keyword">const</span> <span class="keyword">char</span>*  *acharset_encoding,
1224                          <span class="keyword">const</span> <span class="keyword">char</span>*  *acharset_registry );
1225 </code></pre></div>
1226
1227 <p>Retrieve a BDF font character set identity, according to the BDF specification.</p>
1228 <h4>input</h4>
1229
1230 <table class="fields">
1231 <tr><td class="val" id="face">face</td><td class="desc">
1232 <p>A handle to the input face.</p>
1233 </td></tr>
1234 </table>
1235
1236 <h4>output</h4>
1237
1238 <table class="fields">
1239 <tr><td class="val" id="acharset_encoding">acharset_encoding</td><td class="desc">
1240 <p>Charset encoding, as a C&nbsp;string, owned by the face.</p>
1241 </td></tr>
1242 <tr><td class="val" id="acharset_registry">acharset_registry</td><td class="desc">
1243 <p>Charset registry, as a C&nbsp;string, owned by the face.</p>
1244 </td></tr>
1245 </table>
1246
1247 <h4>return</h4>
1248
1249 <p>FreeType error code. 0&nbsp;means success.</p>
1250 <h4>note</h4>
1251
1252 <p>This function only works with BDF faces, returning an error otherwise.</p>
1253 <hr>
1254
1255 <h2 id="ft_get_bdf_property">FT_Get_BDF_Property<a class="headerlink" href="#ft_get_bdf_property" title="Permanent link">&para;</a></h2>
1256 <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
1257 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1258   <b>FT_Get_BDF_Property</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a>           face,
1259                        <span class="keyword">const</span> <span class="keyword">char</span>*       prop_name,
1260                        <a href="ft2-bdf_fonts.html#bdf_propertyrec">BDF_PropertyRec</a>  *aproperty );
1261 </code></pre></div>
1262
1263 <p>Retrieve a BDF property from a BDF or PCF font file.</p>
1264 <h4>input</h4>
1265
1266 <table class="fields">
1267 <tr><td class="val" id="face">face</td><td class="desc">
1268 <p>A handle to the input face.</p>
1269 </td></tr>
1270 <tr><td class="val" id="name">name</td><td class="desc">
1271 <p>The property name.</p>
1272 </td></tr>
1273 </table>
1274
1275 <h4>output</h4>
1276
1277 <table class="fields">
1278 <tr><td class="val" id="aproperty">aproperty</td><td class="desc">
1279 <p>The property.</p>
1280 </td></tr>
1281 </table>
1282
1283 <h4>return</h4>
1284
1285 <p>FreeType error code. 0&nbsp;means success.</p>
1286 <h4>note</h4>
1287
1288 <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>
1289 <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>
1290 <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>
1291 <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>
1292 <hr>
1293                 
1294                   
1295                 
1296                 
1297               
1298               
1299                 
1300
1301
1302               
1303             </article>
1304           </div>
1305         </div>
1306       </main>
1307       
1308         
1309 <footer class="md-footer">
1310   
1311     <div class="md-footer-nav">
1312       <nav class="md-footer-nav__inner md-grid">
1313         
1314           <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
1315             <div class="md-flex__cell md-flex__cell--shrink">
1316               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
1317             </div>
1318             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
1319               <span class="md-flex__ellipsis">
1320                 <span class="md-footer-nav__direction">
1321                   Previous
1322                 </span>
1323                 SFNT Names
1324               </span>
1325             </div>
1326           </a>
1327         
1328         
1329           <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
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                   Next
1334                 </span>
1335                 CID Fonts
1336               </span>
1337             </div>
1338             <div class="md-flex__cell md-flex__cell--shrink">
1339               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
1340             </div>
1341           </a>
1342         
1343       </nav>
1344     </div>
1345   
1346   <div class="md-footer-meta md-typeset">
1347     <div class="md-footer-meta__inner md-grid">
1348       <div class="md-footer-copyright">
1349         
1350           <div class="md-footer-copyright__highlight">
1351             Copyright 2020 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1352           </div>
1353         
1354         powered by
1355         <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
1356         and
1357         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1358           Material for MkDocs</a>
1359       </div>
1360       
1361     </div>
1362   </div>
1363 </footer>
1364       
1365     </div>
1366     
1367       <script src="assets/javascripts/application.c33a9706.js"></script>
1368       
1369       <script>app.initialize({version:"1.1",url:{base:"."}})</script>
1370       
1371         <script src="javascripts/extra.js"></script>
1372       
1373     
1374   </body>
1375 </html>