Imported Upstream version 2.13.2
[platform/upstream/freetype2.git] / docs / reference / ft2-quick_advance.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>Quick retrieval of advance values - 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="#quick-retrieval-of-advance-values" 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               Quick retrieval of advance values
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     <li class="md-nav__item md-nav__item--nested">
693       
694       
695         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
696       
697       <label class="md-nav__link" for="__nav_7">
698         Controlling FreeType Modules
699         <span class="md-nav__icon md-icon"></span>
700       </label>
701       <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
702         <label class="md-nav__title" for="__nav_7">
703           <span class="md-nav__icon md-icon"></span>
704           Controlling FreeType Modules
705         </label>
706         <ul class="md-nav__list" data-md-scrollfix>
707           
708             
709   
710   
711   
712     <li class="md-nav__item">
713       <a href="ft2-auto_hinter.html" class="md-nav__link">
714         The auto-hinter
715       </a>
716     </li>
717   
718
719           
720             
721   
722   
723   
724     <li class="md-nav__item">
725       <a href="ft2-cff_driver.html" class="md-nav__link">
726         The CFF driver
727       </a>
728     </li>
729   
730
731           
732             
733   
734   
735   
736     <li class="md-nav__item">
737       <a href="ft2-t1_cid_driver.html" class="md-nav__link">
738         The Type 1 and CID drivers
739       </a>
740     </li>
741   
742
743           
744             
745   
746   
747   
748     <li class="md-nav__item">
749       <a href="ft2-tt_driver.html" class="md-nav__link">
750         The TrueType driver
751       </a>
752     </li>
753   
754
755           
756             
757   
758   
759   
760     <li class="md-nav__item">
761       <a href="ft2-pcf_driver.html" class="md-nav__link">
762         The PCF driver
763       </a>
764     </li>
765   
766
767           
768             
769   
770   
771   
772     <li class="md-nav__item">
773       <a href="ft2-ot_svg_driver.html" class="md-nav__link">
774         The SVG driver
775       </a>
776     </li>
777   
778
779           
780             
781   
782   
783   
784     <li class="md-nav__item">
785       <a href="ft2-properties.html" class="md-nav__link">
786         Driver properties
787       </a>
788     </li>
789   
790
791           
792             
793   
794   
795   
796     <li class="md-nav__item">
797       <a href="ft2-parameter_tags.html" class="md-nav__link">
798         Parameter Tags
799       </a>
800     </li>
801   
802
803           
804             
805   
806   
807   
808     <li class="md-nav__item">
809       <a href="ft2-lcd_rendering.html" class="md-nav__link">
810         Subpixel Rendering
811       </a>
812     </li>
813   
814
815           
816         </ul>
817       </nav>
818     </li>
819   
820
821     
822       
823       
824       
825
826   
827   
828   
829     
830     <li class="md-nav__item md-nav__item--nested">
831       
832       
833         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
834       
835       <label class="md-nav__link" for="__nav_8">
836         Cache Sub-System
837         <span class="md-nav__icon md-icon"></span>
838       </label>
839       <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
840         <label class="md-nav__title" for="__nav_8">
841           <span class="md-nav__icon md-icon"></span>
842           Cache Sub-System
843         </label>
844         <ul class="md-nav__list" data-md-scrollfix>
845           
846             
847   
848   
849   
850     <li class="md-nav__item">
851       <a href="ft2-cache_subsystem.html" class="md-nav__link">
852         Cache Sub-System
853       </a>
854     </li>
855   
856
857           
858         </ul>
859       </nav>
860     </li>
861   
862
863     
864       
865       
866       
867
868   
869   
870     
871   
872   
873     
874     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
875       
876       
877         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" checked>
878       
879       <label class="md-nav__link" for="__nav_9">
880         Support API
881         <span class="md-nav__icon md-icon"></span>
882       </label>
883       <nav class="md-nav" aria-label="Support API" data-md-level="1">
884         <label class="md-nav__title" for="__nav_9">
885           <span class="md-nav__icon md-icon"></span>
886           Support API
887         </label>
888         <ul class="md-nav__list" data-md-scrollfix>
889           
890             
891   
892   
893   
894     <li class="md-nav__item">
895       <a href="ft2-computations.html" class="md-nav__link">
896         Computations
897       </a>
898     </li>
899   
900
901           
902             
903   
904   
905   
906     <li class="md-nav__item">
907       <a href="ft2-list_processing.html" class="md-nav__link">
908         List Processing
909       </a>
910     </li>
911   
912
913           
914             
915   
916   
917   
918     <li class="md-nav__item">
919       <a href="ft2-outline_processing.html" class="md-nav__link">
920         Outline Processing
921       </a>
922     </li>
923   
924
925           
926             
927   
928   
929     
930   
931   
932     <li class="md-nav__item md-nav__item--active">
933       
934       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
935       
936       
937         
938       
939       
940         <label class="md-nav__link md-nav__link--active" for="__toc">
941           Quick retrieval of advance values
942           <span class="md-nav__icon md-icon"></span>
943         </label>
944       
945       <a href="ft2-quick_advance.html" class="md-nav__link md-nav__link--active">
946         Quick retrieval of advance values
947       </a>
948       
949         
950 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
951   
952   
953   
954     
955   
956   
957     <label class="md-nav__title" for="__toc">
958       <span class="md-nav__icon md-icon"></span>
959       Table of contents
960     </label>
961     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
962       
963         <li class="md-nav__item">
964   <a href="#synopsis" class="md-nav__link">
965     Synopsis
966   </a>
967   
968 </li>
969       
970         <li class="md-nav__item">
971   <a href="#ft_get_advance" class="md-nav__link">
972     FT_Get_Advance
973   </a>
974   
975 </li>
976       
977         <li class="md-nav__item">
978   <a href="#ft_get_advances" class="md-nav__link">
979     FT_Get_Advances
980   </a>
981   
982 </li>
983       
984         <li class="md-nav__item">
985   <a href="#ft_advance_flag_fast_only" class="md-nav__link">
986     FT_ADVANCE_FLAG_FAST_ONLY
987   </a>
988   
989 </li>
990       
991     </ul>
992   
993 </nav>
994       
995     </li>
996   
997
998           
999             
1000   
1001   
1002   
1003     <li class="md-nav__item">
1004       <a href="ft2-bitmap_handling.html" class="md-nav__link">
1005         Bitmap Handling
1006       </a>
1007     </li>
1008   
1009
1010           
1011             
1012   
1013   
1014   
1015     <li class="md-nav__item">
1016       <a href="ft2-raster.html" class="md-nav__link">
1017         Scanline Converter
1018       </a>
1019     </li>
1020   
1021
1022           
1023             
1024   
1025   
1026   
1027     <li class="md-nav__item">
1028       <a href="ft2-glyph_stroker.html" class="md-nav__link">
1029         Glyph Stroker
1030       </a>
1031     </li>
1032   
1033
1034           
1035             
1036   
1037   
1038   
1039     <li class="md-nav__item">
1040       <a href="ft2-system_interface.html" class="md-nav__link">
1041         System Interface
1042       </a>
1043     </li>
1044   
1045
1046           
1047             
1048   
1049   
1050   
1051     <li class="md-nav__item">
1052       <a href="ft2-module_management.html" class="md-nav__link">
1053         Module Management
1054       </a>
1055     </li>
1056   
1057
1058           
1059             
1060   
1061   
1062   
1063     <li class="md-nav__item">
1064       <a href="ft2-gzip.html" class="md-nav__link">
1065         GZIP Streams
1066       </a>
1067     </li>
1068   
1069
1070           
1071             
1072   
1073   
1074   
1075     <li class="md-nav__item">
1076       <a href="ft2-lzw.html" class="md-nav__link">
1077         LZW Streams
1078       </a>
1079     </li>
1080   
1081
1082           
1083             
1084   
1085   
1086   
1087     <li class="md-nav__item">
1088       <a href="ft2-bzip2.html" class="md-nav__link">
1089         BZIP2 Streams
1090       </a>
1091     </li>
1092   
1093
1094           
1095             
1096   
1097   
1098   
1099     <li class="md-nav__item">
1100       <a href="ft2-debugging_apis.html" class="md-nav__link">
1101         External Debugging APIs
1102       </a>
1103     </li>
1104   
1105
1106           
1107         </ul>
1108       </nav>
1109     </li>
1110   
1111
1112     
1113       
1114       
1115       
1116
1117   
1118   
1119   
1120     
1121     <li class="md-nav__item md-nav__item--nested">
1122       
1123       
1124         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
1125       
1126       <label class="md-nav__link" for="__nav_10">
1127         Error Codes
1128         <span class="md-nav__icon md-icon"></span>
1129       </label>
1130       <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1131         <label class="md-nav__title" for="__nav_10">
1132           <span class="md-nav__icon md-icon"></span>
1133           Error Codes
1134         </label>
1135         <ul class="md-nav__list" data-md-scrollfix>
1136           
1137             
1138   
1139   
1140   
1141     <li class="md-nav__item">
1142       <a href="ft2-error_enumerations.html" class="md-nav__link">
1143         Error Enumerations
1144       </a>
1145     </li>
1146   
1147
1148           
1149             
1150   
1151   
1152   
1153     <li class="md-nav__item">
1154       <a href="ft2-error_code_values.html" class="md-nav__link">
1155         Error Code Values
1156       </a>
1157     </li>
1158   
1159
1160           
1161         </ul>
1162       </nav>
1163     </li>
1164   
1165
1166     
1167       
1168       
1169       
1170
1171   
1172   
1173   
1174     
1175     <li class="md-nav__item md-nav__item--nested">
1176       
1177       
1178         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" >
1179       
1180       <label class="md-nav__link" for="__nav_11">
1181         Miscellaneous
1182         <span class="md-nav__icon md-icon"></span>
1183       </label>
1184       <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1185         <label class="md-nav__title" for="__nav_11">
1186           <span class="md-nav__icon md-icon"></span>
1187           Miscellaneous
1188         </label>
1189         <ul class="md-nav__list" data-md-scrollfix>
1190           
1191             
1192   
1193   
1194   
1195     <li class="md-nav__item">
1196       <a href="ft2-gx_validation.html" class="md-nav__link">
1197         TrueTypeGX/AAT Validation
1198       </a>
1199     </li>
1200   
1201
1202           
1203             
1204   
1205   
1206   
1207     <li class="md-nav__item">
1208       <a href="ft2-incremental.html" class="md-nav__link">
1209         Incremental Loading
1210       </a>
1211     </li>
1212   
1213
1214           
1215             
1216   
1217   
1218   
1219     <li class="md-nav__item">
1220       <a href="ft2-truetype_engine.html" class="md-nav__link">
1221         The TrueType Engine
1222       </a>
1223     </li>
1224   
1225
1226           
1227             
1228   
1229   
1230   
1231     <li class="md-nav__item">
1232       <a href="ft2-ot_validation.html" class="md-nav__link">
1233         OpenType Validation
1234       </a>
1235     </li>
1236   
1237
1238           
1239         </ul>
1240       </nav>
1241     </li>
1242   
1243
1244     
1245   </ul>
1246 </nav>
1247                   </div>
1248                 </div>
1249               </div>
1250             
1251             
1252               
1253               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1254                 <div class="md-sidebar__scrollwrap">
1255                   <div class="md-sidebar__inner">
1256                     
1257 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1258   
1259   
1260   
1261     
1262   
1263   
1264     <label class="md-nav__title" for="__toc">
1265       <span class="md-nav__icon md-icon"></span>
1266       Table of contents
1267     </label>
1268     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1269       
1270         <li class="md-nav__item">
1271   <a href="#synopsis" class="md-nav__link">
1272     Synopsis
1273   </a>
1274   
1275 </li>
1276       
1277         <li class="md-nav__item">
1278   <a href="#ft_get_advance" class="md-nav__link">
1279     FT_Get_Advance
1280   </a>
1281   
1282 </li>
1283       
1284         <li class="md-nav__item">
1285   <a href="#ft_get_advances" class="md-nav__link">
1286     FT_Get_Advances
1287   </a>
1288   
1289 </li>
1290       
1291         <li class="md-nav__item">
1292   <a href="#ft_advance_flag_fast_only" class="md-nav__link">
1293     FT_ADVANCE_FLAG_FAST_ONLY
1294   </a>
1295   
1296 </li>
1297       
1298     </ul>
1299   
1300 </nav>
1301                   </div>
1302                 </div>
1303               </div>
1304             
1305           
1306           <div class="md-content" data-md-component="content">
1307             <article class="md-content__inner md-typeset">
1308               
1309                 
1310                 
1311                 <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#support-api">Support API</a> &raquo; Quick retrieval of advance values</p>
1312 <hr />
1313 <h1 id="quick-retrieval-of-advance-values">Quick retrieval of advance values<a class="headerlink" href="#quick-retrieval-of-advance-values" title="Permanent link">&para;</a></h1>
1314 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1315 <p>This section contains functions to quickly extract advance values without handling glyph outlines, if possible.</p>
1316 <h2 id="ft_get_advance">FT_Get_Advance<a class="headerlink" href="#ft_get_advance" title="Permanent link">&para;</a></h2>
1317 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1318 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1319   <b>FT_Get_Advance</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>    face,
1320                   <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    gindex,
1321                   <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>   load_flags,
1322                   <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *padvance );
1323 </code></pre></div>
1324
1325 <p>Retrieve the advance value of a given glyph outline in an <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code>.</p>
1326 <h4>input</h4>
1327 <table class="fields">
1328 <tr><td class="val" id="face">face</td><td class="desc">
1329 <p>The source <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code> handle.</p>
1330 </td></tr>
1331 <tr><td class="val" id="gindex">gindex</td><td class="desc">
1332 <p>The glyph index.</p>
1333 </td></tr>
1334 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
1335 <p>A set of bit flags similar to those used when calling <code><a href="ft2-glyph_retrieval.html#ft_load_glyph">FT_Load_Glyph</a></code>, used to determine what kind of advances you need.</p>
1336 </td></tr>
1337 </table>
1338
1339 <h4>output</h4>
1340 <table class="fields">
1341 <tr><td class="val" id="padvance">padvance</td><td class="desc">
1342 <p>The advance value. If scaling is performed (based on the value of <code>load_flags</code>), the advance value is in 16.16 format. Otherwise, it is in font units.</p>
1343 <p>If <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_VERTICAL_LAYOUT</a></code> is set, this is the vertical advance corresponding to a vertical layout. Otherwise, it is the horizontal advance in a horizontal layout.</p>
1344 </td></tr>
1345 </table>
1346
1347 <h4>return</h4>
1348
1349 <p>FreeType error code. 0 means success.</p>
1350 <h4>note</h4>
1351
1352 <p>This function may fail if you use <code><a href="ft2-quick_advance.html#ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY</a></code> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
1353 <p>A scaled advance is returned in 16.16 format but isn't transformed by the affine transformation specified by <code><a href="ft2-sizing_and_scaling.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
1354 <hr>
1355
1356 <h2 id="ft_get_advances">FT_Get_Advances<a class="headerlink" href="#ft_get_advances" title="Permanent link">&para;</a></h2>
1357 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1358 <div class = "codehilite"><pre><code>  FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
1359   <b>FT_Get_Advances</b>( <a href="ft2-face_creation.html#ft_face">FT_Face</a>    face,
1360                    <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    start,
1361                    <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>    count,
1362                    <a href="ft2-basic_types.html#ft_int32">FT_Int32</a>   load_flags,
1363                    <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  *padvances );
1364 </code></pre></div>
1365
1366 <p>Retrieve the advance values of several glyph outlines in an <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code>.</p>
1367 <h4>input</h4>
1368 <table class="fields">
1369 <tr><td class="val" id="face">face</td><td class="desc">
1370 <p>The source <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code> handle.</p>
1371 </td></tr>
1372 <tr><td class="val" id="start">start</td><td class="desc">
1373 <p>The first glyph index.</p>
1374 </td></tr>
1375 <tr><td class="val" id="count">count</td><td class="desc">
1376 <p>The number of advance values you want to retrieve.</p>
1377 </td></tr>
1378 <tr><td class="val" id="load_flags">load_flags</td><td class="desc">
1379 <p>A set of bit flags similar to those used when calling <code><a href="ft2-glyph_retrieval.html#ft_load_glyph">FT_Load_Glyph</a></code>.</p>
1380 </td></tr>
1381 </table>
1382
1383 <h4>output</h4>
1384 <table class="fields">
1385 <tr><td class="val" id="padvance">padvance</td><td class="desc">
1386 <p>The advance values. This array, to be provided by the caller, must contain at least <code>count</code> elements.</p>
1387 <p>If scaling is performed (based on the value of <code>load_flags</code>), the advance values are in 16.16 format. Otherwise, they are in font units.</p>
1388 <p>If <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_VERTICAL_LAYOUT</a></code> is set, these are the vertical advances corresponding to a vertical layout. Otherwise, they are the horizontal advances in a horizontal layout.</p>
1389 </td></tr>
1390 </table>
1391
1392 <h4>return</h4>
1393
1394 <p>FreeType error code. 0 means success.</p>
1395 <h4>note</h4>
1396
1397 <p>This function may fail if you use <code><a href="ft2-quick_advance.html#ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY</a></code> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
1398 <p>Scaled advances are returned in 16.16 format but aren't transformed by the affine transformation specified by <code><a href="ft2-sizing_and_scaling.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
1399 <hr>
1400
1401 <h2 id="ft_advance_flag_fast_only">FT_ADVANCE_FLAG_FAST_ONLY<a class="headerlink" href="#ft_advance_flag_fast_only" title="Permanent link">&para;</a></h2>
1402 <p>Defined in FT_ADVANCES_H (freetype/ftadvanc.h).</p>
1403 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_ADVANCE_FLAG_FAST_ONLY</b>  0x20000000L
1404 </code></pre></div>
1405
1406 <p>A bit-flag to be OR-ed with the <code>flags</code> parameter of the <code><a href="ft2-quick_advance.html#ft_get_advance">FT_Get_Advance</a></code> and <code><a href="ft2-quick_advance.html#ft_get_advances">FT_Get_Advances</a></code> functions.</p>
1407 <p>If set, it indicates that you want these functions to fail if the corresponding hinting mode or font driver doesn't allow for very quick advance computation.</p>
1408 <p>Typically, glyphs that are either unscaled, unhinted, bitmapped, or light-hinted can have their advance width computed very quickly.</p>
1409 <p>Normal and bytecode hinted modes that require loading, scaling, and hinting of the glyph outline, are extremely slow by comparison.</p>
1410 <hr>
1411                 
1412               
1413               
1414                 
1415
1416
1417               
1418             </article>
1419           </div>
1420         </div>
1421         
1422       </main>
1423       
1424         
1425 <footer class="md-footer">
1426   
1427     <nav class="md-footer__inner md-grid" aria-label="Footer">
1428       
1429         
1430         <a href="ft2-outline_processing.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Outline Processing" rel="prev">
1431           <div class="md-footer__button md-icon">
1432             <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>
1433           </div>
1434           <div class="md-footer__title">
1435             <div class="md-ellipsis">
1436               <span class="md-footer__direction">
1437                 Previous
1438               </span>
1439               Outline Processing
1440             </div>
1441           </div>
1442         </a>
1443       
1444       
1445         
1446         <a href="ft2-bitmap_handling.html" class="md-footer__link md-footer__link--next" aria-label="Next: Bitmap Handling" rel="next">
1447           <div class="md-footer__title">
1448             <div class="md-ellipsis">
1449               <span class="md-footer__direction">
1450                 Next
1451               </span>
1452               Bitmap Handling
1453             </div>
1454           </div>
1455           <div class="md-footer__button md-icon">
1456             <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>
1457           </div>
1458         </a>
1459       
1460     </nav>
1461   
1462   <div class="md-footer-meta md-typeset">
1463     <div class="md-footer-meta__inner md-grid">
1464       <div class="md-footer-copyright">
1465         
1466           <div class="md-footer-copyright__highlight">
1467             Copyright 2023 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1468           </div>
1469         
1470         Made with
1471         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1472           Material for MkDocs
1473         </a>
1474         
1475       </div>
1476       
1477     </div>
1478   </div>
1479 </footer>
1480       
1481     </div>
1482     <div class="md-dialog" data-md-component="dialog">
1483       <div class="md-dialog__inner md-typeset"></div>
1484     </div>
1485     <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>
1486     
1487     
1488       <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
1489       
1490         <script src="javascripts/extra.js"></script>
1491       
1492     
1493   </body>
1494 </html>