projects / platform / upstream / freetype2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Imported Upstream version 2.13.2
[platform/upstream/freetype2.git] / docs / reference / ft2-basic_types.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>Basic Data Types - 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="#basic-data-types" 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               Basic Data Types
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   
279     
280     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
281       
282       
283         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
284       
285       <label class="md-nav__link" for="__nav_4">
286         Core API
287         <span class="md-nav__icon md-icon"></span>
288       </label>
289       <nav class="md-nav" aria-label="Core API" data-md-level="1">
290         <label class="md-nav__title" for="__nav_4">
291           <span class="md-nav__icon md-icon"></span>
292           Core API
293         </label>
294         <ul class="md-nav__list" data-md-scrollfix>
295           
296             
297   
298   
299     
300   
301   
302     <li class="md-nav__item md-nav__item--active">
303       
304       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
305       
306       
307         
308       
309       
310         <label class="md-nav__link md-nav__link--active" for="__toc">
311           Basic Data Types
312           <span class="md-nav__icon md-icon"></span>
313         </label>
314       
315       <a href="ft2-basic_types.html" class="md-nav__link md-nav__link--active">
316         Basic Data Types
317       </a>
318       
319         
320 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
321   
322   
323   
324     
325   
326   
327     <label class="md-nav__title" for="__toc">
328       <span class="md-nav__icon md-icon"></span>
329       Table of contents
330     </label>
331     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
332       
333         <li class="md-nav__item">
334   <a href="#synopsis" class="md-nav__link">
335     Synopsis
336   </a>
337   
338 </li>
339       
340         <li class="md-nav__item">
341   <a href="#ft_byte" class="md-nav__link">
342     FT_Byte
343   </a>
344   
345 </li>
346       
347         <li class="md-nav__item">
348   <a href="#ft_bytes" class="md-nav__link">
349     FT_Bytes
350   </a>
351   
352 </li>
353       
354         <li class="md-nav__item">
355   <a href="#ft_char" class="md-nav__link">
356     FT_Char
357   </a>
358   
359 </li>
360       
361         <li class="md-nav__item">
362   <a href="#ft_int" class="md-nav__link">
363     FT_Int
364   </a>
365   
366 </li>
367       
368         <li class="md-nav__item">
369   <a href="#ft_uint" class="md-nav__link">
370     FT_UInt
371   </a>
372   
373 </li>
374       
375         <li class="md-nav__item">
376   <a href="#ft_int16" class="md-nav__link">
377     FT_Int16
378   </a>
379   
380 </li>
381       
382         <li class="md-nav__item">
383   <a href="#ft_uint16" class="md-nav__link">
384     FT_UInt16
385   </a>
386   
387 </li>
388       
389         <li class="md-nav__item">
390   <a href="#ft_int32" class="md-nav__link">
391     FT_Int32
392   </a>
393   
394 </li>
395       
396         <li class="md-nav__item">
397   <a href="#ft_uint32" class="md-nav__link">
398     FT_UInt32
399   </a>
400   
401 </li>
402       
403         <li class="md-nav__item">
404   <a href="#ft_int64" class="md-nav__link">
405     FT_Int64
406   </a>
407   
408 </li>
409       
410         <li class="md-nav__item">
411   <a href="#ft_uint64" class="md-nav__link">
412     FT_UInt64
413   </a>
414   
415 </li>
416       
417         <li class="md-nav__item">
418   <a href="#ft_short" class="md-nav__link">
419     FT_Short
420   </a>
421   
422 </li>
423       
424         <li class="md-nav__item">
425   <a href="#ft_ushort" class="md-nav__link">
426     FT_UShort
427   </a>
428   
429 </li>
430       
431         <li class="md-nav__item">
432   <a href="#ft_long" class="md-nav__link">
433     FT_Long
434   </a>
435   
436 </li>
437       
438         <li class="md-nav__item">
439   <a href="#ft_ulong" class="md-nav__link">
440     FT_ULong
441   </a>
442   
443 </li>
444       
445         <li class="md-nav__item">
446   <a href="#ft_bool" class="md-nav__link">
447     FT_Bool
448   </a>
449   
450 </li>
451       
452         <li class="md-nav__item">
453   <a href="#ft_offset" class="md-nav__link">
454     FT_Offset
455   </a>
456   
457 </li>
458       
459         <li class="md-nav__item">
460   <a href="#ft_ptrdist" class="md-nav__link">
461     FT_PtrDist
462   </a>
463   
464 </li>
465       
466         <li class="md-nav__item">
467   <a href="#ft_string" class="md-nav__link">
468     FT_String
469   </a>
470   
471 </li>
472       
473         <li class="md-nav__item">
474   <a href="#ft_tag" class="md-nav__link">
475     FT_Tag
476   </a>
477   
478 </li>
479       
480         <li class="md-nav__item">
481   <a href="#ft_error" class="md-nav__link">
482     FT_Error
483   </a>
484   
485 </li>
486       
487         <li class="md-nav__item">
488   <a href="#ft_fixed" class="md-nav__link">
489     FT_Fixed
490   </a>
491   
492 </li>
493       
494         <li class="md-nav__item">
495   <a href="#ft_pointer" class="md-nav__link">
496     FT_Pointer
497   </a>
498   
499 </li>
500       
501         <li class="md-nav__item">
502   <a href="#ft_pos" class="md-nav__link">
503     FT_Pos
504   </a>
505   
506 </li>
507       
508         <li class="md-nav__item">
509   <a href="#ft_vector" class="md-nav__link">
510     FT_Vector
511   </a>
512   
513 </li>
514       
515         <li class="md-nav__item">
516   <a href="#ft_bbox" class="md-nav__link">
517     FT_BBox
518   </a>
519   
520 </li>
521       
522         <li class="md-nav__item">
523   <a href="#ft_matrix" class="md-nav__link">
524     FT_Matrix
525   </a>
526   
527 </li>
528       
529         <li class="md-nav__item">
530   <a href="#ft_fword" class="md-nav__link">
531     FT_FWord
532   </a>
533   
534 </li>
535       
536         <li class="md-nav__item">
537   <a href="#ft_ufword" class="md-nav__link">
538     FT_UFWord
539   </a>
540   
541 </li>
542       
543         <li class="md-nav__item">
544   <a href="#ft_f2dot14" class="md-nav__link">
545     FT_F2Dot14
546   </a>
547   
548 </li>
549       
550         <li class="md-nav__item">
551   <a href="#ft_unitvector" class="md-nav__link">
552     FT_UnitVector
553   </a>
554   
555 </li>
556       
557         <li class="md-nav__item">
558   <a href="#ft_f26dot6" class="md-nav__link">
559     FT_F26Dot6
560   </a>
561   
562 </li>
563       
564         <li class="md-nav__item">
565   <a href="#ft_data" class="md-nav__link">
566     FT_Data
567   </a>
568   
569 </li>
570       
571         <li class="md-nav__item">
572   <a href="#ft_make_tag" class="md-nav__link">
573     FT_MAKE_TAG
574   </a>
575   
576 </li>
577       
578         <li class="md-nav__item">
579   <a href="#ft_generic" class="md-nav__link">
580     FT_Generic
581   </a>
582   
583 </li>
584       
585         <li class="md-nav__item">
586   <a href="#ft_generic_finalizer" class="md-nav__link">
587     FT_Generic_Finalizer
588   </a>
589   
590 </li>
591       
592         <li class="md-nav__item">
593   <a href="#ft_bitmap" class="md-nav__link">
594     FT_Bitmap
595   </a>
596   
597 </li>
598       
599         <li class="md-nav__item">
600   <a href="#ft_pixel_mode" class="md-nav__link">
601     FT_Pixel_Mode
602   </a>
603   
604 </li>
605       
606         <li class="md-nav__item">
607   <a href="#ft_glyph_format" class="md-nav__link">
608     FT_Glyph_Format
609   </a>
610   
611 </li>
612       
613         <li class="md-nav__item">
614   <a href="#ft_image_tag" class="md-nav__link">
615     FT_IMAGE_TAG
616   </a>
617   
618 </li>
619       
620     </ul>
621   
622 </nav>
623       
624     </li>
625   
626
627           
628             
629   
630   
631   
632     <li class="md-nav__item">
633       <a href="ft2-library_setup.html" class="md-nav__link">
634         Library Setup
635       </a>
636     </li>
637   
638
639           
640             
641   
642   
643   
644     <li class="md-nav__item">
645       <a href="ft2-face_creation.html" class="md-nav__link">
646         Face Creation
647       </a>
648     </li>
649   
650
651           
652             
653   
654   
655   
656     <li class="md-nav__item">
657       <a href="ft2-font_testing_macros.html" class="md-nav__link">
658         Font Testing Macros
659       </a>
660     </li>
661   
662
663           
664             
665   
666   
667   
668     <li class="md-nav__item">
669       <a href="ft2-sizing_and_scaling.html" class="md-nav__link">
670         Sizing and Scaling
671       </a>
672     </li>
673   
674
675           
676             
677   
678   
679   
680     <li class="md-nav__item">
681       <a href="ft2-glyph_retrieval.html" class="md-nav__link">
682         Glyph Retrieval
683       </a>
684     </li>
685   
686
687           
688             
689   
690   
691   
692     <li class="md-nav__item">
693       <a href="ft2-character_mapping.html" class="md-nav__link">
694         Character Mapping
695       </a>
696     </li>
697   
698
699           
700             
701   
702   
703   
704     <li class="md-nav__item">
705       <a href="ft2-information_retrieval.html" class="md-nav__link">
706         Information Retrieval
707       </a>
708     </li>
709   
710
711           
712             
713   
714   
715   
716     <li class="md-nav__item">
717       <a href="ft2-other_api_data.html" class="md-nav__link">
718         Other API Data
719       </a>
720     </li>
721   
722
723           
724         </ul>
725       </nav>
726     </li>
727   
728
729     
730       
731       
732       
733
734   
735   
736   
737     
738     <li class="md-nav__item md-nav__item--nested">
739       
740       
741         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
742       
743       <label class="md-nav__link" for="__nav_5">
744         Extended API
745         <span class="md-nav__icon md-icon"></span>
746       </label>
747       <nav class="md-nav" aria-label="Extended API" data-md-level="1">
748         <label class="md-nav__title" for="__nav_5">
749           <span class="md-nav__icon md-icon"></span>
750           Extended API
751         </label>
752         <ul class="md-nav__list" data-md-scrollfix>
753           
754             
755   
756   
757   
758     <li class="md-nav__item">
759       <a href="ft2-glyph_variants.html" class="md-nav__link">
760         Unicode Variation Sequences
761       </a>
762     </li>
763   
764
765           
766             
767   
768   
769   
770     <li class="md-nav__item">
771       <a href="ft2-color_management.html" class="md-nav__link">
772         Glyph Color Management
773       </a>
774     </li>
775   
776
777           
778             
779   
780   
781   
782     <li class="md-nav__item">
783       <a href="ft2-layer_management.html" class="md-nav__link">
784         Glyph Layer Management
785       </a>
786     </li>
787   
788
789           
790             
791   
792   
793   
794     <li class="md-nav__item">
795       <a href="ft2-glyph_management.html" class="md-nav__link">
796         Glyph Management
797       </a>
798     </li>
799   
800
801           
802             
803   
804   
805   
806     <li class="md-nav__item">
807       <a href="ft2-mac_specific.html" class="md-nav__link">
808         Mac Specific Interface
809       </a>
810     </li>
811   
812
813           
814             
815   
816   
817   
818     <li class="md-nav__item">
819       <a href="ft2-sizes_management.html" class="md-nav__link">
820         Size Management
821       </a>
822     </li>
823   
824
825           
826             
827   
828   
829   
830     <li class="md-nav__item">
831       <a href="ft2-header_file_macros.html" class="md-nav__link">
832         Header File Macros
833       </a>
834     </li>
835   
836
837           
838         </ul>
839       </nav>
840     </li>
841   
842
843     
844       
845       
846       
847
848   
849   
850   
851     
852     <li class="md-nav__item md-nav__item--nested">
853       
854       
855         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
856       
857       <label class="md-nav__link" for="__nav_6">
858         Format-Specific API
859         <span class="md-nav__icon md-icon"></span>
860       </label>
861       <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
862         <label class="md-nav__title" for="__nav_6">
863           <span class="md-nav__icon md-icon"></span>
864           Format-Specific API
865         </label>
866         <ul class="md-nav__list" data-md-scrollfix>
867           
868             
869   
870   
871   
872     <li class="md-nav__item">
873       <a href="ft2-multiple_masters.html" class="md-nav__link">
874         Multiple Masters
875       </a>
876     </li>
877   
878
879           
880             
881   
882   
883   
884     <li class="md-nav__item">
885       <a href="ft2-truetype_tables.html" class="md-nav__link">
886         TrueType Tables
887       </a>
888     </li>
889   
890
891           
892             
893   
894   
895   
896     <li class="md-nav__item">
897       <a href="ft2-type1_tables.html" class="md-nav__link">
898         Type 1 Tables
899       </a>
900     </li>
901   
902
903           
904             
905   
906   
907   
908     <li class="md-nav__item">
909       <a href="ft2-sfnt_names.html" class="md-nav__link">
910         SFNT Names
911       </a>
912     </li>
913   
914
915           
916             
917   
918   
919   
920     <li class="md-nav__item">
921       <a href="ft2-bdf_fonts.html" class="md-nav__link">
922         BDF and PCF Files
923       </a>
924     </li>
925   
926
927           
928             
929   
930   
931   
932     <li class="md-nav__item">
933       <a href="ft2-cid_fonts.html" class="md-nav__link">
934         CID Fonts
935       </a>
936     </li>
937   
938
939           
940             
941   
942   
943   
944     <li class="md-nav__item">
945       <a href="ft2-pfr_fonts.html" class="md-nav__link">
946         PFR Fonts
947       </a>
948     </li>
949   
950
951           
952             
953   
954   
955   
956     <li class="md-nav__item">
957       <a href="ft2-winfnt_fonts.html" class="md-nav__link">
958         Window FNT Files
959       </a>
960     </li>
961   
962
963           
964             
965   
966   
967   
968     <li class="md-nav__item">
969       <a href="ft2-svg_fonts.html" class="md-nav__link">
970         OpenType SVG Fonts
971       </a>
972     </li>
973   
974
975           
976             
977   
978   
979   
980     <li class="md-nav__item">
981       <a href="ft2-font_formats.html" class="md-nav__link">
982         Font Formats
983       </a>
984     </li>
985   
986
987           
988             
989   
990   
991   
992     <li class="md-nav__item">
993       <a href="ft2-gasp_table.html" class="md-nav__link">
994         Gasp Table
995       </a>
996     </li>
997   
998
999           
1000         </ul>
1001       </nav>
1002     </li>
1003   
1004
1005     
1006       
1007       
1008       
1009
1010   
1011   
1012   
1013     
1014     <li class="md-nav__item md-nav__item--nested">
1015       
1016       
1017         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1018       
1019       <label class="md-nav__link" for="__nav_7">
1020         Controlling FreeType Modules
1021         <span class="md-nav__icon md-icon"></span>
1022       </label>
1023       <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
1024         <label class="md-nav__title" for="__nav_7">
1025           <span class="md-nav__icon md-icon"></span>
1026           Controlling FreeType Modules
1027         </label>
1028         <ul class="md-nav__list" data-md-scrollfix>
1029           
1030             
1031   
1032   
1033   
1034     <li class="md-nav__item">
1035       <a href="ft2-auto_hinter.html" class="md-nav__link">
1036         The auto-hinter
1037       </a>
1038     </li>
1039   
1040
1041           
1042             
1043   
1044   
1045   
1046     <li class="md-nav__item">
1047       <a href="ft2-cff_driver.html" class="md-nav__link">
1048         The CFF driver
1049       </a>
1050     </li>
1051   
1052
1053           
1054             
1055   
1056   
1057   
1058     <li class="md-nav__item">
1059       <a href="ft2-t1_cid_driver.html" class="md-nav__link">
1060         The Type 1 and CID drivers
1061       </a>
1062     </li>
1063   
1064
1065           
1066             
1067   
1068   
1069   
1070     <li class="md-nav__item">
1071       <a href="ft2-tt_driver.html" class="md-nav__link">
1072         The TrueType driver
1073       </a>
1074     </li>
1075   
1076
1077           
1078             
1079   
1080   
1081   
1082     <li class="md-nav__item">
1083       <a href="ft2-pcf_driver.html" class="md-nav__link">
1084         The PCF driver
1085       </a>
1086     </li>
1087   
1088
1089           
1090             
1091   
1092   
1093   
1094     <li class="md-nav__item">
1095       <a href="ft2-ot_svg_driver.html" class="md-nav__link">
1096         The SVG driver
1097       </a>
1098     </li>
1099   
1100
1101           
1102             
1103   
1104   
1105   
1106     <li class="md-nav__item">
1107       <a href="ft2-properties.html" class="md-nav__link">
1108         Driver properties
1109       </a>
1110     </li>
1111   
1112
1113           
1114             
1115   
1116   
1117   
1118     <li class="md-nav__item">
1119       <a href="ft2-parameter_tags.html" class="md-nav__link">
1120         Parameter Tags
1121       </a>
1122     </li>
1123   
1124
1125           
1126             
1127   
1128   
1129   
1130     <li class="md-nav__item">
1131       <a href="ft2-lcd_rendering.html" class="md-nav__link">
1132         Subpixel Rendering
1133       </a>
1134     </li>
1135   
1136
1137           
1138         </ul>
1139       </nav>
1140     </li>
1141   
1142
1143     
1144       
1145       
1146       
1147
1148   
1149   
1150   
1151     
1152     <li class="md-nav__item md-nav__item--nested">
1153       
1154       
1155         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
1156       
1157       <label class="md-nav__link" for="__nav_8">
1158         Cache Sub-System
1159         <span class="md-nav__icon md-icon"></span>
1160       </label>
1161       <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
1162         <label class="md-nav__title" for="__nav_8">
1163           <span class="md-nav__icon md-icon"></span>
1164           Cache Sub-System
1165         </label>
1166         <ul class="md-nav__list" data-md-scrollfix>
1167           
1168             
1169   
1170   
1171   
1172     <li class="md-nav__item">
1173       <a href="ft2-cache_subsystem.html" class="md-nav__link">
1174         Cache Sub-System
1175       </a>
1176     </li>
1177   
1178
1179           
1180         </ul>
1181       </nav>
1182     </li>
1183   
1184
1185     
1186       
1187       
1188       
1189
1190   
1191   
1192   
1193     
1194     <li class="md-nav__item md-nav__item--nested">
1195       
1196       
1197         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
1198       
1199       <label class="md-nav__link" for="__nav_9">
1200         Support API
1201         <span class="md-nav__icon md-icon"></span>
1202       </label>
1203       <nav class="md-nav" aria-label="Support API" data-md-level="1">
1204         <label class="md-nav__title" for="__nav_9">
1205           <span class="md-nav__icon md-icon"></span>
1206           Support API
1207         </label>
1208         <ul class="md-nav__list" data-md-scrollfix>
1209           
1210             
1211   
1212   
1213   
1214     <li class="md-nav__item">
1215       <a href="ft2-computations.html" class="md-nav__link">
1216         Computations
1217       </a>
1218     </li>
1219   
1220
1221           
1222             
1223   
1224   
1225   
1226     <li class="md-nav__item">
1227       <a href="ft2-list_processing.html" class="md-nav__link">
1228         List Processing
1229       </a>
1230     </li>
1231   
1232
1233           
1234             
1235   
1236   
1237   
1238     <li class="md-nav__item">
1239       <a href="ft2-outline_processing.html" class="md-nav__link">
1240         Outline Processing
1241       </a>
1242     </li>
1243   
1244
1245           
1246             
1247   
1248   
1249   
1250     <li class="md-nav__item">
1251       <a href="ft2-quick_advance.html" class="md-nav__link">
1252         Quick retrieval of advance values
1253       </a>
1254     </li>
1255   
1256
1257           
1258             
1259   
1260   
1261   
1262     <li class="md-nav__item">
1263       <a href="ft2-bitmap_handling.html" class="md-nav__link">
1264         Bitmap Handling
1265       </a>
1266     </li>
1267   
1268
1269           
1270             
1271   
1272   
1273   
1274     <li class="md-nav__item">
1275       <a href="ft2-raster.html" class="md-nav__link">
1276         Scanline Converter
1277       </a>
1278     </li>
1279   
1280
1281           
1282             
1283   
1284   
1285   
1286     <li class="md-nav__item">
1287       <a href="ft2-glyph_stroker.html" class="md-nav__link">
1288         Glyph Stroker
1289       </a>
1290     </li>
1291   
1292
1293           
1294             
1295   
1296   
1297   
1298     <li class="md-nav__item">
1299       <a href="ft2-system_interface.html" class="md-nav__link">
1300         System Interface
1301       </a>
1302     </li>
1303   
1304
1305           
1306             
1307   
1308   
1309   
1310     <li class="md-nav__item">
1311       <a href="ft2-module_management.html" class="md-nav__link">
1312         Module Management
1313       </a>
1314     </li>
1315   
1316
1317           
1318             
1319   
1320   
1321   
1322     <li class="md-nav__item">
1323       <a href="ft2-gzip.html" class="md-nav__link">
1324         GZIP Streams
1325       </a>
1326     </li>
1327   
1328
1329           
1330             
1331   
1332   
1333   
1334     <li class="md-nav__item">
1335       <a href="ft2-lzw.html" class="md-nav__link">
1336         LZW Streams
1337       </a>
1338     </li>
1339   
1340
1341           
1342             
1343   
1344   
1345   
1346     <li class="md-nav__item">
1347       <a href="ft2-bzip2.html" class="md-nav__link">
1348         BZIP2 Streams
1349       </a>
1350     </li>
1351   
1352
1353           
1354             
1355   
1356   
1357   
1358     <li class="md-nav__item">
1359       <a href="ft2-debugging_apis.html" class="md-nav__link">
1360         External Debugging APIs
1361       </a>
1362     </li>
1363   
1364
1365           
1366         </ul>
1367       </nav>
1368     </li>
1369   
1370
1371     
1372       
1373       
1374       
1375
1376   
1377   
1378   
1379     
1380     <li class="md-nav__item md-nav__item--nested">
1381       
1382       
1383         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
1384       
1385       <label class="md-nav__link" for="__nav_10">
1386         Error Codes
1387         <span class="md-nav__icon md-icon"></span>
1388       </label>
1389       <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1390         <label class="md-nav__title" for="__nav_10">
1391           <span class="md-nav__icon md-icon"></span>
1392           Error Codes
1393         </label>
1394         <ul class="md-nav__list" data-md-scrollfix>
1395           
1396             
1397   
1398   
1399   
1400     <li class="md-nav__item">
1401       <a href="ft2-error_enumerations.html" class="md-nav__link">
1402         Error Enumerations
1403       </a>
1404     </li>
1405   
1406
1407           
1408             
1409   
1410   
1411   
1412     <li class="md-nav__item">
1413       <a href="ft2-error_code_values.html" class="md-nav__link">
1414         Error Code Values
1415       </a>
1416     </li>
1417   
1418
1419           
1420         </ul>
1421       </nav>
1422     </li>
1423   
1424
1425     
1426       
1427       
1428       
1429
1430   
1431   
1432   
1433     
1434     <li class="md-nav__item md-nav__item--nested">
1435       
1436       
1437         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" >
1438       
1439       <label class="md-nav__link" for="__nav_11">
1440         Miscellaneous
1441         <span class="md-nav__icon md-icon"></span>
1442       </label>
1443       <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1444         <label class="md-nav__title" for="__nav_11">
1445           <span class="md-nav__icon md-icon"></span>
1446           Miscellaneous
1447         </label>
1448         <ul class="md-nav__list" data-md-scrollfix>
1449           
1450             
1451   
1452   
1453   
1454     <li class="md-nav__item">
1455       <a href="ft2-gx_validation.html" class="md-nav__link">
1456         TrueTypeGX/AAT Validation
1457       </a>
1458     </li>
1459   
1460
1461           
1462             
1463   
1464   
1465   
1466     <li class="md-nav__item">
1467       <a href="ft2-incremental.html" class="md-nav__link">
1468         Incremental Loading
1469       </a>
1470     </li>
1471   
1472
1473           
1474             
1475   
1476   
1477   
1478     <li class="md-nav__item">
1479       <a href="ft2-truetype_engine.html" class="md-nav__link">
1480         The TrueType Engine
1481       </a>
1482     </li>
1483   
1484
1485           
1486             
1487   
1488   
1489   
1490     <li class="md-nav__item">
1491       <a href="ft2-ot_validation.html" class="md-nav__link">
1492         OpenType Validation
1493       </a>
1494     </li>
1495   
1496
1497           
1498         </ul>
1499       </nav>
1500     </li>
1501   
1502
1503     
1504   </ul>
1505 </nav>
1506                   </div>
1507                 </div>
1508               </div>
1509             
1510             
1511               
1512               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1513                 <div class="md-sidebar__scrollwrap">
1514                   <div class="md-sidebar__inner">
1515                     
1516 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1517   
1518   
1519   
1520     
1521   
1522   
1523     <label class="md-nav__title" for="__toc">
1524       <span class="md-nav__icon md-icon"></span>
1525       Table of contents
1526     </label>
1527     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1528       
1529         <li class="md-nav__item">
1530   <a href="#synopsis" class="md-nav__link">
1531     Synopsis
1532   </a>
1533   
1534 </li>
1535       
1536         <li class="md-nav__item">
1537   <a href="#ft_byte" class="md-nav__link">
1538     FT_Byte
1539   </a>
1540   
1541 </li>
1542       
1543         <li class="md-nav__item">
1544   <a href="#ft_bytes" class="md-nav__link">
1545     FT_Bytes
1546   </a>
1547   
1548 </li>
1549       
1550         <li class="md-nav__item">
1551   <a href="#ft_char" class="md-nav__link">
1552     FT_Char
1553   </a>
1554   
1555 </li>
1556       
1557         <li class="md-nav__item">
1558   <a href="#ft_int" class="md-nav__link">
1559     FT_Int
1560   </a>
1561   
1562 </li>
1563       
1564         <li class="md-nav__item">
1565   <a href="#ft_uint" class="md-nav__link">
1566     FT_UInt
1567   </a>
1568   
1569 </li>
1570       
1571         <li class="md-nav__item">
1572   <a href="#ft_int16" class="md-nav__link">
1573     FT_Int16
1574   </a>
1575   
1576 </li>
1577       
1578         <li class="md-nav__item">
1579   <a href="#ft_uint16" class="md-nav__link">
1580     FT_UInt16
1581   </a>
1582   
1583 </li>
1584       
1585         <li class="md-nav__item">
1586   <a href="#ft_int32" class="md-nav__link">
1587     FT_Int32
1588   </a>
1589   
1590 </li>
1591       
1592         <li class="md-nav__item">
1593   <a href="#ft_uint32" class="md-nav__link">
1594     FT_UInt32
1595   </a>
1596   
1597 </li>
1598       
1599         <li class="md-nav__item">
1600   <a href="#ft_int64" class="md-nav__link">
1601     FT_Int64
1602   </a>
1603   
1604 </li>
1605       
1606         <li class="md-nav__item">
1607   <a href="#ft_uint64" class="md-nav__link">
1608     FT_UInt64
1609   </a>
1610   
1611 </li>
1612       
1613         <li class="md-nav__item">
1614   <a href="#ft_short" class="md-nav__link">
1615     FT_Short
1616   </a>
1617   
1618 </li>
1619       
1620         <li class="md-nav__item">
1621   <a href="#ft_ushort" class="md-nav__link">
1622     FT_UShort
1623   </a>
1624   
1625 </li>
1626       
1627         <li class="md-nav__item">
1628   <a href="#ft_long" class="md-nav__link">
1629     FT_Long
1630   </a>
1631   
1632 </li>
1633       
1634         <li class="md-nav__item">
1635   <a href="#ft_ulong" class="md-nav__link">
1636     FT_ULong
1637   </a>
1638   
1639 </li>
1640       
1641         <li class="md-nav__item">
1642   <a href="#ft_bool" class="md-nav__link">
1643     FT_Bool
1644   </a>
1645   
1646 </li>
1647       
1648         <li class="md-nav__item">
1649   <a href="#ft_offset" class="md-nav__link">
1650     FT_Offset
1651   </a>
1652   
1653 </li>
1654       
1655         <li class="md-nav__item">
1656   <a href="#ft_ptrdist" class="md-nav__link">
1657     FT_PtrDist
1658   </a>
1659   
1660 </li>
1661       
1662         <li class="md-nav__item">
1663   <a href="#ft_string" class="md-nav__link">
1664     FT_String
1665   </a>
1666   
1667 </li>
1668       
1669         <li class="md-nav__item">
1670   <a href="#ft_tag" class="md-nav__link">
1671     FT_Tag
1672   </a>
1673   
1674 </li>
1675       
1676         <li class="md-nav__item">
1677   <a href="#ft_error" class="md-nav__link">
1678     FT_Error
1679   </a>
1680   
1681 </li>
1682       
1683         <li class="md-nav__item">
1684   <a href="#ft_fixed" class="md-nav__link">
1685     FT_Fixed
1686   </a>
1687   
1688 </li>
1689       
1690         <li class="md-nav__item">
1691   <a href="#ft_pointer" class="md-nav__link">
1692     FT_Pointer
1693   </a>
1694   
1695 </li>
1696       
1697         <li class="md-nav__item">
1698   <a href="#ft_pos" class="md-nav__link">
1699     FT_Pos
1700   </a>
1701   
1702 </li>
1703       
1704         <li class="md-nav__item">
1705   <a href="#ft_vector" class="md-nav__link">
1706     FT_Vector
1707   </a>
1708   
1709 </li>
1710       
1711         <li class="md-nav__item">
1712   <a href="#ft_bbox" class="md-nav__link">
1713     FT_BBox
1714   </a>
1715   
1716 </li>
1717       
1718         <li class="md-nav__item">
1719   <a href="#ft_matrix" class="md-nav__link">
1720     FT_Matrix
1721   </a>
1722   
1723 </li>
1724       
1725         <li class="md-nav__item">
1726   <a href="#ft_fword" class="md-nav__link">
1727     FT_FWord
1728   </a>
1729   
1730 </li>
1731       
1732         <li class="md-nav__item">
1733   <a href="#ft_ufword" class="md-nav__link">
1734     FT_UFWord
1735   </a>
1736   
1737 </li>
1738       
1739         <li class="md-nav__item">
1740   <a href="#ft_f2dot14" class="md-nav__link">
1741     FT_F2Dot14
1742   </a>
1743   
1744 </li>
1745       
1746         <li class="md-nav__item">
1747   <a href="#ft_unitvector" class="md-nav__link">
1748     FT_UnitVector
1749   </a>
1750   
1751 </li>
1752       
1753         <li class="md-nav__item">
1754   <a href="#ft_f26dot6" class="md-nav__link">
1755     FT_F26Dot6
1756   </a>
1757   
1758 </li>
1759       
1760         <li class="md-nav__item">
1761   <a href="#ft_data" class="md-nav__link">
1762     FT_Data
1763   </a>
1764   
1765 </li>
1766       
1767         <li class="md-nav__item">
1768   <a href="#ft_make_tag" class="md-nav__link">
1769     FT_MAKE_TAG
1770   </a>
1771   
1772 </li>
1773       
1774         <li class="md-nav__item">
1775   <a href="#ft_generic" class="md-nav__link">
1776     FT_Generic
1777   </a>
1778   
1779 </li>
1780       
1781         <li class="md-nav__item">
1782   <a href="#ft_generic_finalizer" class="md-nav__link">
1783     FT_Generic_Finalizer
1784   </a>
1785   
1786 </li>
1787       
1788         <li class="md-nav__item">
1789   <a href="#ft_bitmap" class="md-nav__link">
1790     FT_Bitmap
1791   </a>
1792   
1793 </li>
1794       
1795         <li class="md-nav__item">
1796   <a href="#ft_pixel_mode" class="md-nav__link">
1797     FT_Pixel_Mode
1798   </a>
1799   
1800 </li>
1801       
1802         <li class="md-nav__item">
1803   <a href="#ft_glyph_format" class="md-nav__link">
1804     FT_Glyph_Format
1805   </a>
1806   
1807 </li>
1808       
1809         <li class="md-nav__item">
1810   <a href="#ft_image_tag" class="md-nav__link">
1811     FT_IMAGE_TAG
1812   </a>
1813   
1814 </li>
1815       
1816     </ul>
1817   
1818 </nav>
1819                   </div>
1820                 </div>
1821               </div>
1822             
1823           
1824           <div class="md-content" data-md-component="content">
1825             <article class="md-content__inner md-typeset">
1826               
1827                 
1828                 
1829                 <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#core-api">Core API</a> &raquo; Basic Data Types</p>
1830 <hr />
1831 <h1 id="basic-data-types">Basic Data Types<a class="headerlink" href="#basic-data-types" title="Permanent link">&para;</a></h1>
1832 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1833 <p>This section contains the basic data types defined by FreeType&nbsp;2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section. Note that FreeType does not use floating-point data types. Fractional values are represented by fixed-point integers, with lower bits storing the fractional part.</p>
1834 <h2 id="ft_byte">FT_Byte<a class="headerlink" href="#ft_byte" title="Permanent link">&para;</a></h2>
1835 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1836 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span>  <b>FT_Byte</b>;
1837 </code></pre></div>
1838
1839 <p>A simple typedef for the <em>unsigned</em> char type.</p>
1840 <hr>
1841
1842 <h2 id="ft_bytes">FT_Bytes<a class="headerlink" href="#ft_bytes" title="Permanent link">&para;</a></h2>
1843 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1844 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>*  <b>FT_Bytes</b>;
1845 </code></pre></div>
1846
1847 <p>A typedef for constant memory areas.</p>
1848 <hr>
1849
1850 <h2 id="ft_char">FT_Char<a class="headerlink" href="#ft_char" title="Permanent link">&para;</a></h2>
1851 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1852 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">char</span>  <b>FT_Char</b>;
1853 </code></pre></div>
1854
1855 <p>A simple typedef for the <em>signed</em> char type.</p>
1856 <hr>
1857
1858 <h2 id="ft_int">FT_Int<a class="headerlink" href="#ft_int" title="Permanent link">&para;</a></h2>
1859 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1860 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">int</span>  <b>FT_Int</b>;
1861 </code></pre></div>
1862
1863 <p>A typedef for the int type.</p>
1864 <hr>
1865
1866 <h2 id="ft_uint">FT_UInt<a class="headerlink" href="#ft_uint" title="Permanent link">&para;</a></h2>
1867 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1868 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">int</span>  <b>FT_UInt</b>;
1869 </code></pre></div>
1870
1871 <p>A typedef for the unsigned int type.</p>
1872 <hr>
1873
1874 <h2 id="ft_int16">FT_Int16<a class="headerlink" href="#ft_int16" title="Permanent link">&para;</a></h2>
1875 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span>  <b>FT_Int16</b>;
1876 </code></pre></div>
1877
1878 <p>A typedef for a 16bit signed integer type.</p>
1879 <hr>
1880
1881 <h2 id="ft_uint16">FT_UInt16<a class="headerlink" href="#ft_uint16" title="Permanent link">&para;</a></h2>
1882 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span>  <b>FT_UInt16</b>;
1883 </code></pre></div>
1884
1885 <p>A typedef for a 16bit unsigned integer type.</p>
1886 <hr>
1887
1888 <h2 id="ft_int32">FT_Int32<a class="headerlink" href="#ft_int32" title="Permanent link">&para;</a></h2>
1889 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> XXX  <b>FT_Int32</b>;
1890 </code></pre></div>
1891
1892 <p>A typedef for a 32bit signed integer type. The size depends on the configuration.</p>
1893 <hr>
1894
1895 <h2 id="ft_uint32">FT_UInt32<a class="headerlink" href="#ft_uint32" title="Permanent link">&para;</a></h2>
1896 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> XXX  <b>FT_UInt32</b>;
1897 </code></pre></div>
1898 <hr>
1899
1900 <h2 id="ft_int64">FT_Int64<a class="headerlink" href="#ft_int64" title="Permanent link">&para;</a></h2>
1901 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> XXX  <b>FT_Int64</b>;
1902 </code></pre></div>
1903 <hr>
1904
1905 <h2 id="ft_uint64">FT_UInt64<a class="headerlink" href="#ft_uint64" title="Permanent link">&para;</a></h2>
1906 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> XXX  <b>FT_UInt64</b>;
1907 </code></pre></div>
1908 <hr>
1909
1910 <h2 id="ft_short">FT_Short<a class="headerlink" href="#ft_short" title="Permanent link">&para;</a></h2>
1911 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1912 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span>  <b>FT_Short</b>;
1913 </code></pre></div>
1914
1915 <p>A typedef for signed short.</p>
1916 <hr>
1917
1918 <h2 id="ft_ushort">FT_UShort<a class="headerlink" href="#ft_ushort" title="Permanent link">&para;</a></h2>
1919 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1920 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span>  <b>FT_UShort</b>;
1921 </code></pre></div>
1922
1923 <p>A typedef for unsigned short.</p>
1924 <hr>
1925
1926 <h2 id="ft_long">FT_Long<a class="headerlink" href="#ft_long" title="Permanent link">&para;</a></h2>
1927 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1928 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span>  <b>FT_Long</b>;
1929 </code></pre></div>
1930
1931 <p>A typedef for signed long.</p>
1932 <hr>
1933
1934 <h2 id="ft_ulong">FT_ULong<a class="headerlink" href="#ft_ulong" title="Permanent link">&para;</a></h2>
1935 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1936 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">long</span>  <b>FT_ULong</b>;
1937 </code></pre></div>
1938
1939 <p>A typedef for unsigned long.</p>
1940 <hr>
1941
1942 <h2 id="ft_bool">FT_Bool<a class="headerlink" href="#ft_bool" title="Permanent link">&para;</a></h2>
1943 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1944 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span>  <b>FT_Bool</b>;
1945 </code></pre></div>
1946
1947 <p>A typedef of unsigned char, used for simple booleans. As usual, values 1 and&nbsp;0 represent true and false, respectively.</p>
1948 <hr>
1949
1950 <h2 id="ft_offset">FT_Offset<a class="headerlink" href="#ft_offset" title="Permanent link">&para;</a></h2>
1951 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1952 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> size_t  <b>FT_Offset</b>;
1953 </code></pre></div>
1954
1955 <p>This is equivalent to the ANSI&nbsp;C <code>size_t</code> type, i.e., the largest <em>unsigned</em> integer type used to express a file size or position, or a memory block size.</p>
1956 <hr>
1957
1958 <h2 id="ft_ptrdist">FT_PtrDist<a class="headerlink" href="#ft_ptrdist" title="Permanent link">&para;</a></h2>
1959 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1960 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> ft_ptrdiff_t  <b>FT_PtrDist</b>;
1961 </code></pre></div>
1962
1963 <p>This is equivalent to the ANSI&nbsp;C <code>ptrdiff_t</code> type, i.e., the largest <em>signed</em> integer type used to express the distance between two pointers.</p>
1964 <hr>
1965
1966 <h2 id="ft_string">FT_String<a class="headerlink" href="#ft_string" title="Permanent link">&para;</a></h2>
1967 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1968 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">char</span>  <b>FT_String</b>;
1969 </code></pre></div>
1970
1971 <p>A simple typedef for the char type, usually used for strings.</p>
1972 <hr>
1973
1974 <h2 id="ft_tag">FT_Tag<a class="headerlink" href="#ft_tag" title="Permanent link">&para;</a></h2>
1975 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1976 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a>  <b>FT_Tag</b>;
1977 </code></pre></div>
1978
1979 <p>A typedef for 32-bit tags (as used in the SFNT format).</p>
1980 <hr>
1981
1982 <h2 id="ft_error">FT_Error<a class="headerlink" href="#ft_error" title="Permanent link">&para;</a></h2>
1983 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1984 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">int</span>  <b>FT_Error</b>;
1985 </code></pre></div>
1986
1987 <p>The FreeType error code type. A value of&nbsp;0 is always interpreted as a successful operation.</p>
1988 <hr>
1989
1990 <h2 id="ft_fixed">FT_Fixed<a class="headerlink" href="#ft_fixed" title="Permanent link">&para;</a></h2>
1991 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
1992 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span>  <b>FT_Fixed</b>;
1993 </code></pre></div>
1994
1995 <p>This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients.</p>
1996 <hr>
1997
1998 <h2 id="ft_pointer">FT_Pointer<a class="headerlink" href="#ft_pointer" title="Permanent link">&para;</a></h2>
1999 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2000 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">void</span>*  <b>FT_Pointer</b>;
2001 </code></pre></div>
2002
2003 <p>A simple typedef for a typeless pointer.</p>
2004 <hr>
2005
2006 <h2 id="ft_pos">FT_Pos<a class="headerlink" href="#ft_pos" title="Permanent link">&para;</a></h2>
2007 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2008 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span>  <b>FT_Pos</b>;
2009 </code></pre></div>
2010
2011 <p>The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed-point pixel coordinates.</p>
2012 <hr>
2013
2014 <h2 id="ft_vector">FT_Vector<a class="headerlink" href="#ft_vector" title="Permanent link">&para;</a></h2>
2015 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2016 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Vector_
2017   {
2018     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  x;
2019     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  y;
2020
2021   } <b>FT_Vector</b>;
2022 </code></pre></div>
2023
2024 <p>A simple structure used to store a 2D vector; coordinates are of the FT_Pos type.</p>
2025 <h4>fields</h4>
2026 <table class="fields">
2027 <tr><td class="val" id="x">x</td><td class="desc">
2028 <p>The horizontal coordinate.</p>
2029 </td></tr>
2030 <tr><td class="val" id="y">y</td><td class="desc">
2031 <p>The vertical coordinate.</p>
2032 </td></tr>
2033 </table>
2034
2035 <hr>
2036
2037 <h2 id="ft_bbox">FT_BBox<a class="headerlink" href="#ft_bbox" title="Permanent link">&para;</a></h2>
2038 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2039 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_BBox_
2040   {
2041     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  xMin, yMin;
2042     <a href="ft2-basic_types.html#ft_pos">FT_Pos</a>  xMax, yMax;
2043
2044   } <b>FT_BBox</b>;
2045 </code></pre></div>
2046
2047 <p>A structure used to hold an outline's bounding box, i.e., the coordinates of its extrema in the horizontal and vertical directions.</p>
2048 <h4>fields</h4>
2049 <table class="fields">
2050 <tr><td class="val" id="xmin">xMin</td><td class="desc">
2051 <p>The horizontal minimum (left-most).</p>
2052 </td></tr>
2053 <tr><td class="val" id="ymin">yMin</td><td class="desc">
2054 <p>The vertical minimum (bottom-most).</p>
2055 </td></tr>
2056 <tr><td class="val" id="xmax">xMax</td><td class="desc">
2057 <p>The horizontal maximum (right-most).</p>
2058 </td></tr>
2059 <tr><td class="val" id="ymax">yMax</td><td class="desc">
2060 <p>The vertical maximum (top-most).</p>
2061 </td></tr>
2062 </table>
2063
2064 <h4>note</h4>
2065
2066 <p>The bounding box is specified with the coordinates of the lower left and the upper right corner. In PostScript, those values are often called (llx,lly) and (urx,ury), respectively.</p>
2067 <p>If <code>yMin</code> is negative, this value gives the glyph's descender. Otherwise, the glyph doesn't descend below the baseline. Similarly, if <code>ymax</code> is positive, this value gives the glyph's ascender.</p>
2068 <p><code>xMin</code> gives the horizontal distance from the glyph's origin to the left edge of the glyph's bounding box. If <code>xMin</code> is negative, the glyph extends to the left of the origin.</p>
2069 <hr>
2070
2071 <h2 id="ft_matrix">FT_Matrix<a class="headerlink" href="#ft_matrix" title="Permanent link">&para;</a></h2>
2072 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2073 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Matrix_
2074   {
2075     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  xx, xy;
2076     <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a>  yx, yy;
2077
2078   } <b>FT_Matrix</b>;
2079 </code></pre></div>
2080
2081 <p>A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is:
2082 <div class="highlight"><pre><span></span><code>  x&#39; = x*xx + y*xy
2083   y&#39; = x*yx + y*yy
2084 </code></pre></div></p>
2085 <h4>fields</h4>
2086 <table class="fields">
2087 <tr><td class="val" id="xx">xx</td><td class="desc">
2088 <p>Matrix coefficient.</p>
2089 </td></tr>
2090 <tr><td class="val" id="xy">xy</td><td class="desc">
2091 <p>Matrix coefficient.</p>
2092 </td></tr>
2093 <tr><td class="val" id="yx">yx</td><td class="desc">
2094 <p>Matrix coefficient.</p>
2095 </td></tr>
2096 <tr><td class="val" id="yy">yy</td><td class="desc">
2097 <p>Matrix coefficient.</p>
2098 </td></tr>
2099 </table>
2100
2101 <hr>
2102
2103 <h2 id="ft_fword">FT_FWord<a class="headerlink" href="#ft_fword" title="Permanent link">&para;</a></h2>
2104 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2105 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span>  <b>FT_FWord</b>;   /* distance in FUnits */
2106 </code></pre></div>
2107
2108 <p>A signed 16-bit integer used to store a distance in original font units.</p>
2109 <hr>
2110
2111 <h2 id="ft_ufword">FT_UFWord<a class="headerlink" href="#ft_ufword" title="Permanent link">&para;</a></h2>
2112 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2113 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span>  <b>FT_UFWord</b>;  /* <span class="keyword">unsigned</span> distance */
2114 </code></pre></div>
2115
2116 <p>An unsigned 16-bit integer used to store a distance in original font units.</p>
2117 <hr>
2118
2119 <h2 id="ft_f2dot14">FT_F2Dot14<a class="headerlink" href="#ft_f2dot14" title="Permanent link">&para;</a></h2>
2120 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2121 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span>  <b>FT_F2Dot14</b>;
2122 </code></pre></div>
2123
2124 <p>A signed 2.14 fixed-point type used for unit vectors.</p>
2125 <hr>
2126
2127 <h2 id="ft_unitvector">FT_UnitVector<a class="headerlink" href="#ft_unitvector" title="Permanent link">&para;</a></h2>
2128 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2129 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_UnitVector_
2130   {
2131     <a href="ft2-basic_types.html#ft_f2dot14">FT_F2Dot14</a>  x;
2132     <a href="ft2-basic_types.html#ft_f2dot14">FT_F2Dot14</a>  y;
2133
2134   } <b>FT_UnitVector</b>;
2135 </code></pre></div>
2136
2137 <p>A simple structure used to store a 2D vector unit vector. Uses FT_F2Dot14 types.</p>
2138 <h4>fields</h4>
2139 <table class="fields">
2140 <tr><td class="val" id="x">x</td><td class="desc">
2141 <p>Horizontal coordinate.</p>
2142 </td></tr>
2143 <tr><td class="val" id="y">y</td><td class="desc">
2144 <p>Vertical coordinate.</p>
2145 </td></tr>
2146 </table>
2147
2148 <hr>
2149
2150 <h2 id="ft_f26dot6">FT_F26Dot6<a class="headerlink" href="#ft_f26dot6" title="Permanent link">&para;</a></h2>
2151 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2152 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span>  <b>FT_F26Dot6</b>;
2153 </code></pre></div>
2154
2155 <p>A signed 26.6 fixed-point type used for vectorial pixel coordinates.</p>
2156 <hr>
2157
2158 <h2 id="ft_data">FT_Data<a class="headerlink" href="#ft_data" title="Permanent link">&para;</a></h2>
2159 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2160 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Data_
2161   {
2162     <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>*  pointer;
2163     <a href="ft2-basic_types.html#ft_uint">FT_UInt</a>         length;
2164
2165   } <b>FT_Data</b>;
2166 </code></pre></div>
2167
2168 <p>Read-only binary data represented as a pointer and a length.</p>
2169 <h4>fields</h4>
2170 <table class="fields">
2171 <tr><td class="val" id="pointer">pointer</td><td class="desc">
2172 <p>The data.</p>
2173 </td></tr>
2174 <tr><td class="val" id="length">length</td><td class="desc">
2175 <p>The length of the data in bytes.</p>
2176 </td></tr>
2177 </table>
2178
2179 <hr>
2180
2181 <h2 id="ft_make_tag">FT_MAKE_TAG<a class="headerlink" href="#ft_make_tag" title="Permanent link">&para;</a></h2>
2182 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2183 <div class = "codehilite"><pre><code>#<span class="keyword">define</span> <b>FT_MAKE_TAG</b>( _x1, _x2, _x3, _x4 )                  \
2184           ( ( FT_STATIC_BYTE_CAST( <a href="ft2-basic_types.html#ft_tag">FT_Tag</a>, _x1 ) &lt;&lt; 24 ) | \
2185             ( FT_STATIC_BYTE_CAST( <a href="ft2-basic_types.html#ft_tag">FT_Tag</a>, _x2 ) &lt;&lt; 16 ) | \
2186             ( FT_STATIC_BYTE_CAST( <a href="ft2-basic_types.html#ft_tag">FT_Tag</a>, _x3 ) &lt;&lt;  8 ) | \
2187               FT_STATIC_BYTE_CAST( <a href="ft2-basic_types.html#ft_tag">FT_Tag</a>, _x4 )         )
2188 </code></pre></div>
2189
2190 <p>This macro converts four-letter tags that are used to label TrueType tables into an <code>FT_Tag</code> type, to be used within FreeType.</p>
2191 <h4>note</h4>
2192
2193 <p>The produced values <strong>must</strong> be 32-bit integers. Don't redefine this macro.</p>
2194 <hr>
2195
2196 <h2 id="ft_generic">FT_Generic<a class="headerlink" href="#ft_generic" title="Permanent link">&para;</a></h2>
2197 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2198 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Generic_
2199   {
2200     <span class="keyword">void</span>*                 data;
2201     <a href="ft2-basic_types.html#ft_generic_finalizer">FT_Generic_Finalizer</a>  finalizer;
2202
2203   } <b>FT_Generic</b>;
2204 </code></pre></div>
2205
2206 <p>Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object.</p>
2207 <p>Some FreeType object contains a <code>generic</code> field, of type <code>FT_Generic</code>, which usage is left to client applications and font servers.</p>
2208 <p>It can be used to store a pointer to client-specific data, as well as the address of a &lsquo;finalizer&rsquo; function, which will be called by FreeType when the object is destroyed (for example, the previous client example would put the address of the glyph cache destructor in the <code>finalizer</code> field).</p>
2209 <h4>fields</h4>
2210 <table class="fields">
2211 <tr><td class="val" id="data">data</td><td class="desc">
2212 <p>A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library.</p>
2213 </td></tr>
2214 <tr><td class="val" id="finalizer">finalizer</td><td class="desc">
2215 <p>A pointer to a &lsquo;generic finalizer&rsquo; function, which will be called when the object is destroyed. If this field is set to <code>NULL</code>, no code will be called.</p>
2216 </td></tr>
2217 </table>
2218
2219 <hr>
2220
2221 <h2 id="ft_generic_finalizer">FT_Generic_Finalizer<a class="headerlink" href="#ft_generic_finalizer" title="Permanent link">&para;</a></h2>
2222 <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
2223 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">void</span>  (*<b>FT_Generic_Finalizer</b>)( <span class="keyword">void</span>*  object );
2224 </code></pre></div>
2225
2226 <p>Describe a function used to destroy the &lsquo;client&rsquo; data of any FreeType object. See the description of the <code><a href="ft2-basic_types.html#ft_generic">FT_Generic</a></code> type for details of usage.</p>
2227 <h4>input</h4>
2228
2229 <p>The address of the FreeType object that is under finalization. Its client data is accessed through its <code>generic</code> field.</p>
2230 <hr>
2231
2232 <h2 id="ft_bitmap">FT_Bitmap<a class="headerlink" href="#ft_bitmap" title="Permanent link">&para;</a></h2>
2233 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2234 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Bitmap_
2235   {
2236     <span class="keyword">unsigned</span> <span class="keyword">int</span>    rows;
2237     <span class="keyword">unsigned</span> <span class="keyword">int</span>    width;
2238     <span class="keyword">int</span>             pitch;
2239     <span class="keyword">unsigned</span> <span class="keyword">char</span>*  buffer;
2240     <span class="keyword">unsigned</span> <span class="keyword">short</span>  num_grays;
2241     <span class="keyword">unsigned</span> <span class="keyword">char</span>   pixel_mode;
2242     <span class="keyword">unsigned</span> <span class="keyword">char</span>   palette_mode;
2243     <span class="keyword">void</span>*           palette;
2244
2245   } <b>FT_Bitmap</b>;
2246 </code></pre></div>
2247
2248 <p>A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the <code>pixel_mode</code> field.</p>
2249 <h4>fields</h4>
2250 <table class="fields">
2251 <tr><td class="val" id="rows">rows</td><td class="desc">
2252 <p>The number of bitmap rows.</p>
2253 </td></tr>
2254 <tr><td class="val" id="width">width</td><td class="desc">
2255 <p>The number of pixels in bitmap row.</p>
2256 </td></tr>
2257 <tr><td class="val" id="pitch">pitch</td><td class="desc">
2258 <p>The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a &lsquo;down&rsquo; flow, and negative when it has an &lsquo;up&rsquo; flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row.</p>
2259 <p>Note that &lsquo;padding&rsquo; means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value.</p>
2260 <p>For the B/W rasterizer, <code>pitch</code> is always an even number.</p>
2261 <p>To change the pitch of a bitmap (say, to make it a multiple of 4), use <code><a href="ft2-bitmap_handling.html#ft_bitmap_convert">FT_Bitmap_Convert</a></code>. Alternatively, you might use callback functions to directly render to the application's surface; see the file <code>example2.cpp</code> in the tutorial for a demonstration.</p>
2262 </td></tr>
2263 <tr><td class="val" id="buffer">buffer</td><td class="desc">
2264 <p>A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.</p>
2265 </td></tr>
2266 <tr><td class="val" id="num_grays">num_grays</td><td class="desc">
2267 <p>This field is only used with <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY</a></code>; it gives the number of gray levels used in the bitmap.</p>
2268 </td></tr>
2269 <tr><td class="val" id="pixel_mode">pixel_mode</td><td class="desc">
2270 <p>The pixel mode, i.e., how pixel bits are stored. See <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_Pixel_Mode</a></code> for possible values.</p>
2271 </td></tr>
2272 <tr><td class="val" id="palette_mode">palette_mode</td><td class="desc">
2273 <p>This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently.</p>
2274 </td></tr>
2275 <tr><td class="val" id="palette">palette</td><td class="desc">
2276 <p>A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently.</p>
2277 </td></tr>
2278 </table>
2279
2280 <h4>note</h4>
2281
2282 <p><code>width</code> and <code>rows</code> refer to the <em>physical</em> size of the bitmap, not the <em>logical</em> one. For example, if <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_Pixel_Mode</a></code> is set to <code>FT_PIXEL_MODE_LCD</code>, the logical width is a just a third of the physical one.</p>
2283 <hr>
2284
2285 <h2 id="ft_pixel_mode">FT_Pixel_Mode<a class="headerlink" href="#ft_pixel_mode" title="Permanent link">&para;</a></h2>
2286 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2287 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Pixel_Mode_
2288   {
2289     <a href="ft2-basic_types.html#ft_pixel_mode_none">FT_PIXEL_MODE_NONE</a> = 0,
2290     <a href="ft2-basic_types.html#ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</a>,
2291     <a href="ft2-basic_types.html#ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</a>,
2292     <a href="ft2-basic_types.html#ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</a>,
2293     <a href="ft2-basic_types.html#ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</a>,
2294     <a href="ft2-basic_types.html#ft_pixel_mode_lcd">FT_PIXEL_MODE_LCD</a>,
2295     <a href="ft2-basic_types.html#ft_pixel_mode_lcd_v">FT_PIXEL_MODE_LCD_V</a>,
2296     <a href="ft2-basic_types.html#ft_pixel_mode_bgra">FT_PIXEL_MODE_BGRA</a>,
2297
2298     FT_PIXEL_MODE_MAX      /* do not remove */
2299
2300   } <b>FT_Pixel_Mode</b>;
2301
2302
2303   /* these constants are deprecated; use the corresponding `<b>FT_Pixel_Mode</b>` */
2304   /* values instead.                                                       */
2305 #<span class="keyword">define</span> ft_pixel_mode_none   <a href="ft2-basic_types.html#ft_pixel_mode_none">FT_PIXEL_MODE_NONE</a>
2306 #<span class="keyword">define</span> ft_pixel_mode_mono   <a href="ft2-basic_types.html#ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</a>
2307 #<span class="keyword">define</span> ft_pixel_mode_grays  <a href="ft2-basic_types.html#ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</a>
2308 #<span class="keyword">define</span> ft_pixel_mode_pal2   <a href="ft2-basic_types.html#ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</a>
2309 #<span class="keyword">define</span> ft_pixel_mode_pal4   <a href="ft2-basic_types.html#ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</a>
2310 </code></pre></div>
2311
2312 <p>An enumeration type used to describe the format of pixels in a given bitmap. Note that additional formats may be added in the future.</p>
2313 <h4>values</h4>
2314 <table class="fields">
2315 <tr><td class="val" id="ft_pixel_mode_none">FT_PIXEL_MODE_NONE</td><td class="desc">
2316 <p>Value&nbsp;0 is reserved.</p>
2317 </td></tr>
2318 <tr><td class="val" id="ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</td><td class="desc">
2319 <p>A monochrome bitmap, using 1&nbsp;bit per pixel. Note that pixels are stored in most-significant order (MSB), which means that the left-most pixel in a byte has value 128.</p>
2320 </td></tr>
2321 <tr><td class="val" id="ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</td><td class="desc">
2322 <p>An 8-bit bitmap, generally used to represent anti-aliased glyph images. Each pixel is stored in one byte. Note that the number of &lsquo;gray&rsquo; levels is stored in the <code>num_grays</code> field of the <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code> structure (it generally is 256).</p>
2323 </td></tr>
2324 <tr><td class="val" id="ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</td><td class="desc">
2325 <p>A 2-bit per pixel bitmap, used to represent embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.</p>
2326 </td></tr>
2327 <tr><td class="val" id="ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</td><td class="desc">
2328 <p>A 4-bit per pixel bitmap, representing embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.</p>
2329 </td></tr>
2330 <tr><td class="val" id="ft_pixel_mode_lcd">FT_PIXEL_MODE_LCD</td><td class="desc">
2331 <p>An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on LCD displays; the bitmap is three times wider than the original glyph image. See also <code><a href="ft2-glyph_retrieval.html#ft_render_mode">FT_RENDER_MODE_LCD</a></code>.</p>
2332 </td></tr>
2333 <tr><td class="val" id="ft_pixel_mode_lcd_v">FT_PIXEL_MODE_LCD_V</td><td class="desc">
2334 <p>An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on rotated LCD displays; the bitmap is three times taller than the original glyph image. See also <code><a href="ft2-glyph_retrieval.html#ft_render_mode">FT_RENDER_MODE_LCD_V</a></code>.</p>
2335 </td></tr>
2336 <tr><td class="val" id="ft_pixel_mode_bgra">FT_PIXEL_MODE_BGRA</td><td class="desc">
2337 <p>[Since 2.5] An image with four 8-bit channels per pixel, representing a color image (such as emoticons) with alpha channel. For each pixel, the format is BGRA, which means, the blue channel comes first in memory. The color channels are pre-multiplied and in the sRGB colorspace. For example, full red at half-translucent opacity will be represented as &lsquo;00,00,80,80&rsquo;, not &lsquo;00,00,FF,80&rsquo;. See also <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_COLOR</a></code>.</p>
2338 </td></tr>
2339 </table>
2340
2341 <hr>
2342
2343 <h2 id="ft_glyph_format">FT_Glyph_Format<a class="headerlink" href="#ft_glyph_format" title="Permanent link">&para;</a></h2>
2344 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2345 <div class = "codehilite"><pre><code>  <span class="keyword">typedef</span> <span class="keyword">enum</span>  FT_Glyph_Format_
2346   {
2347     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</a>, 0, 0, 0, 0 ),
2348
2349     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</a>, 'c', 'o', 'm', 'p' ),
2350     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</a>,    'b', 'i', 't', 's' ),
2351     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</a>,   'o', 'u', 't', 'l' ),
2352     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</a>,   'p', 'l', 'o', 't' ),
2353     <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_svg">FT_GLYPH_FORMAT_SVG</a>,       'S', 'V', 'G', ' ' )
2354
2355   } <b>FT_Glyph_Format</b>;
2356
2357
2358   /* these constants are deprecated; use the corresponding */
2359   /* `<b>FT_Glyph_Format</b>` values instead.                     */
2360 #<span class="keyword">define</span> ft_glyph_format_none       <a href="ft2-basic_types.html#ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</a>
2361 #<span class="keyword">define</span> ft_glyph_format_composite  <a href="ft2-basic_types.html#ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</a>
2362 #<span class="keyword">define</span> ft_glyph_format_bitmap     <a href="ft2-basic_types.html#ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</a>
2363 #<span class="keyword">define</span> ft_glyph_format_outline    <a href="ft2-basic_types.html#ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</a>
2364 #<span class="keyword">define</span> ft_glyph_format_plotter    <a href="ft2-basic_types.html#ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</a>
2365 </code></pre></div>
2366
2367 <p>An enumeration type used to describe the format of a given glyph image. Note that this version of FreeType only supports two image formats, even though future font drivers will be able to register their own format.</p>
2368 <h4>values</h4>
2369 <table class="fields">
2370 <tr><td class="val" id="ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</td><td class="desc">
2371 <p>The value&nbsp;0 is reserved.</p>
2372 </td></tr>
2373 <tr><td class="val" id="ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</td><td class="desc">
2374 <p>The glyph image is a composite of several other images. This format is <em>only</em> used with <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_NO_RECURSE</a></code>, and is used to report compound glyphs (like accented characters).</p>
2375 </td></tr>
2376 <tr><td class="val" id="ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</td><td class="desc">
2377 <p>The glyph image is a bitmap, and can be described as an <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code>. You generally need to access the <code>bitmap</code> field of the <code><a href="ft2-glyph_retrieval.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure to read it.</p>
2378 </td></tr>
2379 <tr><td class="val" id="ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</td><td class="desc">
2380 <p>The glyph image is a vectorial outline made of line segments and Bezier arcs; it can be described as an <code><a href="ft2-outline_processing.html#ft_outline">FT_Outline</a></code>; you generally want to access the <code>outline</code> field of the <code><a href="ft2-glyph_retrieval.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure to read it.</p>
2381 </td></tr>
2382 <tr><td class="val" id="ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</td><td class="desc">
2383 <p>The glyph image is a vectorial path with no inside and outside contours. Some Type&nbsp;1 fonts, like those in the Hershey family, contain glyphs in this format. These are described as <code><a href="ft2-outline_processing.html#ft_outline">FT_Outline</a></code>, but FreeType isn't currently capable of rendering them correctly.</p>
2384 </td></tr>
2385 <tr><td class="val" id="ft_glyph_format_svg">FT_GLYPH_FORMAT_SVG</td><td class="desc">
2386 <p>[Since 2.12] The glyph is represented by an SVG document in the &lsquo;SVG&nbsp;&rsquo; table.</p>
2387 </td></tr>
2388 </table>
2389
2390 <hr>
2391
2392 <h2 id="ft_image_tag">FT_IMAGE_TAG<a class="headerlink" href="#ft_image_tag" title="Permanent link">&para;</a></h2>
2393 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
2394 <div class = "codehilite"><pre><code>#<span class="keyword">ifndef</span> <b>FT_IMAGE_TAG</b>
2395
2396 #<span class="keyword">define</span> <b>FT_IMAGE_TAG</b>( value, _x1, _x2, _x3, _x4 )                         \
2397           value = ( ( FT_STATIC_BYTE_CAST( <span class="keyword">unsigned</span> <span class="keyword">long</span>, _x1 ) &lt;&lt; 24 ) | \
2398                     ( FT_STATIC_BYTE_CAST( <span class="keyword">unsigned</span> <span class="keyword">long</span>, _x2 ) &lt;&lt; 16 ) | \
2399                     ( FT_STATIC_BYTE_CAST( <span class="keyword">unsigned</span> <span class="keyword">long</span>, _x3 ) &lt;&lt; 8  ) | \
2400                       FT_STATIC_BYTE_CAST( <span class="keyword">unsigned</span> <span class="keyword">long</span>, _x4 )         )
2401
2402 #<span class="keyword">endif</span> /* <b>FT_IMAGE_TAG</b> */
2403 </code></pre></div>
2404
2405 <p>This macro converts four-letter tags to an unsigned long type.</p>
2406 <h4>note</h4>
2407
2408 <p>Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this:
2409 <div class="highlight"><pre><span></span><code>  #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 )  value
2410 </code></pre></div></p>
2411 <p>to get a simple enumeration without assigning special numbers.</p>
2412 <hr>
2413                 
2414               
2415               
2416                 
2417
2418
2419               
2420             </article>
2421           </div>
2422         </div>
2423         
2424       </main>
2425       
2426         
2427 <footer class="md-footer">
2428   
2429     <nav class="md-footer__inner md-grid" aria-label="Footer">
2430       
2431         
2432         <a href="ft2-user_allocation.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: User allocation" rel="prev">
2433           <div class="md-footer__button md-icon">
2434             <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>
2435           </div>
2436           <div class="md-footer__title">
2437             <div class="md-ellipsis">
2438               <span class="md-footer__direction">
2439                 Previous
2440               </span>
2441               User allocation
2442             </div>
2443           </div>
2444         </a>
2445       
2446       
2447         
2448         <a href="ft2-library_setup.html" class="md-footer__link md-footer__link--next" aria-label="Next: Library Setup" rel="next">
2449           <div class="md-footer__title">
2450             <div class="md-ellipsis">
2451               <span class="md-footer__direction">
2452                 Next
2453               </span>
2454               Library Setup
2455             </div>
2456           </div>
2457           <div class="md-footer__button md-icon">
2458             <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>
2459           </div>
2460         </a>
2461       
2462     </nav>
2463   
2464   <div class="md-footer-meta md-typeset">
2465     <div class="md-footer-meta__inner md-grid">
2466       <div class="md-footer-copyright">
2467         
2468           <div class="md-footer-copyright__highlight">
2469             Copyright 2023 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
2470           </div>
2471         
2472         Made with
2473         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2474           Material for MkDocs
2475         </a>
2476         
2477       </div>
2478       
2479     </div>
2480   </div>
2481 </footer>
2482       
2483     </div>
2484     <div class="md-dialog" data-md-component="dialog">
2485       <div class="md-dialog__inner md-typeset"></div>
2486     </div>
2487     <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>
2488     
2489     
2490       <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
2491       
2492         <script src="javascripts/extra.js"></script>
2493       
2494     
2495   </body>
2496 </html>
Domain: UI Framework / Fonts;