Imported Upstream version 2.13.2
[platform/upstream/freetype2.git] / docs / reference / ft2-properties.html
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.13.2">
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.4.3, mkdocs-material-7.1.9">
18     
19     
20       
21         <title>Driver properties - FreeType-2.13.2 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="#driver-properties" 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.13.2 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.13.2 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.13.2 API Reference
98           </span>
99         </div>
100         <div class="md-header__topic" data-md-component="header-topic">
101           <span class="md-ellipsis">
102             
103               Driver properties
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.13.2 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.13.2 API Reference" data-md-component="logo">
165       
166   <img src="images/favico.ico" alt="logo">
167
168     </a>
169     FreeType-2.13.2 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     <li class="md-nav__item md-nav__item--nested">
213       
214       
215         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
216       
217       <label class="md-nav__link" for="__nav_3">
218         General Remarks
219         <span class="md-nav__icon md-icon"></span>
220       </label>
221       <nav class="md-nav" aria-label="General Remarks" data-md-level="1">
222         <label class="md-nav__title" for="__nav_3">
223           <span class="md-nav__icon md-icon"></span>
224           General Remarks
225         </label>
226         <ul class="md-nav__list" data-md-scrollfix>
227           
228             
229   
230   
231   
232     <li class="md-nav__item">
233       <a href="ft2-preamble.html" class="md-nav__link">
234         Preamble
235       </a>
236     </li>
237   
238
239           
240             
241   
242   
243   
244     <li class="md-nav__item">
245       <a href="ft2-header_inclusion.html" class="md-nav__link">
246         FreeType's header inclusion scheme
247       </a>
248     </li>
249   
250
251           
252             
253   
254   
255   
256     <li class="md-nav__item">
257       <a href="ft2-user_allocation.html" class="md-nav__link">
258         User allocation
259       </a>
260     </li>
261   
262
263           
264         </ul>
265       </nav>
266     </li>
267   
268
269     
270       
271       
272       
273
274   
275   
276   
277     
278     <li class="md-nav__item md-nav__item--nested">
279       
280       
281         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
282       
283       <label class="md-nav__link" for="__nav_4">
284         Core API
285         <span class="md-nav__icon md-icon"></span>
286       </label>
287       <nav class="md-nav" aria-label="Core API" data-md-level="1">
288         <label class="md-nav__title" for="__nav_4">
289           <span class="md-nav__icon md-icon"></span>
290           Core API
291         </label>
292         <ul class="md-nav__list" data-md-scrollfix>
293           
294             
295   
296   
297   
298     <li class="md-nav__item">
299       <a href="ft2-basic_types.html" class="md-nav__link">
300         Basic Data Types
301       </a>
302     </li>
303   
304
305           
306             
307   
308   
309   
310     <li class="md-nav__item">
311       <a href="ft2-library_setup.html" class="md-nav__link">
312         Library Setup
313       </a>
314     </li>
315   
316
317           
318             
319   
320   
321   
322     <li class="md-nav__item">
323       <a href="ft2-face_creation.html" class="md-nav__link">
324         Face Creation
325       </a>
326     </li>
327   
328
329           
330             
331   
332   
333   
334     <li class="md-nav__item">
335       <a href="ft2-font_testing_macros.html" class="md-nav__link">
336         Font Testing Macros
337       </a>
338     </li>
339   
340
341           
342             
343   
344   
345   
346     <li class="md-nav__item">
347       <a href="ft2-sizing_and_scaling.html" class="md-nav__link">
348         Sizing and Scaling
349       </a>
350     </li>
351   
352
353           
354             
355   
356   
357   
358     <li class="md-nav__item">
359       <a href="ft2-glyph_retrieval.html" class="md-nav__link">
360         Glyph Retrieval
361       </a>
362     </li>
363   
364
365           
366             
367   
368   
369   
370     <li class="md-nav__item">
371       <a href="ft2-character_mapping.html" class="md-nav__link">
372         Character Mapping
373       </a>
374     </li>
375   
376
377           
378             
379   
380   
381   
382     <li class="md-nav__item">
383       <a href="ft2-information_retrieval.html" class="md-nav__link">
384         Information Retrieval
385       </a>
386     </li>
387   
388
389           
390             
391   
392   
393   
394     <li class="md-nav__item">
395       <a href="ft2-other_api_data.html" class="md-nav__link">
396         Other API Data
397       </a>
398     </li>
399   
400
401           
402         </ul>
403       </nav>
404     </li>
405   
406
407     
408       
409       
410       
411
412   
413   
414   
415     
416     <li class="md-nav__item md-nav__item--nested">
417       
418       
419         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
420       
421       <label class="md-nav__link" for="__nav_5">
422         Extended API
423         <span class="md-nav__icon md-icon"></span>
424       </label>
425       <nav class="md-nav" aria-label="Extended API" data-md-level="1">
426         <label class="md-nav__title" for="__nav_5">
427           <span class="md-nav__icon md-icon"></span>
428           Extended API
429         </label>
430         <ul class="md-nav__list" data-md-scrollfix>
431           
432             
433   
434   
435   
436     <li class="md-nav__item">
437       <a href="ft2-glyph_variants.html" class="md-nav__link">
438         Unicode Variation Sequences
439       </a>
440     </li>
441   
442
443           
444             
445   
446   
447   
448     <li class="md-nav__item">
449       <a href="ft2-color_management.html" class="md-nav__link">
450         Glyph Color Management
451       </a>
452     </li>
453   
454
455           
456             
457   
458   
459   
460     <li class="md-nav__item">
461       <a href="ft2-layer_management.html" class="md-nav__link">
462         Glyph Layer Management
463       </a>
464     </li>
465   
466
467           
468             
469   
470   
471   
472     <li class="md-nav__item">
473       <a href="ft2-glyph_management.html" class="md-nav__link">
474         Glyph Management
475       </a>
476     </li>
477   
478
479           
480             
481   
482   
483   
484     <li class="md-nav__item">
485       <a href="ft2-mac_specific.html" class="md-nav__link">
486         Mac Specific Interface
487       </a>
488     </li>
489   
490
491           
492             
493   
494   
495   
496     <li class="md-nav__item">
497       <a href="ft2-sizes_management.html" class="md-nav__link">
498         Size Management
499       </a>
500     </li>
501   
502
503           
504             
505   
506   
507   
508     <li class="md-nav__item">
509       <a href="ft2-header_file_macros.html" class="md-nav__link">
510         Header File Macros
511       </a>
512     </li>
513   
514
515           
516         </ul>
517       </nav>
518     </li>
519   
520
521     
522       
523       
524       
525
526   
527   
528   
529     
530     <li class="md-nav__item md-nav__item--nested">
531       
532       
533         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
534       
535       <label class="md-nav__link" for="__nav_6">
536         Format-Specific API
537         <span class="md-nav__icon md-icon"></span>
538       </label>
539       <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
540         <label class="md-nav__title" for="__nav_6">
541           <span class="md-nav__icon md-icon"></span>
542           Format-Specific API
543         </label>
544         <ul class="md-nav__list" data-md-scrollfix>
545           
546             
547   
548   
549   
550     <li class="md-nav__item">
551       <a href="ft2-multiple_masters.html" class="md-nav__link">
552         Multiple Masters
553       </a>
554     </li>
555   
556
557           
558             
559   
560   
561   
562     <li class="md-nav__item">
563       <a href="ft2-truetype_tables.html" class="md-nav__link">
564         TrueType Tables
565       </a>
566     </li>
567   
568
569           
570             
571   
572   
573   
574     <li class="md-nav__item">
575       <a href="ft2-type1_tables.html" class="md-nav__link">
576         Type 1 Tables
577       </a>
578     </li>
579   
580
581           
582             
583   
584   
585   
586     <li class="md-nav__item">
587       <a href="ft2-sfnt_names.html" class="md-nav__link">
588         SFNT Names
589       </a>
590     </li>
591   
592
593           
594             
595   
596   
597   
598     <li class="md-nav__item">
599       <a href="ft2-bdf_fonts.html" class="md-nav__link">
600         BDF and PCF Files
601       </a>
602     </li>
603   
604
605           
606             
607   
608   
609   
610     <li class="md-nav__item">
611       <a href="ft2-cid_fonts.html" class="md-nav__link">
612         CID Fonts
613       </a>
614     </li>
615   
616
617           
618             
619   
620   
621   
622     <li class="md-nav__item">
623       <a href="ft2-pfr_fonts.html" class="md-nav__link">
624         PFR Fonts
625       </a>
626     </li>
627   
628
629           
630             
631   
632   
633   
634     <li class="md-nav__item">
635       <a href="ft2-winfnt_fonts.html" class="md-nav__link">
636         Window FNT Files
637       </a>
638     </li>
639   
640
641           
642             
643   
644   
645   
646     <li class="md-nav__item">
647       <a href="ft2-svg_fonts.html" class="md-nav__link">
648         OpenType SVG Fonts
649       </a>
650     </li>
651   
652
653           
654             
655   
656   
657   
658     <li class="md-nav__item">
659       <a href="ft2-font_formats.html" class="md-nav__link">
660         Font Formats
661       </a>
662     </li>
663   
664
665           
666             
667   
668   
669   
670     <li class="md-nav__item">
671       <a href="ft2-gasp_table.html" class="md-nav__link">
672         Gasp Table
673       </a>
674     </li>
675   
676
677           
678         </ul>
679       </nav>
680     </li>
681   
682
683     
684       
685       
686       
687
688   
689   
690     
691   
692   
693     
694     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
695       
696       
697         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
698       
699       <label class="md-nav__link" for="__nav_7">
700         Controlling FreeType Modules
701         <span class="md-nav__icon md-icon"></span>
702       </label>
703       <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
704         <label class="md-nav__title" for="__nav_7">
705           <span class="md-nav__icon md-icon"></span>
706           Controlling FreeType Modules
707         </label>
708         <ul class="md-nav__list" data-md-scrollfix>
709           
710             
711   
712   
713   
714     <li class="md-nav__item">
715       <a href="ft2-auto_hinter.html" class="md-nav__link">
716         The auto-hinter
717       </a>
718     </li>
719   
720
721           
722             
723   
724   
725   
726     <li class="md-nav__item">
727       <a href="ft2-cff_driver.html" class="md-nav__link">
728         The CFF driver
729       </a>
730     </li>
731   
732
733           
734             
735   
736   
737   
738     <li class="md-nav__item">
739       <a href="ft2-t1_cid_driver.html" class="md-nav__link">
740         The Type 1 and CID drivers
741       </a>
742     </li>
743   
744
745           
746             
747   
748   
749   
750     <li class="md-nav__item">
751       <a href="ft2-tt_driver.html" class="md-nav__link">
752         The TrueType driver
753       </a>
754     </li>
755   
756
757           
758             
759   
760   
761   
762     <li class="md-nav__item">
763       <a href="ft2-pcf_driver.html" class="md-nav__link">
764         The PCF driver
765       </a>
766     </li>
767   
768
769           
770             
771   
772   
773   
774     <li class="md-nav__item">
775       <a href="ft2-ot_svg_driver.html" class="md-nav__link">
776         The SVG driver
777       </a>
778     </li>
779   
780
781           
782             
783   
784   
785     
786   
787   
788     <li class="md-nav__item md-nav__item--active">
789       
790       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
791       
792       
793         
794       
795       
796         <label class="md-nav__link md-nav__link--active" for="__toc">
797           Driver properties
798           <span class="md-nav__icon md-icon"></span>
799         </label>
800       
801       <a href="ft2-properties.html" class="md-nav__link md-nav__link--active">
802         Driver properties
803       </a>
804       
805         
806 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
807   
808   
809   
810     
811   
812   
813     <label class="md-nav__title" for="__toc">
814       <span class="md-nav__icon md-icon"></span>
815       Table of contents
816     </label>
817     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
818       
819         <li class="md-nav__item">
820   <a href="#synopsis" class="md-nav__link">
821     Synopsis
822   </a>
823   
824 </li>
825       
826         <li class="md-nav__item">
827   <a href="#ft_hinting_xxx" class="md-nav__link">
828     FT_HINTING_XXX
829   </a>
830   
831 </li>
832       
833         <li class="md-nav__item">
834   <a href="#hinting-engine" class="md-nav__link">
835     hinting-engine
836   </a>
837   
838 </li>
839       
840         <li class="md-nav__item">
841   <a href="#no-stem-darkening" class="md-nav__link">
842     no-stem-darkening
843   </a>
844   
845 </li>
846       
847         <li class="md-nav__item">
848   <a href="#darkening-parameters" class="md-nav__link">
849     darkening-parameters
850   </a>
851   
852 </li>
853       
854         <li class="md-nav__item">
855   <a href="#random-seed" class="md-nav__link">
856     random-seed
857   </a>
858   
859 </li>
860       
861         <li class="md-nav__item">
862   <a href="#no-long-family-names" class="md-nav__link">
863     no-long-family-names
864   </a>
865   
866 </li>
867       
868         <li class="md-nav__item">
869   <a href="#tt_interpreter_version_xxx" class="md-nav__link">
870     TT_INTERPRETER_VERSION_XXX
871   </a>
872   
873 </li>
874       
875         <li class="md-nav__item">
876   <a href="#interpreter-version" class="md-nav__link">
877     interpreter-version
878   </a>
879   
880 </li>
881       
882         <li class="md-nav__item">
883   <a href="#svg-hooks" class="md-nav__link">
884     svg-hooks
885   </a>
886   
887 </li>
888       
889         <li class="md-nav__item">
890   <a href="#glyph-to-script-map" class="md-nav__link">
891     glyph-to-script-map
892   </a>
893   
894 </li>
895       
896         <li class="md-nav__item">
897   <a href="#ft_autohinter_script_xxx" class="md-nav__link">
898     FT_AUTOHINTER_SCRIPT_XXX
899   </a>
900   
901 </li>
902       
903         <li class="md-nav__item">
904   <a href="#ft_prop_glyphtoscriptmap" class="md-nav__link">
905     FT_Prop_GlyphToScriptMap
906   </a>
907   
908 </li>
909       
910         <li class="md-nav__item">
911   <a href="#fallback-script" class="md-nav__link">
912     fallback-script
913   </a>
914   
915 </li>
916       
917         <li class="md-nav__item">
918   <a href="#default-script" class="md-nav__link">
919     default-script
920   </a>
921   
922 </li>
923       
924         <li class="md-nav__item">
925   <a href="#increase-x-height" class="md-nav__link">
926     increase-x-height
927   </a>
928   
929 </li>
930       
931         <li class="md-nav__item">
932   <a href="#ft_prop_increasexheight" class="md-nav__link">
933     FT_Prop_IncreaseXHeight
934   </a>
935   
936 </li>
937       
938         <li class="md-nav__item">
939   <a href="#warping" class="md-nav__link">
940     warping
941   </a>
942   
943 </li>
944       
945     </ul>
946   
947 </nav>
948       
949     </li>
950   
951
952           
953             
954   
955   
956   
957     <li class="md-nav__item">
958       <a href="ft2-parameter_tags.html" class="md-nav__link">
959         Parameter Tags
960       </a>
961     </li>
962   
963
964           
965             
966   
967   
968   
969     <li class="md-nav__item">
970       <a href="ft2-lcd_rendering.html" class="md-nav__link">
971         Subpixel Rendering
972       </a>
973     </li>
974   
975
976           
977         </ul>
978       </nav>
979     </li>
980   
981
982     
983       
984       
985       
986
987   
988   
989   
990     
991     <li class="md-nav__item md-nav__item--nested">
992       
993       
994         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
995       
996       <label class="md-nav__link" for="__nav_8">
997         Cache Sub-System
998         <span class="md-nav__icon md-icon"></span>
999       </label>
1000       <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
1001         <label class="md-nav__title" for="__nav_8">
1002           <span class="md-nav__icon md-icon"></span>
1003           Cache Sub-System
1004         </label>
1005         <ul class="md-nav__list" data-md-scrollfix>
1006           
1007             
1008   
1009   
1010   
1011     <li class="md-nav__item">
1012       <a href="ft2-cache_subsystem.html" class="md-nav__link">
1013         Cache Sub-System
1014       </a>
1015     </li>
1016   
1017
1018           
1019         </ul>
1020       </nav>
1021     </li>
1022   
1023
1024     
1025       
1026       
1027       
1028
1029   
1030   
1031   
1032     
1033     <li class="md-nav__item md-nav__item--nested">
1034       
1035       
1036         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
1037       
1038       <label class="md-nav__link" for="__nav_9">
1039         Support API
1040         <span class="md-nav__icon md-icon"></span>
1041       </label>
1042       <nav class="md-nav" aria-label="Support API" data-md-level="1">
1043         <label class="md-nav__title" for="__nav_9">
1044           <span class="md-nav__icon md-icon"></span>
1045           Support API
1046         </label>
1047         <ul class="md-nav__list" data-md-scrollfix>
1048           
1049             
1050   
1051   
1052   
1053     <li class="md-nav__item">
1054       <a href="ft2-computations.html" class="md-nav__link">
1055         Computations
1056       </a>
1057     </li>
1058   
1059
1060           
1061             
1062   
1063   
1064   
1065     <li class="md-nav__item">
1066       <a href="ft2-list_processing.html" class="md-nav__link">
1067         List Processing
1068       </a>
1069     </li>
1070   
1071
1072           
1073             
1074   
1075   
1076   
1077     <li class="md-nav__item">
1078       <a href="ft2-outline_processing.html" class="md-nav__link">
1079         Outline Processing
1080       </a>
1081     </li>
1082   
1083
1084           
1085             
1086   
1087   
1088   
1089     <li class="md-nav__item">
1090       <a href="ft2-quick_advance.html" class="md-nav__link">
1091         Quick retrieval of advance values
1092       </a>
1093     </li>
1094   
1095
1096           
1097             
1098   
1099   
1100   
1101     <li class="md-nav__item">
1102       <a href="ft2-bitmap_handling.html" class="md-nav__link">
1103         Bitmap Handling
1104       </a>
1105     </li>
1106   
1107
1108           
1109             
1110   
1111   
1112   
1113     <li class="md-nav__item">
1114       <a href="ft2-raster.html" class="md-nav__link">
1115         Scanline Converter
1116       </a>
1117     </li>
1118   
1119
1120           
1121             
1122   
1123   
1124   
1125     <li class="md-nav__item">
1126       <a href="ft2-glyph_stroker.html" class="md-nav__link">
1127         Glyph Stroker
1128       </a>
1129     </li>
1130   
1131
1132           
1133             
1134   
1135   
1136   
1137     <li class="md-nav__item">
1138       <a href="ft2-system_interface.html" class="md-nav__link">
1139         System Interface
1140       </a>
1141     </li>
1142   
1143
1144           
1145             
1146   
1147   
1148   
1149     <li class="md-nav__item">
1150       <a href="ft2-module_management.html" class="md-nav__link">
1151         Module Management
1152       </a>
1153     </li>
1154   
1155
1156           
1157             
1158   
1159   
1160   
1161     <li class="md-nav__item">
1162       <a href="ft2-gzip.html" class="md-nav__link">
1163         GZIP Streams
1164       </a>
1165     </li>
1166   
1167
1168           
1169             
1170   
1171   
1172   
1173     <li class="md-nav__item">
1174       <a href="ft2-lzw.html" class="md-nav__link">
1175         LZW Streams
1176       </a>
1177     </li>
1178   
1179
1180           
1181             
1182   
1183   
1184   
1185     <li class="md-nav__item">
1186       <a href="ft2-bzip2.html" class="md-nav__link">
1187         BZIP2 Streams
1188       </a>
1189     </li>
1190   
1191
1192           
1193             
1194   
1195   
1196   
1197     <li class="md-nav__item">
1198       <a href="ft2-debugging_apis.html" class="md-nav__link">
1199         External Debugging APIs
1200       </a>
1201     </li>
1202   
1203
1204           
1205         </ul>
1206       </nav>
1207     </li>
1208   
1209
1210     
1211       
1212       
1213       
1214
1215   
1216   
1217   
1218     
1219     <li class="md-nav__item md-nav__item--nested">
1220       
1221       
1222         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
1223       
1224       <label class="md-nav__link" for="__nav_10">
1225         Error Codes
1226         <span class="md-nav__icon md-icon"></span>
1227       </label>
1228       <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1229         <label class="md-nav__title" for="__nav_10">
1230           <span class="md-nav__icon md-icon"></span>
1231           Error Codes
1232         </label>
1233         <ul class="md-nav__list" data-md-scrollfix>
1234           
1235             
1236   
1237   
1238   
1239     <li class="md-nav__item">
1240       <a href="ft2-error_enumerations.html" class="md-nav__link">
1241         Error Enumerations
1242       </a>
1243     </li>
1244   
1245
1246           
1247             
1248   
1249   
1250   
1251     <li class="md-nav__item">
1252       <a href="ft2-error_code_values.html" class="md-nav__link">
1253         Error Code Values
1254       </a>
1255     </li>
1256   
1257
1258           
1259         </ul>
1260       </nav>
1261     </li>
1262   
1263
1264     
1265       
1266       
1267       
1268
1269   
1270   
1271   
1272     
1273     <li class="md-nav__item md-nav__item--nested">
1274       
1275       
1276         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" >
1277       
1278       <label class="md-nav__link" for="__nav_11">
1279         Miscellaneous
1280         <span class="md-nav__icon md-icon"></span>
1281       </label>
1282       <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1283         <label class="md-nav__title" for="__nav_11">
1284           <span class="md-nav__icon md-icon"></span>
1285           Miscellaneous
1286         </label>
1287         <ul class="md-nav__list" data-md-scrollfix>
1288           
1289             
1290   
1291   
1292   
1293     <li class="md-nav__item">
1294       <a href="ft2-gx_validation.html" class="md-nav__link">
1295         TrueTypeGX/AAT Validation
1296       </a>
1297     </li>
1298   
1299
1300           
1301             
1302   
1303   
1304   
1305     <li class="md-nav__item">
1306       <a href="ft2-incremental.html" class="md-nav__link">
1307         Incremental Loading
1308       </a>
1309     </li>
1310   
1311
1312           
1313             
1314   
1315   
1316   
1317     <li class="md-nav__item">
1318       <a href="ft2-truetype_engine.html" class="md-nav__link">
1319         The TrueType Engine
1320       </a>
1321     </li>
1322   
1323
1324           
1325             
1326   
1327   
1328   
1329     <li class="md-nav__item">
1330       <a href="ft2-ot_validation.html" class="md-nav__link">
1331         OpenType Validation
1332       </a>
1333     </li>
1334   
1335
1336           
1337         </ul>
1338       </nav>
1339     </li>
1340   
1341
1342     
1343   </ul>
1344 </nav>
1345                   </div>
1346                 </div>
1347               </div>
1348             
1349             
1350               
1351               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1352                 <div class="md-sidebar__scrollwrap">
1353                   <div class="md-sidebar__inner">
1354                     
1355 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1356   
1357   
1358   
1359     
1360   
1361   
1362     <label class="md-nav__title" for="__toc">
1363       <span class="md-nav__icon md-icon"></span>
1364       Table of contents
1365     </label>
1366     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1367       
1368         <li class="md-nav__item">
1369   <a href="#synopsis" class="md-nav__link">
1370     Synopsis
1371   </a>
1372   
1373 </li>
1374       
1375         <li class="md-nav__item">
1376   <a href="#ft_hinting_xxx" class="md-nav__link">
1377     FT_HINTING_XXX
1378   </a>
1379   
1380 </li>
1381       
1382         <li class="md-nav__item">
1383   <a href="#hinting-engine" class="md-nav__link">
1384     hinting-engine
1385   </a>
1386   
1387 </li>
1388       
1389         <li class="md-nav__item">
1390   <a href="#no-stem-darkening" class="md-nav__link">
1391     no-stem-darkening
1392   </a>
1393   
1394 </li>
1395       
1396         <li class="md-nav__item">
1397   <a href="#darkening-parameters" class="md-nav__link">
1398     darkening-parameters
1399   </a>
1400   
1401 </li>
1402       
1403         <li class="md-nav__item">
1404   <a href="#random-seed" class="md-nav__link">
1405     random-seed
1406   </a>
1407   
1408 </li>
1409       
1410         <li class="md-nav__item">
1411   <a href="#no-long-family-names" class="md-nav__link">
1412     no-long-family-names
1413   </a>
1414   
1415 </li>
1416       
1417         <li class="md-nav__item">
1418   <a href="#tt_interpreter_version_xxx" class="md-nav__link">
1419     TT_INTERPRETER_VERSION_XXX
1420   </a>
1421   
1422 </li>
1423       
1424         <li class="md-nav__item">
1425   <a href="#interpreter-version" class="md-nav__link">
1426     interpreter-version
1427   </a>
1428   
1429 </li>
1430       
1431         <li class="md-nav__item">
1432   <a href="#svg-hooks" class="md-nav__link">
1433     svg-hooks
1434   </a>
1435   
1436 </li>
1437       
1438         <li class="md-nav__item">
1439   <a href="#glyph-to-script-map" class="md-nav__link">
1440     glyph-to-script-map
1441   </a>
1442   
1443 </li>
1444       
1445         <li class="md-nav__item">
1446   <a href="#ft_autohinter_script_xxx" class="md-nav__link">
1447     FT_AUTOHINTER_SCRIPT_XXX
1448   </a>
1449   
1450 </li>
1451       
1452         <li class="md-nav__item">
1453   <a href="#ft_prop_glyphtoscriptmap" class="md-nav__link">
1454     FT_Prop_GlyphToScriptMap
1455   </a>
1456   
1457 </li>
1458       
1459         <li class="md-nav__item">
1460   <a href="#fallback-script" class="md-nav__link">
1461     fallback-script
1462   </a>
1463   
1464 </li>
1465       
1466         <li class="md-nav__item">
1467   <a href="#default-script" class="md-nav__link">
1468     default-script
1469   </a>
1470   
1471 </li>
1472       
1473         <li class="md-nav__item">
1474   <a href="#increase-x-height" class="md-nav__link">
1475     increase-x-height
1476   </a>
1477   
1478 </li>
1479       
1480         <li class="md-nav__item">
1481   <a href="#ft_prop_increasexheight" class="md-nav__link">
1482     FT_Prop_IncreaseXHeight
1483   </a>
1484   
1485 </li>
1486       
1487         <li class="md-nav__item">
1488   <a href="#warping" class="md-nav__link">
1489     warping
1490   </a>
1491   
1492 </li>
1493       
1494     </ul>
1495   
1496 </nav>
1497                   </div>
1498                 </div>
1499               </div>
1500             
1501           
1502           <div class="md-content" data-md-component="content">
1503             <article class="md-content__inner md-typeset">
1504               
1505                 
1506                 
1507                 <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#controlling-freetype-modules">Controlling FreeType Modules</a> &raquo; Driver properties</p>
1508 <hr />
1509 <h1 id="driver-properties">Driver properties<a class="headerlink" href="#driver-properties" title="Permanent link">&para;</a></h1>
1510 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1511 <p>Driver modules can be controlled by setting and unsetting properties, using the functions <code><a href="ft2-module_management.html#ft_property_set">FT_Property_Set</a></code> and <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code>. This section documents the available properties, together with auxiliary macros and structures.</p>
1512 <h2 id="ft_hinting_xxx">FT_HINTING_XXX<a class="headerlink" href="#ft_hinting_xxx" title="Permanent link">&para;</a></h2>
1513 <p>Defined in FT_DRIVER_H (freetype/ftdriver.h).</p>
1514 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-properties.html#ft_hinting_freetype">FT_HINTING_FREETYPE</a>  0
1515 #<span class="keyword">define</span> <a href="ft2-properties.html#ft_hinting_adobe">FT_HINTING_ADOBE</a>     1
1516
1517   /* these constants (introduced in 2.4.12) are deprecated */
1518 #<span class="keyword">define</span> FT_CFF_HINTING_FREETYPE  <a href="ft2-properties.html#ft_hinting_freetype">FT_HINTING_FREETYPE</a>
1519 #<span class="keyword">define</span> FT_CFF_HINTING_ADOBE     <a href="ft2-properties.html#ft_hinting_adobe">FT_HINTING_ADOBE</a>
1520 </code></pre></div>
1521
1522 <p>A list of constants used for the <code><a href="ft2-properties.html#hinting-engine">hinting-engine</a></code> property to select the hinting engine for CFF, Type&nbsp;1, and CID fonts.</p>
1523 <h4>values</h4>
1524 <table class="fields">
1525 <tr><td class="val" id="ft_hinting_freetype">FT_HINTING_FREETYPE</td><td class="desc">
1526 <p>Use the old FreeType hinting engine.</p>
1527 </td></tr>
1528 <tr><td class="val" id="ft_hinting_adobe">FT_HINTING_ADOBE</td><td class="desc">
1529 <p>Use the hinting engine contributed by Adobe.</p>
1530 </td></tr>
1531 </table>
1532
1533 <h4>since</h4>
1534
1535 <p>2.9</p>
1536 <hr>
1537
1538 <h2 id="hinting-engine">hinting-engine<a class="headerlink" href="#hinting-engine" title="Permanent link">&para;</a></h2>
1539 <p>Thanks to Adobe, which contributed a new hinting (and parsing) engine, an application can select between &lsquo;freetype&rsquo; and &lsquo;adobe&rsquo; if compiled with <code>CFF_CONFIG_OPTION_OLD_ENGINE</code>. If this configuration macro isn't defined, &lsquo;hinting-engine&rsquo; does nothing.</p>
1540 <p>The same holds for the Type&nbsp;1 and CID modules if compiled with <code>T1_CONFIG_OPTION_OLD_ENGINE</code>.</p>
1541 <p>For the &lsquo;cff&rsquo; module, the default engine is &lsquo;adobe&rsquo;. For both the &lsquo;type1&rsquo; and &lsquo;t1cid&rsquo; modules, the default engine is &lsquo;adobe&rsquo;, too.</p>
1542 <h4>note</h4>
1543
1544 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1545 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable (using values &lsquo;adobe&rsquo; or &lsquo;freetype&rsquo;).</p>
1546 <h4>example</h4>
1547
1548 <p>The following example code demonstrates how to select Adobe's hinting engine for the &lsquo;cff&rsquo; module (omitting the error handling).
1549 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1550   FT_UInt     hinting_engine = FT_HINTING_ADOBE;
1551
1552
1553   FT_Init_FreeType( &amp;library );
1554
1555   FT_Property_Set( library, &quot;cff&quot;,
1556                             &quot;hinting-engine&quot;, &amp;hinting_engine );
1557 </code></pre></div></p>
1558 <h4>since</h4>
1559
1560 <p>2.4.12 (for &lsquo;cff&rsquo; module)</p>
1561 <p>2.9 (for &lsquo;type1&rsquo; and &lsquo;t1cid&rsquo; modules)</p>
1562 <hr>
1563
1564 <h2 id="no-stem-darkening">no-stem-darkening<a class="headerlink" href="#no-stem-darkening" title="Permanent link">&para;</a></h2>
1565 <p>All glyphs that pass through the auto-hinter will be emboldened unless this property is set to TRUE. The same is true for the CFF, Type&nbsp;1, and CID font modules if the &lsquo;Adobe&rsquo; engine is selected (which is the default).</p>
1566 <p>Stem darkening emboldens glyphs at smaller sizes to make them more readable on common low-DPI screens when using linear alpha blending and gamma correction, see <code><a href="ft2-glyph_retrieval.html#ft_render_glyph">FT_Render_Glyph</a></code>. When not using linear alpha blending and gamma correction, glyphs will appear heavy and fuzzy!</p>
1567 <p>Gamma correction essentially lightens fonts since shades of grey are shifted to higher pixel values (=&nbsp;higher brightness) to match the original intention to the reality of our screens. The side-effect is that glyphs &lsquo;thin out&rsquo;. Mac OS&nbsp;X and Adobe's proprietary font rendering library implement a counter-measure: stem darkening at smaller sizes where shades of gray dominate. By emboldening a glyph slightly in relation to its pixel size, individual pixels get higher coverage of filled-in outlines and are therefore &lsquo;blacker&rsquo;. This counteracts the &lsquo;thinning out&rsquo; of glyphs, making text remain readable at smaller sizes.</p>
1568 <p>For the auto-hinter, stem-darkening is experimental currently and thus switched off by default (that is, <code>no-stem-darkening</code> is set to TRUE by default). Total consistency with the CFF driver is not achieved right now because the emboldening method differs and glyphs must be scaled down on the Y-axis to keep outline points inside their precomputed blue zones. The smaller the size (especially 9ppem and down), the higher the loss of emboldening versus the CFF driver.</p>
1569 <p>Note that stem darkening is never applied if <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> is set.</p>
1570 <h4>note</h4>
1571
1572 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1573 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable (using values 1 and 0 for &lsquo;on&rsquo; and &lsquo;off&rsquo;, respectively). It can also be set per face using <code><a href="ft2-face_creation.html#ft_face_properties">FT_Face_Properties</a></code> with <code><a href="ft2-parameter_tags.html#ft_param_tag_stem_darkening">FT_PARAM_TAG_STEM_DARKENING</a></code>.</p>
1574 <h4>example</h4>
1575 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1576   FT_Bool     no_stem_darkening = TRUE;
1577
1578
1579   FT_Init_FreeType( &amp;library );
1580
1581   FT_Property_Set( library, &quot;cff&quot;,
1582                             &quot;no-stem-darkening&quot;, &amp;no_stem_darkening );
1583 </code></pre></div>
1584 <h4>since</h4>
1585
1586 <p>2.4.12 (for &lsquo;cff&rsquo; module)</p>
1587 <p>2.6.2 (for &lsquo;autofitter&rsquo; module)</p>
1588 <p>2.9 (for &lsquo;type1&rsquo; and &lsquo;t1cid&rsquo; modules)</p>
1589 <hr>
1590
1591 <h2 id="darkening-parameters">darkening-parameters<a class="headerlink" href="#darkening-parameters" title="Permanent link">&para;</a></h2>
1592 <p>By default, the Adobe hinting engine, as used by the CFF, Type&nbsp;1, and CID font drivers, darkens stems as follows (if the <code>no-stem-darkening</code> property isn't set):
1593 <div class="highlight"><pre><span></span><code>  stem width &lt;= 0.5px:   darkening amount = 0.4px
1594   stem width  = 1px:     darkening amount = 0.275px
1595   stem width  = 1.667px: darkening amount = 0.275px
1596   stem width &gt;= 2.333px: darkening amount = 0px
1597 </code></pre></div></p>
1598 <p>and piecewise linear in-between. At configuration time, these four control points can be set with the macro <code>CFF_CONFIG_OPTION_DARKENING_PARAMETERS</code>; the CFF, Type&nbsp;1, and CID drivers share these values. At runtime, the control points can be changed using the <code>darkening-parameters</code> property (see the example below that demonstrates this for the Type&nbsp;1 driver).</p>
1599 <p>The x&nbsp;values give the stem width, and the y&nbsp;values the darkening amount. The unit is 1000<sup>th</sup> of pixels. All coordinate values must be positive; the x&nbsp;values must be monotonically increasing; the y&nbsp;values must be monotonically decreasing and smaller than or equal to 500 (corresponding to half a pixel); the slope of each linear piece must be shallower than -1 (e.g., -.4).</p>
1600 <p>The auto-hinter provides this property, too, as an experimental feature. See <code><a href="ft2-properties.html#no-stem-darkening">no-stem-darkening</a></code> for more.</p>
1601 <h4>note</h4>
1602
1603 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1604 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable, using eight comma-separated integers without spaces. Here the above example, using <code>\</code> to break the line for readability.
1605 <div class="highlight"><pre><span></span><code>  FREETYPE_PROPERTIES=\
1606   type1:darkening-parameters=500,300,1000,200,1500,100,2000,0
1607 </code></pre></div></p>
1608 <h4>example</h4>
1609 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1610   FT_Int      darken_params[8] = {  500, 300,   // x1, y1
1611                                    1000, 200,   // x2, y2
1612                                    1500, 100,   // x3, y3
1613                                    2000,   0 }; // x4, y4
1614
1615
1616   FT_Init_FreeType( &amp;library );
1617
1618   FT_Property_Set( library, &quot;type1&quot;,
1619                             &quot;darkening-parameters&quot;, darken_params );
1620 </code></pre></div>
1621 <h4>since</h4>
1622
1623 <p>2.5.1 (for &lsquo;cff&rsquo; module)</p>
1624 <p>2.6.2 (for &lsquo;autofitter&rsquo; module)</p>
1625 <p>2.9 (for &lsquo;type1&rsquo; and &lsquo;t1cid&rsquo; modules)</p>
1626 <hr>
1627
1628 <h2 id="random-seed">random-seed<a class="headerlink" href="#random-seed" title="Permanent link">&para;</a></h2>
1629 <p>By default, the seed value for the CFF &lsquo;random&rsquo; operator and the similar &lsquo;0 28 callothersubr pop&rsquo; command for the Type&nbsp;1 and CID drivers is set to a random value. However, mainly for debugging purposes, it is often necessary to use a known value as a seed so that the pseudo-random number sequences generated by &lsquo;random&rsquo; are repeatable.</p>
1630 <p>The <code>random-seed</code> property does that. Its argument is a signed 32bit integer; if the value is zero or negative, the seed given by the <code>intitialRandomSeed</code> private DICT operator in a CFF file gets used (or a default value if there is no such operator). If the value is positive, use it instead of <code>initialRandomSeed</code>, which is consequently ignored.</p>
1631 <h4>note</h4>
1632
1633 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable. It can also be set per face using <code><a href="ft2-face_creation.html#ft_face_properties">FT_Face_Properties</a></code> with <code><a href="ft2-parameter_tags.html#ft_param_tag_random_seed">FT_PARAM_TAG_RANDOM_SEED</a></code>.</p>
1634 <h4>since</h4>
1635
1636 <p>2.8 (for &lsquo;cff&rsquo; module)</p>
1637 <p>2.9 (for &lsquo;type1&rsquo; and &lsquo;t1cid&rsquo; modules)</p>
1638 <hr>
1639
1640 <h2 id="no-long-family-names">no-long-family-names<a class="headerlink" href="#no-long-family-names" title="Permanent link">&para;</a></h2>
1641 <p>If <code>PCF_CONFIG_OPTION_LONG_FAMILY_NAMES</code> is active while compiling FreeType, the PCF driver constructs long family names.</p>
1642 <p>There are many PCF fonts just called &lsquo;Fixed&rsquo; which look completely different, and which have nothing to do with each other. When selecting &lsquo;Fixed&rsquo; in KDE or Gnome one gets results that appear rather random, the style changes often if one changes the size and one cannot select some fonts at all. The improve this situation, the PCF module prepends the foundry name (plus a space) to the family name. It also checks whether there are &lsquo;wide&rsquo; characters; all put together, family names like &lsquo;Sony Fixed&rsquo; or &lsquo;Misc Fixed Wide&rsquo; are constructed.</p>
1643 <p>If <code>no-long-family-names</code> is set, this feature gets switched off.</p>
1644 <h4>note</h4>
1645
1646 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1647 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable (using values 1 and 0 for &lsquo;on&rsquo; and &lsquo;off&rsquo;, respectively).</p>
1648 <h4>example</h4>
1649 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1650   FT_Bool     no_long_family_names = TRUE;
1651
1652
1653   FT_Init_FreeType( &amp;library );
1654
1655   FT_Property_Set( library, &quot;pcf&quot;,
1656                             &quot;no-long-family-names&quot;,
1657                             &amp;no_long_family_names );
1658 </code></pre></div>
1659 <h4>since</h4>
1660
1661 <p>2.8</p>
1662 <hr>
1663
1664 <h2 id="tt_interpreter_version_xxx">TT_INTERPRETER_VERSION_XXX<a class="headerlink" href="#tt_interpreter_version_xxx" title="Permanent link">&para;</a></h2>
1665 <p>Defined in FT_DRIVER_H (freetype/ftdriver.h).</p>
1666 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-properties.html#tt_interpreter_version_35">TT_INTERPRETER_VERSION_35</a>  35
1667 #<span class="keyword">define</span> <a href="ft2-properties.html#tt_interpreter_version_38">TT_INTERPRETER_VERSION_38</a>  38
1668 #<span class="keyword">define</span> <a href="ft2-properties.html#tt_interpreter_version_40">TT_INTERPRETER_VERSION_40</a>  40
1669 </code></pre></div>
1670
1671 <p>A list of constants used for the <code><a href="ft2-properties.html#interpreter-version">interpreter-version</a></code> property to select the hinting engine for Truetype fonts.</p>
1672 <p>The numeric value in the constant names represents the version number as returned by the &lsquo;GETINFO&rsquo; bytecode instruction.</p>
1673 <h4>values</h4>
1674 <table class="fields">
1675 <tr><td class="val" id="tt_interpreter_version_35">TT_INTERPRETER_VERSION_35</td><td class="desc">
1676 <p>Version&nbsp;35 corresponds to MS rasterizer v.1.7 as used e.g. in Windows&nbsp;98; only grayscale and B/W rasterizing is supported.</p>
1677 </td></tr>
1678 <tr><td class="val" id="tt_interpreter_version_38">TT_INTERPRETER_VERSION_38</td><td class="desc">
1679 <p>Version&nbsp;38 is the same Version&nbsp;40. The original &lsquo;Infinality&rsquo; code is no longer available.</p>
1680 </td></tr>
1681 <tr><td class="val" id="tt_interpreter_version_40">TT_INTERPRETER_VERSION_40</td><td class="desc">
1682 <p>Version&nbsp;40 corresponds to MS rasterizer v.2.1; it is roughly equivalent to the hinting provided by DirectWrite ClearType (as can be found, for example, in Microsoft's Edge Browser on Windows&nbsp;10). It is used in FreeType to select the &lsquo;minimal&rsquo; subpixel hinting code, a stripped-down and higher performance version of the &lsquo;Infinality&rsquo; code.</p>
1683 </td></tr>
1684 </table>
1685
1686 <h4>note</h4>
1687
1688 <p>This property controls the behaviour of the bytecode interpreter and thus how outlines get hinted. It does <strong>not</strong> control how glyph get rasterized! In particular, it does not control subpixel color filtering.</p>
1689 <p>If FreeType has not been compiled with the configuration option <code>TT_CONFIG_OPTION_SUBPIXEL_HINTING</code>, selecting version&nbsp;38 or&nbsp;40 causes an <code>FT_Err_Unimplemented_Feature</code> error.</p>
1690 <p>Depending on the graphics framework, Microsoft uses different bytecode and rendering engines. As a consequence, the version numbers returned by a call to the &lsquo;GETINFO&rsquo; bytecode instruction are more convoluted than desired.</p>
1691 <p>Here are two tables that try to shed some light on the possible values for the MS rasterizer engine, together with the additional features introduced by it.
1692 <div class="highlight"><pre><span></span><code>  GETINFO framework               version feature
1693   -------------------------------------------------------------------
1694       3   GDI (Win 3.1),            v1.0  16-bit, first version
1695           TrueImage
1696      33   GDI (Win NT 3.1),         v1.5  32-bit
1697           HP Laserjet
1698      34   GDI (Win 95)              v1.6  font smoothing,
1699                                           new SCANTYPE opcode
1700      35   GDI (Win 98/2000)         v1.7  (UN)SCALED_COMPONENT_OFFSET
1701                                             bits in composite glyphs
1702      36   MGDI (Win CE 2)           v1.6+ classic ClearType
1703      37   GDI (XP and later),       v1.8  ClearType
1704           GDI+ old (before Vista)
1705      38   GDI+ old (Vista, Win 7),  v1.9  subpixel ClearType,
1706           WPF                             Y-direction ClearType,
1707                                           additional error checking
1708      39   DWrite (before Win 8)     v2.0  subpixel ClearType flags
1709                                             in GETINFO opcode,
1710                                           bug fixes
1711      40   GDI+ (after Win 7),       v2.1  Y-direction ClearType flag
1712           DWrite (Win 8)                    in GETINFO opcode,
1713                                           Gray ClearType
1714 </code></pre></div></p>
1715 <p>The &lsquo;version&rsquo; field gives a rough orientation only, since some applications provided certain features much earlier (as an example, Microsoft Reader used subpixel and Y-direction ClearType already in Windows 2000). Similarly, updates to a given framework might include improved hinting support.
1716 <div class="highlight"><pre><span></span><code>   version   sampling          rendering        comment
1717             x        y       x           y
1718   --------------------------------------------------------------
1719     v1.0   normal  normal  B/W           B/W    bi-level
1720     v1.6   high    high    gray          gray   grayscale
1721     v1.8   high    normal  color-filter  B/W    (GDI) ClearType
1722     v1.9   high    high    color-filter  gray   Color ClearType
1723     v2.1   high    normal  gray          B/W    Gray ClearType
1724     v2.1   high    high    gray          gray   Gray ClearType
1725 </code></pre></div></p>
1726 <p>Color and Gray ClearType are the two available variants of &lsquo;Y-direction ClearType&rsquo;, meaning grayscale rasterization along the Y-direction; the name used in the TrueType specification for this feature is &lsquo;symmetric smoothing&rsquo;. &lsquo;Classic ClearType&rsquo; is the original algorithm used before introducing a modified version in Win&nbsp;XP. Another name for v1.6's grayscale rendering is &lsquo;font smoothing&rsquo;, and &lsquo;Color ClearType&rsquo; is sometimes also called &lsquo;DWrite ClearType&rsquo;. To differentiate between today's Color ClearType and the earlier ClearType variant with B/W rendering along the vertical axis, the latter is sometimes called &lsquo;GDI ClearType&rsquo;.</p>
1727 <p>&lsquo;Normal&rsquo; and &lsquo;high&rsquo; sampling describe the (virtual) resolution to access the rasterized outline after the hinting process. &lsquo;Normal&rsquo; means 1 sample per grid line (i.e., B/W). In the current Microsoft implementation, &lsquo;high&rsquo; means an extra virtual resolution of 16x16 (or 16x1) grid lines per pixel for bytecode instructions like &lsquo;MIRP&rsquo;. After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid lines for color filtering if Color ClearType is activated.</p>
1728 <p>Note that &lsquo;Gray ClearType&rsquo; is essentially the same as v1.6's grayscale rendering. However, the GETINFO instruction handles it differently: v1.6 returns bit&nbsp;12 (hinting for grayscale), while v2.1 returns bits&nbsp;13 (hinting for ClearType), 18 (symmetrical smoothing), and&nbsp;19 (Gray ClearType). Also, this mode respects bits 2 and&nbsp;3 for the version&nbsp;1 gasp table exclusively (like Color ClearType), while v1.6 only respects the values of version&nbsp;0 (bits 0 and&nbsp;1).</p>
1729 <p>Keep in mind that the features of the above interpreter versions might not map exactly to FreeType features or behavior because it is a fundamentally different library with different internals.</p>
1730 <hr>
1731
1732 <h2 id="interpreter-version">interpreter-version<a class="headerlink" href="#interpreter-version" title="Permanent link">&para;</a></h2>
1733 <p>Currently, three versions are available, two representing the bytecode interpreter with subpixel hinting support (old &lsquo;Infinality&rsquo; code and new stripped-down and higher performance &lsquo;minimal&rsquo; code) and one without, respectively. The default is subpixel support if <code>TT_CONFIG_OPTION_SUBPIXEL_HINTING</code> is defined, and no subpixel support otherwise (since it isn't available then).</p>
1734 <p>If subpixel hinting is on, many TrueType bytecode instructions behave differently compared to B/W or grayscale rendering (except if &lsquo;native ClearType&rsquo; is selected by the font). Microsoft's main idea is to render at a much increased horizontal resolution, then sampling down the created output to subpixel precision. However, many older fonts are not suited to this and must be specially taken care of by applying (hardcoded) tweaks in Microsoft's interpreter.</p>
1735 <p>Details on subpixel hinting and some of the necessary tweaks can be found in Greg Hitchcock's whitepaper at &lsquo;<a href="https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx">https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx</a>&rsquo;. Note that FreeType currently doesn't really &lsquo;subpixel hint&rsquo; (6x1, 6x2, or 6x5 supersampling) like discussed in the paper. Depending on the chosen interpreter, it simply ignores instructions on vertical stems to arrive at very similar results.</p>
1736 <h4>note</h4>
1737
1738 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1739 <p>This property can be set via the <code>FREETYPE_PROPERTIES</code> environment variable (using values &lsquo;35&rsquo;, &lsquo;38&rsquo;, or &lsquo;40&rsquo;).</p>
1740 <h4>example</h4>
1741
1742 <p>The following example code demonstrates how to deactivate subpixel hinting (omitting the error handling).
1743 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1744   FT_Face     face;
1745   FT_UInt     interpreter_version = TT_INTERPRETER_VERSION_35;
1746
1747
1748   FT_Init_FreeType( &amp;library );
1749
1750   FT_Property_Set( library, &quot;truetype&quot;,
1751                             &quot;interpreter-version&quot;,
1752                             &amp;interpreter_version );
1753 </code></pre></div></p>
1754 <h4>since</h4>
1755
1756 <p>2.5</p>
1757 <hr>
1758
1759 <h2 id="svg-hooks">svg-hooks<a class="headerlink" href="#svg-hooks" title="Permanent link">&para;</a></h2>
1760 <p>Set up the interface between FreeType and an extern SVG rendering library like &lsquo;librsvg&rsquo;. All details on the function hooks can be found in section &lsquo;<a href="ft2-svg_fonts.html#svg_fonts">OpenType SVG Fonts</a>&rsquo;.</p>
1761 <h4>example</h4>
1762
1763 <p>The following example code expects that the four hook functions <code>svg_*</code> are defined elsewhere. Error handling is omitted, too.
1764 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1765   SVG_RendererHooks  hooks = {
1766                        (SVG_Lib_Init_Func)svg_init,
1767                        (SVG_Lib_Free_Func)svg_free,
1768                        (SVG_Lib_Render_Func)svg_render,
1769                        (SVG_Lib_Preset_Slot_Func)svg_preset_slot };
1770
1771
1772   FT_Init_FreeType( &amp;library );
1773
1774   FT_Property_Set( library, &quot;ot-svg&quot;,
1775                             &quot;svg-hooks&quot;, &amp;hooks );
1776 </code></pre></div></p>
1777 <h4>since</h4>
1778
1779 <p>2.12</p>
1780 <hr>
1781
1782 <h2 id="glyph-to-script-map">glyph-to-script-map<a class="headerlink" href="#glyph-to-script-map" title="Permanent link">&para;</a></h2>
1783 <p><strong>Experimental only</strong></p>
1784 <p>The auto-hinter provides various script modules to hint glyphs. Examples of supported scripts are Latin or CJK. Before a glyph is auto-hinted, the Unicode character map of the font gets examined, and the script is then determined based on Unicode character ranges, see below.</p>
1785 <p>OpenType fonts, however, often provide much more glyphs than character codes (small caps, superscripts, ligatures, swashes, etc.), to be controlled by so-called &lsquo;features&rsquo;. Handling OpenType features can be quite complicated and thus needs a separate library on top of FreeType.</p>
1786 <p>The mapping between glyph indices and scripts (in the auto-hinter sense, see the <code><a href="ft2-properties.html#ft_autohinter_script_xxx">FT_AUTOHINTER_SCRIPT_XXX</a></code> values) is stored as an array with <code>num_glyphs</code> elements, as found in the font's <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code> structure. The <code>glyph-to-script-map</code> property returns a pointer to this array, which can be modified as needed. Note that the modification should happen before the first glyph gets processed by the auto-hinter so that the global analysis of the font shapes actually uses the modified mapping.</p>
1787 <h4>example</h4>
1788
1789 <p>The following example code demonstrates how to access it (omitting the error handling).
1790 <div class="highlight"><pre><span></span><code>  FT_Library                library;
1791   FT_Face                   face;
1792   FT_Prop_GlyphToScriptMap  prop;
1793
1794
1795   FT_Init_FreeType( &amp;library );
1796   FT_New_Face( library, &quot;foo.ttf&quot;, 0, &amp;face );
1797
1798   prop.face = face;
1799
1800   FT_Property_Get( library, &quot;autofitter&quot;,
1801                             &quot;glyph-to-script-map&quot;, &amp;prop );
1802
1803   // adjust `prop.map&#39; as needed right here
1804
1805   FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT );
1806 </code></pre></div></p>
1807 <h4>since</h4>
1808
1809 <p>2.4.11</p>
1810 <hr>
1811
1812 <h2 id="ft_autohinter_script_xxx">FT_AUTOHINTER_SCRIPT_XXX<a class="headerlink" href="#ft_autohinter_script_xxx" title="Permanent link">&para;</a></h2>
1813 <p>Defined in FT_DRIVER_H (freetype/ftdriver.h).</p>
1814 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <a href="ft2-properties.html#ft_autohinter_script_none">FT_AUTOHINTER_SCRIPT_NONE</a>   0
1815 #<span class="keyword">define</span> <a href="ft2-properties.html#ft_autohinter_script_latin">FT_AUTOHINTER_SCRIPT_LATIN</a>  1
1816 #<span class="keyword">define</span> <a href="ft2-properties.html#ft_autohinter_script_cjk">FT_AUTOHINTER_SCRIPT_CJK</a>    2
1817 #<span class="keyword">define</span> <a href="ft2-properties.html#ft_autohinter_script_indic">FT_AUTOHINTER_SCRIPT_INDIC</a>  3
1818 </code></pre></div>
1819
1820 <p><strong>Experimental only</strong></p>
1821 <p>A list of constants used for the <code><a href="ft2-properties.html#glyph-to-script-map">glyph-to-script-map</a></code> property to specify the script submodule the auto-hinter should use for hinting a particular glyph.</p>
1822 <h4>values</h4>
1823 <table class="fields long">
1824 <tr><td class="val" id="ft_autohinter_script_none">FT_AUTOHINTER_SCRIPT_NONE</td><td class="desc">
1825 <p>Don't auto-hint this glyph.</p>
1826 </td></tr>
1827 <tr><td class="val" id="ft_autohinter_script_latin">FT_AUTOHINTER_SCRIPT_LATIN</td><td class="desc">
1828 <p>Apply the latin auto-hinter. For the auto-hinter, &lsquo;latin&rsquo; is a very broad term, including Cyrillic and Greek also since characters from those scripts share the same design constraints.</p>
1829 <p>By default, characters from the following Unicode ranges are assigned to this submodule.</p>
1830 <pre><code>  U+0020 - U+007F  // Basic Latin (no control characters)
1831   U+00A0 - U+00FF  // Latin-1 Supplement (no control characters)
1832   U+0100 - U+017F  // Latin Extended-A
1833   U+0180 - U+024F  // Latin Extended-B
1834   U+0250 - U+02AF  // IPA Extensions
1835   U+02B0 - U+02FF  // Spacing Modifier Letters
1836   U+0300 - U+036F  // Combining Diacritical Marks
1837   U+0370 - U+03FF  // Greek and Coptic
1838   U+0400 - U+04FF  // Cyrillic
1839   U+0500 - U+052F  // Cyrillic Supplement
1840   U+1D00 - U+1D7F  // Phonetic Extensions
1841   U+1D80 - U+1DBF  // Phonetic Extensions Supplement
1842   U+1DC0 - U+1DFF  // Combining Diacritical Marks Supplement
1843   U+1E00 - U+1EFF  // Latin Extended Additional
1844   U+1F00 - U+1FFF  // Greek Extended
1845   U+2000 - U+206F  // General Punctuation
1846   U+2070 - U+209F  // Superscripts and Subscripts
1847   U+20A0 - U+20CF  // Currency Symbols
1848   U+2150 - U+218F  // Number Forms
1849   U+2460 - U+24FF  // Enclosed Alphanumerics
1850   U+2C60 - U+2C7F  // Latin Extended-C
1851   U+2DE0 - U+2DFF  // Cyrillic Extended-A
1852   U+2E00 - U+2E7F  // Supplemental Punctuation
1853   U+A640 - U+A69F  // Cyrillic Extended-B
1854   U+A720 - U+A7FF  // Latin Extended-D
1855   U+FB00 - U+FB06  // Alphab. Present. Forms (Latin Ligatures)
1856  U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols
1857  U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement
1858 </code></pre>
1859 </td></tr>
1860 <tr><td class="val" id="ft_autohinter_script_cjk">FT_AUTOHINTER_SCRIPT_CJK</td><td class="desc">
1861 <p>Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old Vietnamese, and some other scripts.</p>
1862 <p>By default, characters from the following Unicode ranges are assigned to this submodule.</p>
1863 <pre><code>  U+1100 - U+11FF  // Hangul Jamo
1864   U+2E80 - U+2EFF  // CJK Radicals Supplement
1865   U+2F00 - U+2FDF  // Kangxi Radicals
1866   U+2FF0 - U+2FFF  // Ideographic Description Characters
1867   U+3000 - U+303F  // CJK Symbols and Punctuation
1868   U+3040 - U+309F  // Hiragana
1869   U+30A0 - U+30FF  // Katakana
1870   U+3100 - U+312F  // Bopomofo
1871   U+3130 - U+318F  // Hangul Compatibility Jamo
1872   U+3190 - U+319F  // Kanbun
1873   U+31A0 - U+31BF  // Bopomofo Extended
1874   U+31C0 - U+31EF  // CJK Strokes
1875   U+31F0 - U+31FF  // Katakana Phonetic Extensions
1876   U+3200 - U+32FF  // Enclosed CJK Letters and Months
1877   U+3300 - U+33FF  // CJK Compatibility
1878   U+3400 - U+4DBF  // CJK Unified Ideographs Extension A
1879   U+4DC0 - U+4DFF  // Yijing Hexagram Symbols
1880   U+4E00 - U+9FFF  // CJK Unified Ideographs
1881   U+A960 - U+A97F  // Hangul Jamo Extended-A
1882   U+AC00 - U+D7AF  // Hangul Syllables
1883   U+D7B0 - U+D7FF  // Hangul Jamo Extended-B
1884   U+F900 - U+FAFF  // CJK Compatibility Ideographs
1885   U+FE10 - U+FE1F  // Vertical forms
1886   U+FE30 - U+FE4F  // CJK Compatibility Forms
1887   U+FF00 - U+FFEF  // Halfwidth and Fullwidth Forms
1888  U+1B000 - U+1B0FF // Kana Supplement
1889  U+1D300 - U+1D35F // Tai Xuan Hing Symbols
1890  U+1F200 - U+1F2FF // Enclosed Ideographic Supplement
1891  U+20000 - U+2A6DF // CJK Unified Ideographs Extension B
1892  U+2A700 - U+2B73F // CJK Unified Ideographs Extension C
1893  U+2B740 - U+2B81F // CJK Unified Ideographs Extension D
1894  U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement
1895 </code></pre>
1896 </td></tr>
1897 <tr><td class="val" id="ft_autohinter_script_indic">FT_AUTOHINTER_SCRIPT_INDIC</td><td class="desc">
1898 <p>Apply the indic auto-hinter, covering all major scripts from the Indian sub-continent and some other related scripts like Thai, Lao, or Tibetan.</p>
1899 <p>By default, characters from the following Unicode ranges are assigned to this submodule.</p>
1900 <pre><code>  U+0900 - U+0DFF  // Indic Range
1901   U+0F00 - U+0FFF  // Tibetan
1902   U+1900 - U+194F  // Limbu
1903   U+1B80 - U+1BBF  // Sundanese
1904   U+A800 - U+A82F  // Syloti Nagri
1905   U+ABC0 - U+ABFF  // Meetei Mayek
1906  U+11800 - U+118DF // Sharada
1907 </code></pre>
1908 <p>Note that currently Indic support is rudimentary only, missing blue zone support.</p>
1909 </td></tr>
1910 </table>
1911
1912 <h4>since</h4>
1913
1914 <p>2.4.11</p>
1915 <hr>
1916
1917 <h2 id="ft_prop_glyphtoscriptmap">FT_Prop_GlyphToScriptMap<a class="headerlink" href="#ft_prop_glyphtoscriptmap" title="Permanent link">&para;</a></h2>
1918 <p>Defined in FT_DRIVER_H (freetype/ftdriver.h).</p>
1919 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Prop_GlyphToScriptMap_
1920   {
1921     <a href="ft2-face_creation.html#ft_face">FT_Face</a>     face;
1922     <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a>*  map;
1923
1924   } <b>FT_Prop_GlyphToScriptMap</b>;
1925 </code></pre></div>
1926
1927 <p><strong>Experimental only</strong></p>
1928 <p>The data exchange structure for the <code><a href="ft2-properties.html#glyph-to-script-map">glyph-to-script-map</a></code> property.</p>
1929 <h4>since</h4>
1930
1931 <p>2.4.11</p>
1932 <hr>
1933
1934 <h2 id="fallback-script">fallback-script<a class="headerlink" href="#fallback-script" title="Permanent link">&para;</a></h2>
1935 <p><strong>Experimental only</strong></p>
1936 <p>If no auto-hinter script module can be assigned to a glyph, a fallback script gets assigned to it (see also the <code><a href="ft2-properties.html#glyph-to-script-map">glyph-to-script-map</a></code> property). By default, this is <code><a href="ft2-properties.html#ft_autohinter_script_xxx">FT_AUTOHINTER_SCRIPT_CJK</a></code>. Using the <code>fallback-script</code> property, this fallback value can be changed.</p>
1937 <h4>note</h4>
1938
1939 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1940 <p>It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the fallback script value gets triggered either by setting or reading a face-specific property like <code><a href="ft2-properties.html#glyph-to-script-map">glyph-to-script-map</a></code>, or by auto-hinting any glyph from that face. In particular, if you have already created an <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code> structure but not loaded any glyph (using the auto-hinter), a change of the fallback script will affect this face.</p>
1941 <h4>example</h4>
1942 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1943   FT_UInt     fallback_script = FT_AUTOHINTER_SCRIPT_NONE;
1944
1945
1946   FT_Init_FreeType( &amp;library );
1947
1948   FT_Property_Set( library, &quot;autofitter&quot;,
1949                             &quot;fallback-script&quot;, &amp;fallback_script );
1950 </code></pre></div>
1951 <h4>since</h4>
1952
1953 <p>2.4.11</p>
1954 <hr>
1955
1956 <h2 id="default-script">default-script<a class="headerlink" href="#default-script" title="Permanent link">&para;</a></h2>
1957 <p><strong>Experimental only</strong></p>
1958 <p>If FreeType gets compiled with <code>FT_CONFIG_OPTION_USE_HARFBUZZ</code> to make the HarfBuzz library access OpenType features for getting better glyph coverages, this property sets the (auto-fitter) script to be used for the default (OpenType) script data of a font's GSUB table. Features for the default script are intended for all scripts not explicitly handled in GSUB; an example is a &lsquo;dlig&rsquo; feature, containing the combination of the characters &lsquo;T&rsquo;, &lsquo;E&rsquo;, and &lsquo;L&rsquo; to form a &lsquo;TEL&rsquo; ligature.</p>
1959 <p>By default, this is <code><a href="ft2-properties.html#ft_autohinter_script_xxx">FT_AUTOHINTER_SCRIPT_LATIN</a></code>. Using the <code>default-script</code> property, this default value can be changed.</p>
1960 <h4>note</h4>
1961
1962 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1963 <p>It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the default script value gets triggered either by setting or reading a face-specific property like <code><a href="ft2-properties.html#glyph-to-script-map">glyph-to-script-map</a></code>, or by auto-hinting any glyph from that face. In particular, if you have already created an <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code> structure but not loaded any glyph (using the auto-hinter), a change of the default script will affect this face.</p>
1964 <h4>example</h4>
1965 <div class="highlight"><pre><span></span><code>  FT_Library  library;
1966   FT_UInt     default_script = FT_AUTOHINTER_SCRIPT_NONE;
1967
1968
1969   FT_Init_FreeType( &amp;library );
1970
1971   FT_Property_Set( library, &quot;autofitter&quot;,
1972                             &quot;default-script&quot;, &amp;default_script );
1973 </code></pre></div>
1974 <h4>since</h4>
1975
1976 <p>2.5.3</p>
1977 <hr>
1978
1979 <h2 id="increase-x-height">increase-x-height<a class="headerlink" href="#increase-x-height" title="Permanent link">&para;</a></h2>
1980 <p>For ppem values in the range 6&nbsp;&lt;= ppem &lt;= <code>increase-x-height</code>, round up the font's x&nbsp;height much more often than normally. If the value is set to&nbsp;0, which is the default, this feature is switched off. Use this property to improve the legibility of small font sizes if necessary.</p>
1981 <h4>note</h4>
1982
1983 <p>This property can be used with <code><a href="ft2-module_management.html#ft_property_get">FT_Property_Get</a></code> also.</p>
1984 <p>Set this value right after calling <code><a href="ft2-sizing_and_scaling.html#ft_set_char_size">FT_Set_Char_Size</a></code>, but before loading any glyph (using the auto-hinter).</p>
1985 <h4>example</h4>
1986 <div class="highlight"><pre><span></span><code>  FT_Library               library;
1987   FT_Face                  face;
1988   FT_Prop_IncreaseXHeight  prop;
1989
1990
1991   FT_Init_FreeType( &amp;library );
1992   FT_New_Face( library, &quot;foo.ttf&quot;, 0, &amp;face );
1993   FT_Set_Char_Size( face, 10 * 64, 0, 72, 0 );
1994
1995   prop.face  = face;
1996   prop.limit = 14;
1997
1998   FT_Property_Set( library, &quot;autofitter&quot;,
1999                             &quot;increase-x-height&quot;, &amp;prop );
2000 </code></pre></div>
2001 <h4>since</h4>
2002
2003 <p>2.4.11</p>
2004 <hr>
2005
2006 <h2 id="ft_prop_increasexheight">FT_Prop_IncreaseXHeight<a class="headerlink" href="#ft_prop_increasexheight" title="Permanent link">&para;</a></h2>
2007 <p>Defined in FT_DRIVER_H (freetype/ftdriver.h).</p>
2008 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Prop_IncreaseXHeight_
2009   {
2010     <a href="ft2-face_creation.html#ft_face">FT_Face</a>  face;
2011     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>  limit;
2012
2013   } <b>FT_Prop_IncreaseXHeight</b>;
2014 </code></pre></div>
2015
2016 <p>The data exchange structure for the <code><a href="ft2-properties.html#increase-x-height">increase-x-height</a></code> property.</p>
2017 <hr>
2018
2019 <h2 id="warping">warping<a class="headerlink" href="#warping" title="Permanent link">&para;</a></h2>
2020 <p><strong>Obsolete</strong></p>
2021 <p>This property was always experimental and probably never worked correctly. It was entirely removed from the FreeType&nbsp;2 sources. This entry is only here for historical reference.</p>
2022 <p>Warping only worked in &lsquo;normal&rsquo; auto-hinting mode replacing it. The idea of the code was to slightly scale and shift a glyph along the non-hinted dimension (which is usually the horizontal axis) so that as much of its segments were aligned (more or less) to the grid. To find out a glyph's optimal scaling and shifting value, various parameter combinations were tried and scored.</p>
2023 <h4>since</h4>
2024
2025 <p>2.6</p>
2026 <hr>
2027                 
2028               
2029               
2030                 
2031
2032
2033               
2034             </article>
2035           </div>
2036         </div>
2037         
2038       </main>
2039       
2040         
2041 <footer class="md-footer">
2042   
2043     <nav class="md-footer__inner md-grid" aria-label="Footer">
2044       
2045         
2046         <a href="ft2-ot_svg_driver.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: The SVG driver" rel="prev">
2047           <div class="md-footer__button md-icon">
2048             <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>
2049           </div>
2050           <div class="md-footer__title">
2051             <div class="md-ellipsis">
2052               <span class="md-footer__direction">
2053                 Previous
2054               </span>
2055               The SVG driver
2056             </div>
2057           </div>
2058         </a>
2059       
2060       
2061         
2062         <a href="ft2-parameter_tags.html" class="md-footer__link md-footer__link--next" aria-label="Next: Parameter Tags" rel="next">
2063           <div class="md-footer__title">
2064             <div class="md-ellipsis">
2065               <span class="md-footer__direction">
2066                 Next
2067               </span>
2068               Parameter Tags
2069             </div>
2070           </div>
2071           <div class="md-footer__button md-icon">
2072             <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>
2073           </div>
2074         </a>
2075       
2076     </nav>
2077   
2078   <div class="md-footer-meta md-typeset">
2079     <div class="md-footer-meta__inner md-grid">
2080       <div class="md-footer-copyright">
2081         
2082           <div class="md-footer-copyright__highlight">
2083             Copyright 2023 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
2084           </div>
2085         
2086         Made with
2087         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2088           Material for MkDocs
2089         </a>
2090         
2091       </div>
2092       
2093     </div>
2094   </div>
2095 </footer>
2096       
2097     </div>
2098     <div class="md-dialog" data-md-component="dialog">
2099       <div class="md-dialog__inner md-typeset"></div>
2100     </div>
2101     <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.477d984a.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "version": null}</script>
2102     
2103     
2104       <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
2105       
2106         <script src="javascripts/extra.js"></script>
2107       
2108     
2109   </body>
2110 </html>