1 /***************************************************************************/ 2 /* */ 3 /* freetype.h */ 4 /* */ 5 /* FreeType high-level API and common types (specification only). */ 6 /* */ 7 /* Copyright 1996-2014 by */ 8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9 /* */ 10 /* This file is part of the FreeType project, and may only be used, */ 11 /* modified, and distributed under the terms of the FreeType project */ 12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13 /* this file you indicate that you have read the license and */ 14 /* understand and accept it fully. */ 15 /* */ 16 /***************************************************************************/ 17 18 19 #ifndef __FREETYPE_H__ 20 #define __FREETYPE_H__ 21 22 23 #ifndef FT_FREETYPE_H 24 #error "`ft2build.h' hasn't been included yet!" 25 #error "Please always use macros to include FreeType header files." 26 #error "Example:" 27 #error " #include <ft2build.h>" 28 #error " #include FT_FREETYPE_H" 29 #endif 30 31 32 #include <ft2build.h> 33 #include FT_CONFIG_CONFIG_H 34 #include FT_TYPES_H 35 #include FT_ERRORS_H 36 37 38 FT_BEGIN_HEADER 39 40 41 42 /*************************************************************************/ 43 /* */ 44 /* <Section> */ 45 /* header_inclusion */ 46 /* */ 47 /* <Title> */ 48 /* FreeType's header inclusion scheme */ 49 /* */ 50 /* <Abstract> */ 51 /* How client applications should include FreeType header files. */ 52 /* */ 53 /* <Description> */ 54 /* To be as flexible as possible (and for historical reasons), */ 55 /* FreeType uses a very special inclusion scheme to load header */ 56 /* files, for example */ 57 /* */ 58 /* { */ 59 /* #include <ft2build.h> */ 60 /* */ 61 /* #include FT_FREETYPE_H */ 62 /* #include FT_OUTLINE_H */ 63 /* } */ 64 /* */ 65 /* A compiler and its preprocessor only needs an include path to find */ 66 /* the file `ft2build.h'; the exact locations and names of the other */ 67 /* FreeType header files are hidden by preprocessor macro names, */ 68 /* loaded by `ft2build.h'. The API documentation always gives the */ 69 /* header macro name needed for a particular function. */ 70 /* */ 71 /*************************************************************************/ 72 73 74 /*************************************************************************/ 75 /* */ 76 /* <Section> */ 77 /* user_allocation */ 78 /* */ 79 /* <Title> */ 80 /* User allocation */ 81 /* */ 82 /* <Abstract> */ 83 /* How client applications should allocate FreeType data structures. */ 84 /* */ 85 /* <Description> */ 86 /* FreeType assumes that structures allocated by the user and passed */ 87 /* as arguments are zeroed out except for the actual data. In other */ 88 /* words, it is recommended to use `calloc' (or variants of it) */ 89 /* instead of `malloc' for allocation. */ 90 /* */ 91 /*************************************************************************/ 92 93 94 95 /*************************************************************************/ 96 /*************************************************************************/ 97 /* */ 98 /* B A S I C T Y P E S */ 99 /* */ 100 /*************************************************************************/ 101 /*************************************************************************/ 102 103 104 /*************************************************************************/ 105 /* */ 106 /* <Section> */ 107 /* base_interface */ 108 /* */ 109 /* <Title> */ 110 /* Base Interface */ 111 /* */ 112 /* <Abstract> */ 113 /* The FreeType~2 base font interface. */ 114 /* */ 115 /* <Description> */ 116 /* This section describes the public high-level API of FreeType~2. */ 117 /* */ 118 /* <Order> */ 119 /* FT_Library */ 120 /* FT_Face */ 121 /* FT_Size */ 122 /* FT_GlyphSlot */ 123 /* FT_CharMap */ 124 /* FT_Encoding */ 125 /* */ 126 /* FT_FaceRec */ 127 /* */ 128 /* FT_FACE_FLAG_SCALABLE */ 129 /* FT_FACE_FLAG_FIXED_SIZES */ 130 /* FT_FACE_FLAG_FIXED_WIDTH */ 131 /* FT_FACE_FLAG_HORIZONTAL */ 132 /* FT_FACE_FLAG_VERTICAL */ 133 /* FT_FACE_FLAG_COLOR */ 134 /* FT_FACE_FLAG_SFNT */ 135 /* FT_FACE_FLAG_CID_KEYED */ 136 /* FT_FACE_FLAG_TRICKY */ 137 /* FT_FACE_FLAG_KERNING */ 138 /* FT_FACE_FLAG_MULTIPLE_MASTERS */ 139 /* FT_FACE_FLAG_GLYPH_NAMES */ 140 /* FT_FACE_FLAG_EXTERNAL_STREAM */ 141 /* FT_FACE_FLAG_FAST_GLYPHS */ 142 /* FT_FACE_FLAG_HINTER */ 143 /* */ 144 /* FT_STYLE_FLAG_BOLD */ 145 /* FT_STYLE_FLAG_ITALIC */ 146 /* */ 147 /* FT_SizeRec */ 148 /* FT_Size_Metrics */ 149 /* */ 150 /* FT_GlyphSlotRec */ 151 /* FT_Glyph_Metrics */ 152 /* FT_SubGlyph */ 153 /* */ 154 /* FT_Bitmap_Size */ 155 /* */ 156 /* FT_Init_FreeType */ 157 /* FT_Done_FreeType */ 158 /* */ 159 /* FT_New_Face */ 160 /* FT_Done_Face */ 161 /* FT_New_Memory_Face */ 162 /* FT_Open_Face */ 163 /* FT_Open_Args */ 164 /* FT_Parameter */ 165 /* FT_Attach_File */ 166 /* FT_Attach_Stream */ 167 /* */ 168 /* FT_Set_Char_Size */ 169 /* FT_Set_Pixel_Sizes */ 170 /* FT_Request_Size */ 171 /* FT_Select_Size */ 172 /* FT_Size_Request_Type */ 173 /* FT_Size_Request */ 174 /* FT_Set_Transform */ 175 /* FT_Load_Glyph */ 176 /* FT_Get_Char_Index */ 177 /* FT_Get_Name_Index */ 178 /* FT_Load_Char */ 179 /* */ 180 /* FT_OPEN_MEMORY */ 181 /* FT_OPEN_STREAM */ 182 /* FT_OPEN_PATHNAME */ 183 /* FT_OPEN_DRIVER */ 184 /* FT_OPEN_PARAMS */ 185 /* */ 186 /* FT_LOAD_DEFAULT */ 187 /* FT_LOAD_RENDER */ 188 /* FT_LOAD_MONOCHROME */ 189 /* FT_LOAD_LINEAR_DESIGN */ 190 /* FT_LOAD_NO_SCALE */ 191 /* FT_LOAD_NO_HINTING */ 192 /* FT_LOAD_NO_BITMAP */ 193 /* FT_LOAD_CROP_BITMAP */ 194 /* */ 195 /* FT_LOAD_VERTICAL_LAYOUT */ 196 /* FT_LOAD_IGNORE_TRANSFORM */ 197 /* FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH */ 198 /* FT_LOAD_FORCE_AUTOHINT */ 199 /* FT_LOAD_NO_RECURSE */ 200 /* FT_LOAD_PEDANTIC */ 201 /* */ 202 /* FT_LOAD_TARGET_NORMAL */ 203 /* FT_LOAD_TARGET_LIGHT */ 204 /* FT_LOAD_TARGET_MONO */ 205 /* FT_LOAD_TARGET_LCD */ 206 /* FT_LOAD_TARGET_LCD_V */ 207 /* */ 208 /* FT_Render_Glyph */ 209 /* FT_Render_Mode */ 210 /* FT_Get_Kerning */ 211 /* FT_Kerning_Mode */ 212 /* FT_Get_Track_Kerning */ 213 /* FT_Get_Glyph_Name */ 214 /* FT_Get_Postscript_Name */ 215 /* */ 216 /* FT_CharMapRec */ 217 /* FT_Select_Charmap */ 218 /* FT_Set_Charmap */ 219 /* FT_Get_Charmap_Index */ 220 /* */ 221 /* FT_FSTYPE_INSTALLABLE_EMBEDDING */ 222 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING */ 223 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING */ 224 /* FT_FSTYPE_EDITABLE_EMBEDDING */ 225 /* FT_FSTYPE_NO_SUBSETTING */ 226 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY */ 227 /* */ 228 /* FT_Get_FSType_Flags */ 229 /* */ 230 /*************************************************************************/ 231 232 233 /*************************************************************************/ 234 /* */ 235 /* <Struct> */ 236 /* FT_Glyph_Metrics */ 237 /* */ 238 /* <Description> */ 239 /* A structure used to model the metrics of a single glyph. The */ 240 /* values are expressed in 26.6 fractional pixel format; if the flag */ 241 /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */ 242 /* are expressed in font units instead. */ 243 /* */ 244 /* <Fields> */ 245 /* width :: */ 246 /* The glyph's width. */ 247 /* */ 248 /* height :: */ 249 /* The glyph's height. */ 250 /* */ 251 /* horiBearingX :: */ 252 /* Left side bearing for horizontal layout. */ 253 /* */ 254 /* horiBearingY :: */ 255 /* Top side bearing for horizontal layout. */ 256 /* */ 257 /* horiAdvance :: */ 258 /* Advance width for horizontal layout. */ 259 /* */ 260 /* vertBearingX :: */ 261 /* Left side bearing for vertical layout. */ 262 /* */ 263 /* vertBearingY :: */ 264 /* Top side bearing for vertical layout. Larger positive values */ 265 /* mean further below the vertical glyph origin. */ 266 /* */ 267 /* vertAdvance :: */ 268 /* Advance height for vertical layout. Positive values mean the */ 269 /* glyph has a positive advance downward. */ 270 /* */ 271 /* <Note> */ 272 /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */ 273 /* dimensions of the hinted glyph (in case hinting is applicable). */ 274 /* */ 275 /* Stroking a glyph with an outside border does not increase */ 276 /* `horiAdvance' or `vertAdvance'; you have to manually adjust these */ 277 /* values to account for the added width and height. */ 278 /* */ 279 typedef struct FT_Glyph_Metrics_ 280 { 281 FT_Pos width; 282 FT_Pos height; 283 284 FT_Pos horiBearingX; 285 FT_Pos horiBearingY; 286 FT_Pos horiAdvance; 287 288 FT_Pos vertBearingX; 289 FT_Pos vertBearingY; 290 FT_Pos vertAdvance; 291 292 } FT_Glyph_Metrics; 293 294 295 /*************************************************************************/ 296 /* */ 297 /* <Struct> */ 298 /* FT_Bitmap_Size */ 299 /* */ 300 /* <Description> */ 301 /* This structure models the metrics of a bitmap strike (i.e., a set */ 302 /* of glyphs for a given point size and resolution) in a bitmap font. */ 303 /* It is used for the `available_sizes' field of @FT_Face. */ 304 /* */ 305 /* <Fields> */ 306 /* height :: The vertical distance, in pixels, between two */ 307 /* consecutive baselines. It is always positive. */ 308 /* */ 309 /* width :: The average width, in pixels, of all glyphs in the */ 310 /* strike. */ 311 /* */ 312 /* size :: The nominal size of the strike in 26.6 fractional */ 313 /* points. This field is not very useful. */ 314 /* */ 315 /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */ 316 /* pixels. */ 317 /* */ 318 /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */ 319 /* pixels. */ 320 /* */ 321 /* <Note> */ 322 /* Windows FNT: */ 323 /* The nominal size given in a FNT font is not reliable. Thus when */ 324 /* the driver finds it incorrect, it sets `size' to some calculated */ 325 /* values and sets `x_ppem' and `y_ppem' to the pixel width and */ 326 /* height given in the font, respectively. */ 327 /* */ 328 /* TrueType embedded bitmaps: */ 329 /* `size', `width', and `height' values are not contained in the */ 330 /* bitmap strike itself. They are computed from the global font */ 331 /* parameters. */ 332 /* */ 333 typedef struct FT_Bitmap_Size_ 334 { 335 FT_Short height; 336 FT_Short width; 337 338 FT_Pos size; 339 340 FT_Pos x_ppem; 341 FT_Pos y_ppem; 342 343 } FT_Bitmap_Size; 344 345 346 /*************************************************************************/ 347 /*************************************************************************/ 348 /* */ 349 /* O B J E C T C L A S S E S */ 350 /* */ 351 /*************************************************************************/ 352 /*************************************************************************/ 353 354 /*************************************************************************/ 355 /* */ 356 /* <Type> */ 357 /* FT_Library */ 358 /* */ 359 /* <Description> */ 360 /* A handle to a FreeType library instance. Each `library' is */ 361 /* completely independent from the others; it is the `root' of a set */ 362 /* of objects like fonts, faces, sizes, etc. */ 363 /* */ 364 /* It also embeds a memory manager (see @FT_Memory), as well as a */ 365 /* scan-line converter object (see @FT_Raster). */ 366 /* */ 367 /* In multi-threaded applications, make sure that the same FT_Library */ 368 /* object or any of its children doesn't get accessed in parallel. */ 369 /* */ 370 /* <Note> */ 371 /* Library objects are normally created by @FT_Init_FreeType, and */ 372 /* destroyed with @FT_Done_FreeType. If you need reference-counting */ 373 /* (cf. @FT_Reference_Library), use @FT_New_Library and */ 374 /* @FT_Done_Library. */ 375 /* */ 376 typedef struct FT_LibraryRec_ *FT_Library; 377 378 379 /*************************************************************************/ 380 /* */ 381 /* <Type> */ 382 /* FT_Module */ 383 /* */ 384 /* <Description> */ 385 /* A handle to a given FreeType module object. Each module can be a */ 386 /* font driver, a renderer, or anything else that provides services */ 387 /* to the formers. */ 388 /* */ 389 typedef struct FT_ModuleRec_* FT_Module; 390 391 392 /*************************************************************************/ 393 /* */ 394 /* <Type> */ 395 /* FT_Driver */ 396 /* */ 397 /* <Description> */ 398 /* A handle to a given FreeType font driver object. Each font driver */ 399 /* is a special module capable of creating faces from font files. */ 400 /* */ 401 typedef struct FT_DriverRec_* FT_Driver; 402 403 404 /*************************************************************************/ 405 /* */ 406 /* <Type> */ 407 /* FT_Renderer */ 408 /* */ 409 /* <Description> */ 410 /* A handle to a given FreeType renderer. A renderer is a special */ 411 /* module in charge of converting a glyph image to a bitmap, when */ 412 /* necessary. Each renderer supports a given glyph image format, and */ 413 /* one or more target surface depths. */ 414 /* */ 415 typedef struct FT_RendererRec_* FT_Renderer; 416 417 418 /*************************************************************************/ 419 /* */ 420 /* <Type> */ 421 /* FT_Face */ 422 /* */ 423 /* <Description> */ 424 /* A handle to a given typographic face object. A face object models */ 425 /* a given typeface, in a given style. */ 426 /* */ 427 /* <Note> */ 428 /* Each face object also owns a single @FT_GlyphSlot object, as well */ 429 /* as one or more @FT_Size objects. */ 430 /* */ 431 /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */ 432 /* a given filepathname or a custom input stream. */ 433 /* */ 434 /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */ 435 /* */ 436 /* <Also> */ 437 /* See @FT_FaceRec for the publicly accessible fields of a given face */ 438 /* object. */ 439 /* */ 440 typedef struct FT_FaceRec_* FT_Face; 441 442 443 /*************************************************************************/ 444 /* */ 445 /* <Type> */ 446 /* FT_Size */ 447 /* */ 448 /* <Description> */ 449 /* A handle to an object used to model a face scaled to a given */ 450 /* character size. */ 451 /* */ 452 /* <Note> */ 453 /* Each @FT_Face has an _active_ @FT_Size object that is used by */ 454 /* functions like @FT_Load_Glyph to determine the scaling */ 455 /* transformation that in turn is used to load and hint glyphs and */ 456 /* metrics. */ 457 /* */ 458 /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */ 459 /* @FT_Request_Size or even @FT_Select_Size to change the content */ 460 /* (i.e., the scaling values) of the active @FT_Size. */ 461 /* */ 462 /* You can use @FT_New_Size to create additional size objects for a */ 463 /* given @FT_Face, but they won't be used by other functions until */ 464 /* you activate it through @FT_Activate_Size. Only one size can be */ 465 /* activated at any given time per face. */ 466 /* */ 467 /* <Also> */ 468 /* See @FT_SizeRec for the publicly accessible fields of a given size */ 469 /* object. */ 470 /* */ 471 typedef struct FT_SizeRec_* FT_Size; 472 473 474 /*************************************************************************/ 475 /* */ 476 /* <Type> */ 477 /* FT_GlyphSlot */ 478 /* */ 479 /* <Description> */ 480 /* A handle to a given `glyph slot'. A slot is a container where it */ 481 /* is possible to load any of the glyphs contained in its parent */ 482 /* face. */ 483 /* */ 484 /* In other words, each time you call @FT_Load_Glyph or */ 485 /* @FT_Load_Char, the slot's content is erased by the new glyph data, */ 486 /* i.e., the glyph's metrics, its image (bitmap or outline), and */ 487 /* other control information. */ 488 /* */ 489 /* <Also> */ 490 /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */ 491 /* */ 492 typedef struct FT_GlyphSlotRec_* FT_GlyphSlot; 493 494 495 /*************************************************************************/ 496 /* */ 497 /* <Type> */ 498 /* FT_CharMap */ 499 /* */ 500 /* <Description> */ 501 /* A handle to a given character map. A charmap is used to translate */ 502 /* character codes in a given encoding into glyph indexes for its */ 503 /* parent's face. Some font formats may provide several charmaps per */ 504 /* font. */ 505 /* */ 506 /* Each face object owns zero or more charmaps, but only one of them */ 507 /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */ 508 /* */ 509 /* The list of available charmaps in a face is available through the */ 510 /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */ 511 /* */ 512 /* The currently active charmap is available as `face->charmap'. */ 513 /* You should call @FT_Set_Charmap to change it. */ 514 /* */ 515 /* <Note> */ 516 /* When a new face is created (either through @FT_New_Face or */ 517 /* @FT_Open_Face), the library looks for a Unicode charmap within */ 518 /* the list and automatically activates it. */ 519 /* */ 520 /* <Also> */ 521 /* See @FT_CharMapRec for the publicly accessible fields of a given */ 522 /* character map. */ 523 /* */ 524 typedef struct FT_CharMapRec_* FT_CharMap; 525 526 527 /*************************************************************************/ 528 /* */ 529 /* <Macro> */ 530 /* FT_ENC_TAG */ 531 /* */ 532 /* <Description> */ 533 /* This macro converts four-letter tags into an unsigned long. It is */ 534 /* used to define `encoding' identifiers (see @FT_Encoding). */ 535 /* */ 536 /* <Note> */ 537 /* Since many 16-bit compilers don't like 32-bit enumerations, you */ 538 /* should redefine this macro in case of problems to something like */ 539 /* this: */ 540 /* */ 541 /* { */ 542 /* #define FT_ENC_TAG( value, a, b, c, d ) value */ 543 /* } */ 544 /* */ 545 /* to get a simple enumeration without assigning special numbers. */ 546 /* */ 547 548 #ifndef FT_ENC_TAG 549 #define FT_ENC_TAG( value, a, b, c, d ) \ 550 value = ( ( (FT_UInt32)(a) << 24 ) | \ 551 ( (FT_UInt32)(b) << 16 ) | \ 552 ( (FT_UInt32)(c) << 8 ) | \ 553 (FT_UInt32)(d) ) 554 555 #endif /* FT_ENC_TAG */ 556 557 558 /*************************************************************************/ 559 /* */ 560 /* <Enum> */ 561 /* FT_Encoding */ 562 /* */ 563 /* <Description> */ 564 /* An enumeration used to specify character sets supported by */ 565 /* charmaps. Used in the @FT_Select_Charmap API function. */ 566 /* */ 567 /* <Note> */ 568 /* Despite the name, this enumeration lists specific character */ 569 /* repertories (i.e., charsets), and not text encoding methods (e.g., */ 570 /* UTF-8, UTF-16, etc.). */ 571 /* */ 572 /* Other encodings might be defined in the future. */ 573 /* */ 574 /* <Values> */ 575 /* FT_ENCODING_NONE :: */ 576 /* The encoding value~0 is reserved. */ 577 /* */ 578 /* FT_ENCODING_UNICODE :: */ 579 /* Corresponds to the Unicode character set. This value covers */ 580 /* all versions of the Unicode repertoire, including ASCII and */ 581 /* Latin-1. Most fonts include a Unicode charmap, but not all */ 582 /* of them. */ 583 /* */ 584 /* For example, if you want to access Unicode value U+1F028 (and */ 585 /* the font contains it), use value 0x1F028 as the input value for */ 586 /* @FT_Get_Char_Index. */ 587 /* */ 588 /* FT_ENCODING_MS_SYMBOL :: */ 589 /* Corresponds to the Microsoft Symbol encoding, used to encode */ 590 /* mathematical symbols in the 32..255 character code range. For */ 591 /* more information, see */ 592 /* `http://www.kostis.net/charsets/symbol.htm'. */ 593 /* */ 594 /* FT_ENCODING_SJIS :: */ 595 /* Corresponds to Japanese SJIS encoding. More info at */ 596 /* at `http://en.wikipedia.org/wiki/Shift_JIS'. */ 597 /* See note on multi-byte encodings below. */ 598 /* */ 599 /* FT_ENCODING_GB2312 :: */ 600 /* Corresponds to an encoding system for Simplified Chinese as used */ 601 /* used in mainland China. */ 602 /* */ 603 /* FT_ENCODING_BIG5 :: */ 604 /* Corresponds to an encoding system for Traditional Chinese as */ 605 /* used in Taiwan and Hong Kong. */ 606 /* */ 607 /* FT_ENCODING_WANSUNG :: */ 608 /* Corresponds to the Korean encoding system known as Wansung. */ 609 /* For more information see */ 610 /* `http://msdn.microsoft.com/en-US/goglobal/cc305154'. */ 611 /* */ 612 /* FT_ENCODING_JOHAB :: */ 613 /* The Korean standard character set (KS~C 5601-1992), which */ 614 /* corresponds to MS Windows code page 1361. This character set */ 615 /* includes all possible Hangeul character combinations. */ 616 /* */ 617 /* FT_ENCODING_ADOBE_LATIN_1 :: */ 618 /* Corresponds to a Latin-1 encoding as defined in a Type~1 */ 619 /* PostScript font. It is limited to 256 character codes. */ 620 /* */ 621 /* FT_ENCODING_ADOBE_STANDARD :: */ 622 /* Corresponds to the Adobe Standard encoding, as found in Type~1, */ 623 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */ 624 /* codes. */ 625 /* */ 626 /* FT_ENCODING_ADOBE_EXPERT :: */ 627 /* Corresponds to the Adobe Expert encoding, as found in Type~1, */ 628 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */ 629 /* codes. */ 630 /* */ 631 /* FT_ENCODING_ADOBE_CUSTOM :: */ 632 /* Corresponds to a custom encoding, as found in Type~1, CFF, and */ 633 /* OpenType/CFF fonts. It is limited to 256 character codes. */ 634 /* */ 635 /* FT_ENCODING_APPLE_ROMAN :: */ 636 /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */ 637 /* and OpenType fonts contain a charmap for this encoding, since */ 638 /* older versions of Mac OS are able to use it. */ 639 /* */ 640 /* FT_ENCODING_OLD_LATIN_2 :: */ 641 /* This value is deprecated and was never used nor reported by */ 642 /* FreeType. Don't use or test for it. */ 643 /* */ 644 /* FT_ENCODING_MS_SJIS :: */ 645 /* Same as FT_ENCODING_SJIS. Deprecated. */ 646 /* */ 647 /* FT_ENCODING_MS_GB2312 :: */ 648 /* Same as FT_ENCODING_GB2312. Deprecated. */ 649 /* */ 650 /* FT_ENCODING_MS_BIG5 :: */ 651 /* Same as FT_ENCODING_BIG5. Deprecated. */ 652 /* */ 653 /* FT_ENCODING_MS_WANSUNG :: */ 654 /* Same as FT_ENCODING_WANSUNG. Deprecated. */ 655 /* */ 656 /* FT_ENCODING_MS_JOHAB :: */ 657 /* Same as FT_ENCODING_JOHAB. Deprecated. */ 658 /* */ 659 /* <Note> */ 660 /* By default, FreeType automatically synthesizes a Unicode charmap */ 661 /* for PostScript fonts, using their glyph names dictionaries. */ 662 /* However, it also reports the encodings defined explicitly in the */ 663 /* font file, for the cases when they are needed, with the Adobe */ 664 /* values as well. */ 665 /* */ 666 /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */ 667 /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */ 668 /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */ 669 /* which encoding is really present. If, for example, the */ 670 /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */ 671 /* the font is encoded in KOI8-R. */ 672 /* */ 673 /* FT_ENCODING_NONE is always set (with a single exception) by the */ 674 /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */ 675 /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */ 676 /* which encoding is really present. For example, */ 677 /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */ 678 /* Russian). */ 679 /* */ 680 /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */ 681 /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */ 682 /* FT_ENCODING_APPLE_ROMAN). */ 683 /* */ 684 /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */ 685 /* @FT_Get_CMap_Language_ID to query the Mac language ID that may */ 686 /* be needed to be able to distinguish Apple encoding variants. See */ 687 /* */ 688 /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt */ 689 /* */ 690 /* to get an idea how to do that. Basically, if the language ID */ 691 /* is~0, don't use it, otherwise subtract 1 from the language ID. */ 692 /* Then examine `encoding_id'. If, for example, `encoding_id' is */ 693 /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */ 694 /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */ 695 /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */ 696 /* variant the Arabic encoding. */ 697 /* */ 698 typedef enum FT_Encoding_ 699 { 700 FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ), 701 702 FT_ENC_TAG( FT_ENCODING_MS_SYMBOL, 's', 'y', 'm', 'b' ), 703 FT_ENC_TAG( FT_ENCODING_UNICODE, 'u', 'n', 'i', 'c' ), 704 705 FT_ENC_TAG( FT_ENCODING_SJIS, 's', 'j', 'i', 's' ), 706 FT_ENC_TAG( FT_ENCODING_GB2312, 'g', 'b', ' ', ' ' ), 707 FT_ENC_TAG( FT_ENCODING_BIG5, 'b', 'i', 'g', '5' ), 708 FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ), 709 FT_ENC_TAG( FT_ENCODING_JOHAB, 'j', 'o', 'h', 'a' ), 710 711 /* for backwards compatibility */ 712 FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS, 713 FT_ENCODING_MS_GB2312 = FT_ENCODING_GB2312, 714 FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5, 715 FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG, 716 FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB, 717 718 FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD, 'A', 'D', 'O', 'B' ), 719 FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT, 'A', 'D', 'B', 'E' ), 720 FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM, 'A', 'D', 'B', 'C' ), 721 FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1, 'l', 'a', 't', '1' ), 722 723 FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2, 'l', 'a', 't', '2' ), 724 725 FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' ) 726 727 } FT_Encoding; 728 729 730 /*************************************************************************/ 731 /* */ 732 /* <Enum> */ 733 /* ft_encoding_xxx */ 734 /* */ 735 /* <Description> */ 736 /* These constants are deprecated; use the corresponding @FT_Encoding */ 737 /* values instead. */ 738 /* */ 739 #define ft_encoding_none FT_ENCODING_NONE 740 #define ft_encoding_unicode FT_ENCODING_UNICODE 741 #define ft_encoding_symbol FT_ENCODING_MS_SYMBOL 742 #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1 743 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2 744 #define ft_encoding_sjis FT_ENCODING_SJIS 745 #define ft_encoding_gb2312 FT_ENCODING_GB2312 746 #define ft_encoding_big5 FT_ENCODING_BIG5 747 #define ft_encoding_wansung FT_ENCODING_WANSUNG 748 #define ft_encoding_johab FT_ENCODING_JOHAB 749 750 #define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD 751 #define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT 752 #define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM 753 #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN 754 755 756 /*************************************************************************/ 757 /* */ 758 /* <Struct> */ 759 /* FT_CharMapRec */ 760 /* */ 761 /* <Description> */ 762 /* The base charmap structure. */ 763 /* */ 764 /* <Fields> */ 765 /* face :: A handle to the parent face object. */ 766 /* */ 767 /* encoding :: An @FT_Encoding tag identifying the charmap. Use */ 768 /* this with @FT_Select_Charmap. */ 769 /* */ 770 /* platform_id :: An ID number describing the platform for the */ 771 /* following encoding ID. This comes directly from */ 772 /* the TrueType specification and should be emulated */ 773 /* for other formats. */ 774 /* */ 775 /* encoding_id :: A platform specific encoding number. This also */ 776 /* comes from the TrueType specification and should be */ 777 /* emulated similarly. */ 778 /* */ 779 typedef struct FT_CharMapRec_ 780 { 781 FT_Face face; 782 FT_Encoding encoding; 783 FT_UShort platform_id; 784 FT_UShort encoding_id; 785 786 } FT_CharMapRec; 787 788 789 /*************************************************************************/ 790 /*************************************************************************/ 791 /* */ 792 /* B A S E O B J E C T C L A S S E S */ 793 /* */ 794 /*************************************************************************/ 795 /*************************************************************************/ 796 797 798 /*************************************************************************/ 799 /* */ 800 /* <Type> */ 801 /* FT_Face_Internal */ 802 /* */ 803 /* <Description> */ 804 /* An opaque handle to an `FT_Face_InternalRec' structure, used to */ 805 /* model private data of a given @FT_Face object. */ 806 /* */ 807 /* This structure might change between releases of FreeType~2 and is */ 808 /* not generally available to client applications. */ 809 /* */ 810 typedef struct FT_Face_InternalRec_* FT_Face_Internal; 811 812 813 /*************************************************************************/ 814 /* */ 815 /* <Struct> */ 816 /* FT_FaceRec */ 817 /* */ 818 /* <Description> */ 819 /* FreeType root face class structure. A face object models a */ 820 /* typeface in a font file. */ 821 /* */ 822 /* <Fields> */ 823 /* num_faces :: The number of faces in the font file. Some */ 824 /* font formats can have multiple faces in */ 825 /* a font file. */ 826 /* */ 827 /* face_index :: The index of the face in the font file. It */ 828 /* is set to~0 if there is only one face in */ 829 /* the font file. */ 830 /* */ 831 /* face_flags :: A set of bit flags that give important */ 832 /* information about the face; see */ 833 /* @FT_FACE_FLAG_XXX for the details. */ 834 /* */ 835 /* style_flags :: A set of bit flags indicating the style of */ 836 /* the face; see @FT_STYLE_FLAG_XXX for the */ 837 /* details. */ 838 /* */ 839 /* num_glyphs :: The number of glyphs in the face. If the */ 840 /* face is scalable and has sbits (see */ 841 /* `num_fixed_sizes'), it is set to the number */ 842 /* of outline glyphs. */ 843 /* */ 844 /* For CID-keyed fonts, this value gives the */ 845 /* highest CID used in the font. */ 846 /* */ 847 /* family_name :: The face's family name. This is an ASCII */ 848 /* string, usually in English, that describes */ 849 /* the typeface's family (like `Times New */ 850 /* Roman', `Bodoni', `Garamond', etc). This */ 851 /* is a least common denominator used to list */ 852 /* fonts. Some formats (TrueType & OpenType) */ 853 /* provide localized and Unicode versions of */ 854 /* this string. Applications should use the */ 855 /* format specific interface to access them. */ 856 /* Can be NULL (e.g., in fonts embedded in a */ 857 /* PDF file). */ 858 /* */ 859 /* style_name :: The face's style name. This is an ASCII */ 860 /* string, usually in English, that describes */ 861 /* the typeface's style (like `Italic', */ 862 /* `Bold', `Condensed', etc). Not all font */ 863 /* formats provide a style name, so this field */ 864 /* is optional, and can be set to NULL. As */ 865 /* for `family_name', some formats provide */ 866 /* localized and Unicode versions of this */ 867 /* string. Applications should use the format */ 868 /* specific interface to access them. */ 869 /* */ 870 /* num_fixed_sizes :: The number of bitmap strikes in the face. */ 871 /* Even if the face is scalable, there might */ 872 /* still be bitmap strikes, which are called */ 873 /* `sbits' in that case. */ 874 /* */ 875 /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */ 876 /* strikes in the face. It is set to NULL if */ 877 /* there is no bitmap strike. */ 878 /* */ 879 /* num_charmaps :: The number of charmaps in the face. */ 880 /* */ 881 /* charmaps :: An array of the charmaps of the face. */ 882 /* */ 883 /* generic :: A field reserved for client uses. See the */ 884 /* @FT_Generic type description. */ 885 /* */ 886 /* bbox :: The font bounding box. Coordinates are */ 887 /* expressed in font units (see */ 888 /* `units_per_EM'). The box is large enough */ 889 /* to contain any glyph from the font. Thus, */ 890 /* `bbox.yMax' can be seen as the `maximum */ 891 /* ascender', and `bbox.yMin' as the `minimum */ 892 /* descender'. Only relevant for scalable */ 893 /* formats. */ 894 /* */ 895 /* Note that the bounding box might be off by */ 896 /* (at least) one pixel for hinted fonts. See */ 897 /* @FT_Size_Metrics for further discussion. */ 898 /* */ 899 /* units_per_EM :: The number of font units per EM square for */ 900 /* this face. This is typically 2048 for */ 901 /* TrueType fonts, and 1000 for Type~1 fonts. */ 902 /* Only relevant for scalable formats. */ 903 /* */ 904 /* ascender :: The typographic ascender of the face, */ 905 /* expressed in font units. For font formats */ 906 /* not having this information, it is set to */ 907 /* `bbox.yMax'. Only relevant for scalable */ 908 /* formats. */ 909 /* */ 910 /* descender :: The typographic descender of the face, */ 911 /* expressed in font units. For font formats */ 912 /* not having this information, it is set to */ 913 /* `bbox.yMin'. Note that this field is */ 914 /* usually negative. Only relevant for */ 915 /* scalable formats. */ 916 /* */ 917 /* height :: This value is the vertical distance */ 918 /* between two consecutive baselines, */ 919 /* expressed in font units. It is always */ 920 /* positive. Only relevant for scalable */ 921 /* formats. */ 922 /* */ 923 /* If you want the global glyph height, use */ 924 /* `ascender - descender'. */ 925 /* */ 926 /* max_advance_width :: The maximum advance width, in font units, */ 927 /* for all glyphs in this face. This can be */ 928 /* used to make word wrapping computations */ 929 /* faster. Only relevant for scalable */ 930 /* formats. */ 931 /* */ 932 /* max_advance_height :: The maximum advance height, in font units, */ 933 /* for all glyphs in this face. This is only */ 934 /* relevant for vertical layouts, and is set */ 935 /* to `height' for fonts that do not provide */ 936 /* vertical metrics. Only relevant for */ 937 /* scalable formats. */ 938 /* */ 939 /* underline_position :: The position, in font units, of the */ 940 /* underline line for this face. It is the */ 941 /* center of the underlining stem. Only */ 942 /* relevant for scalable formats. */ 943 /* */ 944 /* underline_thickness :: The thickness, in font units, of the */ 945 /* underline for this face. Only relevant for */ 946 /* scalable formats. */ 947 /* */ 948 /* glyph :: The face's associated glyph slot(s). */ 949 /* */ 950 /* size :: The current active size for this face. */ 951 /* */ 952 /* charmap :: The current active charmap for this face. */ 953 /* */ 954 /* <Note> */ 955 /* Fields may be changed after a call to @FT_Attach_File or */ 956 /* @FT_Attach_Stream. */ 957 /* */ 958 typedef struct FT_FaceRec_ 959 { 960 FT_Long num_faces; 961 FT_Long face_index; 962 963 FT_Long face_flags; 964 FT_Long style_flags; 965 966 FT_Long num_glyphs; 967 968 FT_String* family_name; 969 FT_String* style_name; 970 971 FT_Int num_fixed_sizes; 972 FT_Bitmap_Size* available_sizes; 973 974 FT_Int num_charmaps; 975 FT_CharMap* charmaps; 976 977 FT_Generic generic; 978 979 /*# The following member variables (down to `underline_thickness') */ 980 /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */ 981 /*# for bitmap fonts. */ 982 FT_BBox bbox; 983 984 FT_UShort units_per_EM; 985 FT_Short ascender; 986 FT_Short descender; 987 FT_Short height; 988 989 FT_Short max_advance_width; 990 FT_Short max_advance_height; 991 992 FT_Short underline_position; 993 FT_Short underline_thickness; 994 995 FT_GlyphSlot glyph; 996 FT_Size size; 997 FT_CharMap charmap; 998 999 /*@private begin */ 1000 1001 FT_Driver driver; 1002 FT_Memory memory; 1003 FT_Stream stream; 1004 1005 FT_ListRec sizes_list; 1006 1007 FT_Generic autohint; /* face-specific auto-hinter data */ 1008 void* extensions; /* unused */ 1009 1010 FT_Face_Internal internal; 1011 1012 /*@private end */ 1013 1014 } FT_FaceRec; 1015 1016 1017 /*************************************************************************/ 1018 /* */ 1019 /* <Enum> */ 1020 /* FT_FACE_FLAG_XXX */ 1021 /* */ 1022 /* <Description> */ 1023 /* A list of bit flags used in the `face_flags' field of the */ 1024 /* @FT_FaceRec structure. They inform client applications of */ 1025 /* properties of the corresponding face. */ 1026 /* */ 1027 /* <Values> */ 1028 /* FT_FACE_FLAG_SCALABLE :: */ 1029 /* Indicates that the face contains outline glyphs. This doesn't */ 1030 /* prevent bitmap strikes, i.e., a face can have both this and */ 1031 /* and @FT_FACE_FLAG_FIXED_SIZES set. */ 1032 /* */ 1033 /* FT_FACE_FLAG_FIXED_SIZES :: */ 1034 /* Indicates that the face contains bitmap strikes. See also the */ 1035 /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */ 1036 /* */ 1037 /* FT_FACE_FLAG_FIXED_WIDTH :: */ 1038 /* Indicates that the face contains fixed-width characters (like */ 1039 /* Courier, Lucido, MonoType, etc.). */ 1040 /* */ 1041 /* FT_FACE_FLAG_SFNT :: */ 1042 /* Indicates that the face uses the `sfnt' storage scheme. For */ 1043 /* now, this means TrueType and OpenType. */ 1044 /* */ 1045 /* FT_FACE_FLAG_HORIZONTAL :: */ 1046 /* Indicates that the face contains horizontal glyph metrics. This */ 1047 /* should be set for all common formats. */ 1048 /* */ 1049 /* FT_FACE_FLAG_VERTICAL :: */ 1050 /* Indicates that the face contains vertical glyph metrics. This */ 1051 /* is only available in some formats, not all of them. */ 1052 /* */ 1053 /* FT_FACE_FLAG_KERNING :: */ 1054 /* Indicates that the face contains kerning information. If set, */ 1055 /* the kerning distance can be retrieved through the function */ 1056 /* @FT_Get_Kerning. Otherwise the function always return the */ 1057 /* vector (0,0). Note that FreeType doesn't handle kerning data */ 1058 /* from the `GPOS' table (as present in some OpenType fonts). */ 1059 /* */ 1060 /* FT_FACE_FLAG_FAST_GLYPHS :: */ 1061 /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */ 1062 /* */ 1063 /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */ 1064 /* Indicates that the font contains multiple masters and is capable */ 1065 /* of interpolating between them. See the multiple-masters */ 1066 /* specific API for details. */ 1067 /* */ 1068 /* FT_FACE_FLAG_GLYPH_NAMES :: */ 1069 /* Indicates that the font contains glyph names that can be */ 1070 /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */ 1071 /* fonts contain broken glyph name tables. Use the function */ 1072 /* @FT_Has_PS_Glyph_Names when needed. */ 1073 /* */ 1074 /* FT_FACE_FLAG_EXTERNAL_STREAM :: */ 1075 /* Used internally by FreeType to indicate that a face's stream was */ 1076 /* provided by the client application and should not be destroyed */ 1077 /* when @FT_Done_Face is called. Don't read or test this flag. */ 1078 /* */ 1079 /* FT_FACE_FLAG_HINTER :: */ 1080 /* Set if the font driver has a hinting machine of its own. For */ 1081 /* example, with TrueType fonts, it makes sense to use data from */ 1082 /* the SFNT `gasp' table only if the native TrueType hinting engine */ 1083 /* (with the bytecode interpreter) is available and active. */ 1084 /* */ 1085 /* FT_FACE_FLAG_CID_KEYED :: */ 1086 /* Set if the font is CID-keyed. In that case, the font is not */ 1087 /* accessed by glyph indices but by CID values. For subsetted */ 1088 /* CID-keyed fonts this has the consequence that not all index */ 1089 /* values are a valid argument to FT_Load_Glyph. Only the CID */ 1090 /* values for which corresponding glyphs in the subsetted font */ 1091 /* exist make FT_Load_Glyph return successfully; in all other cases */ 1092 /* you get an `FT_Err_Invalid_Argument' error. */ 1093 /* */ 1094 /* Note that CID-keyed fonts that are in an SFNT wrapper don't */ 1095 /* have this flag set since the glyphs are accessed in the normal */ 1096 /* way (using contiguous indices); the `CID-ness' isn't visible to */ 1097 /* the application. */ 1098 /* */ 1099 /* FT_FACE_FLAG_TRICKY :: */ 1100 /* Set if the font is `tricky', this is, it always needs the */ 1101 /* font format's native hinting engine to get a reasonable result. */ 1102 /* A typical example is the Chinese font `mingli.ttf' that uses */ 1103 /* TrueType bytecode instructions to move and scale all of its */ 1104 /* subglyphs. */ 1105 /* */ 1106 /* It is not possible to autohint such fonts using */ 1107 /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */ 1108 /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */ 1109 /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */ 1110 /* probably never want this except for demonstration purposes. */ 1111 /* */ 1112 /* Currently, there are about a dozen TrueType fonts in the list of */ 1113 /* tricky fonts; they are hard-coded in file `ttobjs.c'. */ 1114 /* */ 1115 /* FT_FACE_FLAG_COLOR :: */ 1116 /* Set if the font has color glyph tables. To access color glyphs */ 1117 /* use @FT_LOAD_COLOR. */ 1118 /* */ 1119 #define FT_FACE_FLAG_SCALABLE ( 1L << 0 ) 1120 #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 ) 1121 #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 ) 1122 #define FT_FACE_FLAG_SFNT ( 1L << 3 ) 1123 #define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 ) 1124 #define FT_FACE_FLAG_VERTICAL ( 1L << 5 ) 1125 #define FT_FACE_FLAG_KERNING ( 1L << 6 ) 1126 #define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 ) 1127 #define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 ) 1128 #define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 ) 1129 #define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 ) 1130 #define FT_FACE_FLAG_HINTER ( 1L << 11 ) 1131 #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 ) 1132 #define FT_FACE_FLAG_TRICKY ( 1L << 13 ) 1133 #define FT_FACE_FLAG_COLOR ( 1L << 14 ) 1134 1135 1136 /************************************************************************* 1137 * 1138 * @macro: 1139 * FT_HAS_HORIZONTAL( face ) 1140 * 1141 * @description: 1142 * A macro that returns true whenever a face object contains 1143 * horizontal metrics (this is true for all font formats though). 1144 * 1145 * @also: 1146 * @FT_HAS_VERTICAL can be used to check for vertical metrics. 1147 * 1148 */ 1149 #define FT_HAS_HORIZONTAL( face ) \ 1150 ( face->face_flags & FT_FACE_FLAG_HORIZONTAL ) 1151 1152 1153 /************************************************************************* 1154 * 1155 * @macro: 1156 * FT_HAS_VERTICAL( face ) 1157 * 1158 * @description: 1159 * A macro that returns true whenever a face object contains real 1160 * vertical metrics (and not only synthesized ones). 1161 * 1162 */ 1163 #define FT_HAS_VERTICAL( face ) \ 1164 ( face->face_flags & FT_FACE_FLAG_VERTICAL ) 1165 1166 1167 /************************************************************************* 1168 * 1169 * @macro: 1170 * FT_HAS_KERNING( face ) 1171 * 1172 * @description: 1173 * A macro that returns true whenever a face object contains kerning 1174 * data that can be accessed with @FT_Get_Kerning. 1175 * 1176 */ 1177 #define FT_HAS_KERNING( face ) \ 1178 ( face->face_flags & FT_FACE_FLAG_KERNING ) 1179 1180 1181 /************************************************************************* 1182 * 1183 * @macro: 1184 * FT_IS_SCALABLE( face ) 1185 * 1186 * @description: 1187 * A macro that returns true whenever a face object contains a scalable 1188 * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF, 1189 * and PFR font formats. 1190 * 1191 */ 1192 #define FT_IS_SCALABLE( face ) \ 1193 ( face->face_flags & FT_FACE_FLAG_SCALABLE ) 1194 1195 1196 /************************************************************************* 1197 * 1198 * @macro: 1199 * FT_IS_SFNT( face ) 1200 * 1201 * @description: 1202 * A macro that returns true whenever a face object contains a font 1203 * whose format is based on the SFNT storage scheme. This usually 1204 * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded 1205 * bitmap fonts. 1206 * 1207 * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and 1208 * @FT_TRUETYPE_TABLES_H are available. 1209 * 1210 */ 1211 #define FT_IS_SFNT( face ) \ 1212 ( face->face_flags & FT_FACE_FLAG_SFNT ) 1213 1214 1215 /************************************************************************* 1216 * 1217 * @macro: 1218 * FT_IS_FIXED_WIDTH( face ) 1219 * 1220 * @description: 1221 * A macro that returns true whenever a face object contains a font face 1222 * that contains fixed-width (or `monospace', `fixed-pitch', etc.) 1223 * glyphs. 1224 * 1225 */ 1226 #define FT_IS_FIXED_WIDTH( face ) \ 1227 ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH ) 1228 1229 1230 /************************************************************************* 1231 * 1232 * @macro: 1233 * FT_HAS_FIXED_SIZES( face ) 1234 * 1235 * @description: 1236 * A macro that returns true whenever a face object contains some 1237 * embedded bitmaps. See the `available_sizes' field of the 1238 * @FT_FaceRec structure. 1239 * 1240 */ 1241 #define FT_HAS_FIXED_SIZES( face ) \ 1242 ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES ) 1243 1244 1245 /************************************************************************* 1246 * 1247 * @macro: 1248 * FT_HAS_FAST_GLYPHS( face ) 1249 * 1250 * @description: 1251 * Deprecated. 1252 * 1253 */ 1254 #define FT_HAS_FAST_GLYPHS( face ) 0 1255 1256 1257 /************************************************************************* 1258 * 1259 * @macro: 1260 * FT_HAS_GLYPH_NAMES( face ) 1261 * 1262 * @description: 1263 * A macro that returns true whenever a face object contains some glyph 1264 * names that can be accessed through @FT_Get_Glyph_Name. 1265 * 1266 */ 1267 #define FT_HAS_GLYPH_NAMES( face ) \ 1268 ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES ) 1269 1270 1271 /************************************************************************* 1272 * 1273 * @macro: 1274 * FT_HAS_MULTIPLE_MASTERS( face ) 1275 * 1276 * @description: 1277 * A macro that returns true whenever a face object contains some 1278 * multiple masters. The functions provided by @FT_MULTIPLE_MASTERS_H 1279 * are then available to choose the exact design you want. 1280 * 1281 */ 1282 #define FT_HAS_MULTIPLE_MASTERS( face ) \ 1283 ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS ) 1284 1285 1286 /************************************************************************* 1287 * 1288 * @macro: 1289 * FT_IS_CID_KEYED( face ) 1290 * 1291 * @description: 1292 * A macro that returns true whenever a face object contains a CID-keyed 1293 * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more 1294 * details. 1295 * 1296 * If this macro is true, all functions defined in @FT_CID_H are 1297 * available. 1298 * 1299 */ 1300 #define FT_IS_CID_KEYED( face ) \ 1301 ( face->face_flags & FT_FACE_FLAG_CID_KEYED ) 1302 1303 1304 /************************************************************************* 1305 * 1306 * @macro: 1307 * FT_IS_TRICKY( face ) 1308 * 1309 * @description: 1310 * A macro that returns true whenever a face represents a `tricky' font. 1311 * See the discussion of @FT_FACE_FLAG_TRICKY for more details. 1312 * 1313 */ 1314 #define FT_IS_TRICKY( face ) \ 1315 ( face->face_flags & FT_FACE_FLAG_TRICKY ) 1316 1317 1318 /************************************************************************* 1319 * 1320 * @macro: 1321 * FT_HAS_COLOR( face ) 1322 * 1323 * @description: 1324 * A macro that returns true whenever a face object contains 1325 * tables for color glyphs. 1326 * 1327 */ 1328 #define FT_HAS_COLOR( face ) \ 1329 ( face->face_flags & FT_FACE_FLAG_COLOR ) 1330 1331 1332 /*************************************************************************/ 1333 /* */ 1334 /* <Const> */ 1335 /* FT_STYLE_FLAG_XXX */ 1336 /* */ 1337 /* <Description> */ 1338 /* A list of bit-flags used to indicate the style of a given face. */ 1339 /* These are used in the `style_flags' field of @FT_FaceRec. */ 1340 /* */ 1341 /* <Values> */ 1342 /* FT_STYLE_FLAG_ITALIC :: */ 1343 /* Indicates that a given face style is italic or oblique. */ 1344 /* */ 1345 /* FT_STYLE_FLAG_BOLD :: */ 1346 /* Indicates that a given face is bold. */ 1347 /* */ 1348 /* <Note> */ 1349 /* The style information as provided by FreeType is very basic. More */ 1350 /* details are beyond the scope and should be done on a higher level */ 1351 /* (for example, by analyzing various fields of the `OS/2' table in */ 1352 /* SFNT based fonts). */ 1353 /* */ 1354 #define FT_STYLE_FLAG_ITALIC ( 1 << 0 ) 1355 #define FT_STYLE_FLAG_BOLD ( 1 << 1 ) 1356 1357 1358 /*************************************************************************/ 1359 /* */ 1360 /* <Type> */ 1361 /* FT_Size_Internal */ 1362 /* */ 1363 /* <Description> */ 1364 /* An opaque handle to an `FT_Size_InternalRec' structure, used to */ 1365 /* model private data of a given @FT_Size object. */ 1366 /* */ 1367 typedef struct FT_Size_InternalRec_* FT_Size_Internal; 1368 1369 1370 /*************************************************************************/ 1371 /* */ 1372 /* <Struct> */ 1373 /* FT_Size_Metrics */ 1374 /* */ 1375 /* <Description> */ 1376 /* The size metrics structure gives the metrics of a size object. */ 1377 /* */ 1378 /* <Fields> */ 1379 /* x_ppem :: The width of the scaled EM square in pixels, hence */ 1380 /* the term `ppem' (pixels per EM). It is also */ 1381 /* referred to as `nominal width'. */ 1382 /* */ 1383 /* y_ppem :: The height of the scaled EM square in pixels, */ 1384 /* hence the term `ppem' (pixels per EM). It is also */ 1385 /* referred to as `nominal height'. */ 1386 /* */ 1387 /* x_scale :: A 16.16 fractional scaling value used to convert */ 1388 /* horizontal metrics from font units to 26.6 */ 1389 /* fractional pixels. Only relevant for scalable */ 1390 /* font formats. */ 1391 /* */ 1392 /* y_scale :: A 16.16 fractional scaling value used to convert */ 1393 /* vertical metrics from font units to 26.6 */ 1394 /* fractional pixels. Only relevant for scalable */ 1395 /* font formats. */ 1396 /* */ 1397 /* ascender :: The ascender in 26.6 fractional pixels. See */ 1398 /* @FT_FaceRec for the details. */ 1399 /* */ 1400 /* descender :: The descender in 26.6 fractional pixels. See */ 1401 /* @FT_FaceRec for the details. */ 1402 /* */ 1403 /* height :: The height in 26.6 fractional pixels. See */ 1404 /* @FT_FaceRec for the details. */ 1405 /* */ 1406 /* max_advance :: The maximum advance width in 26.6 fractional */ 1407 /* pixels. See @FT_FaceRec for the details. */ 1408 /* */ 1409 /* <Note> */ 1410 /* The scaling values, if relevant, are determined first during a */ 1411 /* size changing operation. The remaining fields are then set by the */ 1412 /* driver. For scalable formats, they are usually set to scaled */ 1413 /* values of the corresponding fields in @FT_FaceRec. */ 1414 /* */ 1415 /* Note that due to glyph hinting, these values might not be exact */ 1416 /* for certain fonts. Thus they must be treated as unreliable */ 1417 /* with an error margin of at least one pixel! */ 1418 /* */ 1419 /* Indeed, the only way to get the exact metrics is to render _all_ */ 1420 /* glyphs. As this would be a definite performance hit, it is up to */ 1421 /* client applications to perform such computations. */ 1422 /* */ 1423 /* The FT_Size_Metrics structure is valid for bitmap fonts also. */ 1424 /* */ 1425 typedef struct FT_Size_Metrics_ 1426 { 1427 FT_UShort x_ppem; /* horizontal pixels per EM */ 1428 FT_UShort y_ppem; /* vertical pixels per EM */ 1429 1430 FT_Fixed x_scale; /* scaling values used to convert font */ 1431 FT_Fixed y_scale; /* units to 26.6 fractional pixels */ 1432 1433 FT_Pos ascender; /* ascender in 26.6 frac. pixels */ 1434 FT_Pos descender; /* descender in 26.6 frac. pixels */ 1435 FT_Pos height; /* text height in 26.6 frac. pixels */ 1436 FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */ 1437 1438 } FT_Size_Metrics; 1439 1440 1441 /*************************************************************************/ 1442 /* */ 1443 /* <Struct> */ 1444 /* FT_SizeRec */ 1445 /* */ 1446 /* <Description> */ 1447 /* FreeType root size class structure. A size object models a face */ 1448 /* object at a given size. */ 1449 /* */ 1450 /* <Fields> */ 1451 /* face :: Handle to the parent face object. */ 1452 /* */ 1453 /* generic :: A typeless pointer, unused by the FreeType library or */ 1454 /* any of its drivers. It can be used by client */ 1455 /* applications to link their own data to each size */ 1456 /* object. */ 1457 /* */ 1458 /* metrics :: Metrics for this size object. This field is read-only. */ 1459 /* */ 1460 typedef struct FT_SizeRec_ 1461 { 1462 FT_Face face; /* parent face object */ 1463 FT_Generic generic; /* generic pointer for client uses */ 1464 FT_Size_Metrics metrics; /* size metrics */ 1465 FT_Size_Internal internal; 1466 1467 } FT_SizeRec; 1468 1469 1470 /*************************************************************************/ 1471 /* */ 1472 /* <Struct> */ 1473 /* FT_SubGlyph */ 1474 /* */ 1475 /* <Description> */ 1476 /* The subglyph structure is an internal object used to describe */ 1477 /* subglyphs (for example, in the case of composites). */ 1478 /* */ 1479 /* <Note> */ 1480 /* The subglyph implementation is not part of the high-level API, */ 1481 /* hence the forward structure declaration. */ 1482 /* */ 1483 /* You can however retrieve subglyph information with */ 1484 /* @FT_Get_SubGlyph_Info. */ 1485 /* */ 1486 typedef struct FT_SubGlyphRec_* FT_SubGlyph; 1487 1488 1489 /*************************************************************************/ 1490 /* */ 1491 /* <Type> */ 1492 /* FT_Slot_Internal */ 1493 /* */ 1494 /* <Description> */ 1495 /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */ 1496 /* model private data of a given @FT_GlyphSlot object. */ 1497 /* */ 1498 typedef struct FT_Slot_InternalRec_* FT_Slot_Internal; 1499 1500 1501 /*************************************************************************/ 1502 /* */ 1503 /* <Struct> */ 1504 /* FT_GlyphSlotRec */ 1505 /* */ 1506 /* <Description> */ 1507 /* FreeType root glyph slot class structure. A glyph slot is a */ 1508 /* container where individual glyphs can be loaded, be they in */ 1509 /* outline or bitmap format. */ 1510 /* */ 1511 /* <Fields> */ 1512 /* library :: A handle to the FreeType library instance */ 1513 /* this slot belongs to. */ 1514 /* */ 1515 /* face :: A handle to the parent face object. */ 1516 /* */ 1517 /* next :: In some cases (like some font tools), several */ 1518 /* glyph slots per face object can be a good */ 1519 /* thing. As this is rare, the glyph slots are */ 1520 /* listed through a direct, single-linked list */ 1521 /* using its `next' field. */ 1522 /* */ 1523 /* generic :: A typeless pointer unused by the FreeType */ 1524 /* library or any of its drivers. It can be */ 1525 /* used by client applications to link their own */ 1526 /* data to each glyph slot object. */ 1527 /* */ 1528 /* metrics :: The metrics of the last loaded glyph in the */ 1529 /* slot. The returned values depend on the last */ 1530 /* load flags (see the @FT_Load_Glyph API */ 1531 /* function) and can be expressed either in 26.6 */ 1532 /* fractional pixels or font units. */ 1533 /* */ 1534 /* Note that even when the glyph image is */ 1535 /* transformed, the metrics are not. */ 1536 /* */ 1537 /* linearHoriAdvance :: The advance width of the unhinted glyph. */ 1538 /* Its value is expressed in 16.16 fractional */ 1539 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */ 1540 /* when loading the glyph. This field can be */ 1541 /* important to perform correct WYSIWYG layout. */ 1542 /* Only relevant for outline glyphs. */ 1543 /* */ 1544 /* linearVertAdvance :: The advance height of the unhinted glyph. */ 1545 /* Its value is expressed in 16.16 fractional */ 1546 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */ 1547 /* when loading the glyph. This field can be */ 1548 /* important to perform correct WYSIWYG layout. */ 1549 /* Only relevant for outline glyphs. */ 1550 /* */ 1551 /* advance :: This shorthand is, depending on */ 1552 /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */ 1553 /* (hinted) advance width for the glyph, in 26.6 */ 1554 /* fractional pixel format. As specified with */ 1555 /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */ 1556 /* `horiAdvance' or the `vertAdvance' value of */ 1557 /* `metrics' field. */ 1558 /* */ 1559 /* format :: This field indicates the format of the image */ 1560 /* contained in the glyph slot. Typically */ 1561 /* @FT_GLYPH_FORMAT_BITMAP, */ 1562 /* @FT_GLYPH_FORMAT_OUTLINE, or */ 1563 /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */ 1564 /* possible. */ 1565 /* */ 1566 /* bitmap :: This field is used as a bitmap descriptor */ 1567 /* when the slot format is */ 1568 /* @FT_GLYPH_FORMAT_BITMAP. Note that the */ 1569 /* address and content of the bitmap buffer can */ 1570 /* change between calls of @FT_Load_Glyph and a */ 1571 /* few other functions. */ 1572 /* */ 1573 /* bitmap_left :: This is the bitmap's left bearing expressed */ 1574 /* in integer pixels. Of course, this is only */ 1575 /* valid if the format is */ 1576 /* @FT_GLYPH_FORMAT_BITMAP. */ 1577 /* */ 1578 /* bitmap_top :: This is the bitmap's top bearing expressed in */ 1579 /* integer pixels. Remember that this is the */ 1580 /* distance from the baseline to the top-most */ 1581 /* glyph scanline, upwards y~coordinates being */ 1582 /* *positive*. */ 1583 /* */ 1584 /* outline :: The outline descriptor for the current glyph */ 1585 /* image if its format is */ 1586 /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */ 1587 /* loaded, `outline' can be transformed, */ 1588 /* distorted, embolded, etc. However, it must */ 1589 /* not be freed. */ 1590 /* */ 1591 /* num_subglyphs :: The number of subglyphs in a composite glyph. */ 1592 /* This field is only valid for the composite */ 1593 /* glyph format that should normally only be */ 1594 /* loaded with the @FT_LOAD_NO_RECURSE flag. */ 1595 /* */ 1596 /* subglyphs :: An array of subglyph descriptors for */ 1597 /* composite glyphs. There are `num_subglyphs' */ 1598 /* elements in there. Currently internal to */ 1599 /* FreeType. */ 1600 /* */ 1601 /* control_data :: Certain font drivers can also return the */ 1602 /* control data for a given glyph image (e.g. */ 1603 /* TrueType bytecode, Type~1 charstrings, etc.). */ 1604 /* This field is a pointer to such data. */ 1605 /* */ 1606 /* control_len :: This is the length in bytes of the control */ 1607 /* data. */ 1608 /* */ 1609 /* other :: Really wicked formats can use this pointer to */ 1610 /* present their own glyph image to client */ 1611 /* applications. Note that the application */ 1612 /* needs to know about the image format. */ 1613 /* */ 1614 /* lsb_delta :: The difference between hinted and unhinted */ 1615 /* left side bearing while autohinting is */ 1616 /* active. Zero otherwise. */ 1617 /* */ 1618 /* rsb_delta :: The difference between hinted and unhinted */ 1619 /* right side bearing while autohinting is */ 1620 /* active. Zero otherwise. */ 1621 /* */ 1622 /* <Note> */ 1623 /* If @FT_Load_Glyph is called with default flags (see */ 1624 /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */ 1625 /* its native format (e.g., an outline glyph for TrueType and Type~1 */ 1626 /* formats). */ 1627 /* */ 1628 /* This image can later be converted into a bitmap by calling */ 1629 /* @FT_Render_Glyph. This function finds the current renderer for */ 1630 /* the native image's format, then invokes it. */ 1631 /* */ 1632 /* The renderer is in charge of transforming the native image through */ 1633 /* the slot's face transformation fields, then converting it into a */ 1634 /* bitmap that is returned in `slot->bitmap'. */ 1635 /* */ 1636 /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */ 1637 /* to specify the position of the bitmap relative to the current pen */ 1638 /* position (e.g., coordinates (0,0) on the baseline). Of course, */ 1639 /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */ 1640 /* */ 1641 /* <Note> */ 1642 /* Here a small pseudo code fragment that shows how to use */ 1643 /* `lsb_delta' and `rsb_delta': */ 1644 /* */ 1645 /* { */ 1646 /* FT_Pos origin_x = 0; */ 1647 /* FT_Pos prev_rsb_delta = 0; */ 1648 /* */ 1649 /* */ 1650 /* for all glyphs do */ 1651 /* <compute kern between current and previous glyph and add it to */ 1652 /* `origin_x'> */ 1653 /* */ 1654 /* <load glyph with `FT_Load_Glyph'> */ 1655 /* */ 1656 /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */ 1657 /* origin_x -= 64; */ 1658 /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */ 1659 /* origin_x += 64; */ 1660 /* */ 1661 /* prev_rsb_delta = face->glyph->rsb_delta; */ 1662 /* */ 1663 /* <save glyph image, or render glyph, or ...> */ 1664 /* */ 1665 /* origin_x += face->glyph->advance.x; */ 1666 /* endfor */ 1667 /* } */ 1668 /* */ 1669 typedef struct FT_GlyphSlotRec_ 1670 { 1671 FT_Library library; 1672 FT_Face face; 1673 FT_GlyphSlot next; 1674 FT_UInt reserved; /* retained for binary compatibility */ 1675 FT_Generic generic; 1676 1677 FT_Glyph_Metrics metrics; 1678 FT_Fixed linearHoriAdvance; 1679 FT_Fixed linearVertAdvance; 1680 FT_Vector advance; 1681 1682 FT_Glyph_Format format; 1683 1684 FT_Bitmap bitmap; 1685 FT_Int bitmap_left; 1686 FT_Int bitmap_top; 1687 1688 FT_Outline outline; 1689 1690 FT_UInt num_subglyphs; 1691 FT_SubGlyph subglyphs; 1692 1693 void* control_data; 1694 long control_len; 1695 1696 FT_Pos lsb_delta; 1697 FT_Pos rsb_delta; 1698 1699 void* other; 1700 1701 FT_Slot_Internal internal; 1702 1703 } FT_GlyphSlotRec; 1704 1705 1706 /*************************************************************************/ 1707 /*************************************************************************/ 1708 /* */ 1709 /* F U N C T I O N S */ 1710 /* */ 1711 /*************************************************************************/ 1712 /*************************************************************************/ 1713 1714 1715 /*************************************************************************/ 1716 /* */ 1717 /* <Function> */ 1718 /* FT_Init_FreeType */ 1719 /* */ 1720 /* <Description> */ 1721 /* Initialize a new FreeType library object. The set of modules */ 1722 /* that are registered by this function is determined at build time. */ 1723 /* */ 1724 /* <Output> */ 1725 /* alibrary :: A handle to a new library object. */ 1726 /* */ 1727 /* <Return> */ 1728 /* FreeType error code. 0~means success. */ 1729 /* */ 1730 /* <Note> */ 1731 /* In case you want to provide your own memory allocating routines, */ 1732 /* use @FT_New_Library instead, followed by a call to */ 1733 /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */ 1734 /* */ 1735 /* For multi-threading applications each thread should have its own */ 1736 /* FT_Library object. */ 1737 /* */ 1738 /* If you need reference-counting (cf. @FT_Reference_Library), use */ 1739 /* @FT_New_Library and @FT_Done_Library. */ 1740 /* */ 1741 FT_EXPORT( FT_Error ) 1742 FT_Init_FreeType( FT_Library *alibrary ); 1743 1744 1745 /*************************************************************************/ 1746 /* */ 1747 /* <Function> */ 1748 /* FT_Done_FreeType */ 1749 /* */ 1750 /* <Description> */ 1751 /* Destroy a given FreeType library object and all of its children, */ 1752 /* including resources, drivers, faces, sizes, etc. */ 1753 /* */ 1754 /* <Input> */ 1755 /* library :: A handle to the target library object. */ 1756 /* */ 1757 /* <Return> */ 1758 /* FreeType error code. 0~means success. */ 1759 /* */ 1760 FT_EXPORT( FT_Error ) 1761 FT_Done_FreeType( FT_Library library ); 1762 1763 1764 /*************************************************************************/ 1765 /* */ 1766 /* <Enum> */ 1767 /* FT_OPEN_XXX */ 1768 /* */ 1769 /* <Description> */ 1770 /* A list of bit-field constants used within the `flags' field of the */ 1771 /* @FT_Open_Args structure. */ 1772 /* */ 1773 /* <Values> */ 1774 /* FT_OPEN_MEMORY :: This is a memory-based stream. */ 1775 /* */ 1776 /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */ 1777 /* */ 1778 /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */ 1779 /* name. */ 1780 /* */ 1781 /* FT_OPEN_DRIVER :: Use the `driver' field. */ 1782 /* */ 1783 /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */ 1784 /* */ 1785 /* ft_open_memory :: Deprecated; use @FT_OPEN_MEMORY instead. */ 1786 /* */ 1787 /* ft_open_stream :: Deprecated; use @FT_OPEN_STREAM instead. */ 1788 /* */ 1789 /* ft_open_pathname :: Deprecated; use @FT_OPEN_PATHNAME instead. */ 1790 /* */ 1791 /* ft_open_driver :: Deprecated; use @FT_OPEN_DRIVER instead. */ 1792 /* */ 1793 /* ft_open_params :: Deprecated; use @FT_OPEN_PARAMS instead. */ 1794 /* */ 1795 /* <Note> */ 1796 /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */ 1797 /* flags are mutually exclusive. */ 1798 /* */ 1799 #define FT_OPEN_MEMORY 0x1 1800 #define FT_OPEN_STREAM 0x2 1801 #define FT_OPEN_PATHNAME 0x4 1802 #define FT_OPEN_DRIVER 0x8 1803 #define FT_OPEN_PARAMS 0x10 1804 1805 #define ft_open_memory FT_OPEN_MEMORY /* deprecated */ 1806 #define ft_open_stream FT_OPEN_STREAM /* deprecated */ 1807 #define ft_open_pathname FT_OPEN_PATHNAME /* deprecated */ 1808 #define ft_open_driver FT_OPEN_DRIVER /* deprecated */ 1809 #define ft_open_params FT_OPEN_PARAMS /* deprecated */ 1810 1811 1812 /*************************************************************************/ 1813 /* */ 1814 /* <Struct> */ 1815 /* FT_Parameter */ 1816 /* */ 1817 /* <Description> */ 1818 /* A simple structure used to pass more or less generic parameters to */ 1819 /* @FT_Open_Face. */ 1820 /* */ 1821 /* <Fields> */ 1822 /* tag :: A four-byte identification tag. */ 1823 /* */ 1824 /* data :: A pointer to the parameter data. */ 1825 /* */ 1826 /* <Note> */ 1827 /* The ID and function of parameters are driver-specific. See the */ 1828 /* various FT_PARAM_TAG_XXX flags for more information. */ 1829 /* */ 1830 typedef struct FT_Parameter_ 1831 { 1832 FT_ULong tag; 1833 FT_Pointer data; 1834 1835 } FT_Parameter; 1836 1837 1838 /*************************************************************************/ 1839 /* */ 1840 /* <Struct> */ 1841 /* FT_Open_Args */ 1842 /* */ 1843 /* <Description> */ 1844 /* A structure used to indicate how to open a new font file or */ 1845 /* stream. A pointer to such a structure can be used as a parameter */ 1846 /* for the functions @FT_Open_Face and @FT_Attach_Stream. */ 1847 /* */ 1848 /* <Fields> */ 1849 /* flags :: A set of bit flags indicating how to use the */ 1850 /* structure. */ 1851 /* */ 1852 /* memory_base :: The first byte of the file in memory. */ 1853 /* */ 1854 /* memory_size :: The size in bytes of the file in memory. */ 1855 /* */ 1856 /* pathname :: A pointer to an 8-bit file pathname. */ 1857 /* */ 1858 /* stream :: A handle to a source stream object. */ 1859 /* */ 1860 /* driver :: This field is exclusively used by @FT_Open_Face; */ 1861 /* it simply specifies the font driver to use to open */ 1862 /* the face. If set to~0, FreeType tries to load the */ 1863 /* face with each one of the drivers in its list. */ 1864 /* */ 1865 /* num_params :: The number of extra parameters. */ 1866 /* */ 1867 /* params :: Extra parameters passed to the font driver when */ 1868 /* opening a new face. */ 1869 /* */ 1870 /* <Note> */ 1871 /* The stream type is determined by the contents of `flags' that */ 1872 /* are tested in the following order by @FT_Open_Face: */ 1873 /* */ 1874 /* If the `FT_OPEN_MEMORY' bit is set, assume that this is a */ 1875 /* memory file of `memory_size' bytes, located at `memory_address'. */ 1876 /* The data are are not copied, and the client is responsible for */ 1877 /* releasing and destroying them _after_ the corresponding call to */ 1878 /* @FT_Done_Face. */ 1879 /* */ 1880 /* Otherwise, if the `FT_OPEN_STREAM' bit is set, assume that a */ 1881 /* custom input stream `stream' is used. */ 1882 /* */ 1883 /* Otherwise, if the `FT_OPEN_PATHNAME' bit is set, assume that this */ 1884 /* is a normal file and use `pathname' to open it. */ 1885 /* */ 1886 /* If the `FT_OPEN_DRIVER' bit is set, @FT_Open_Face only tries to */ 1887 /* open the file with the driver whose handler is in `driver'. */ 1888 /* */ 1889 /* If the `FT_OPEN_PARAMS' bit is set, the parameters given by */ 1890 /* `num_params' and `params' is used. They are ignored otherwise. */ 1891 /* */ 1892 /* Ideally, both the `pathname' and `params' fields should be tagged */ 1893 /* as `const'; this is missing for API backwards compatibility. In */ 1894 /* other words, applications should treat them as read-only. */ 1895 /* */ 1896 typedef struct FT_Open_Args_ 1897 { 1898 FT_UInt flags; 1899 const FT_Byte* memory_base; 1900 FT_Long memory_size; 1901 FT_String* pathname; 1902 FT_Stream stream; 1903 FT_Module driver; 1904 FT_Int num_params; 1905 FT_Parameter* params; 1906 1907 } FT_Open_Args; 1908 1909 1910 /*************************************************************************/ 1911 /* */ 1912 /* <Function> */ 1913 /* FT_New_Face */ 1914 /* */ 1915 /* <Description> */ 1916 /* This function calls @FT_Open_Face to open a font by its pathname. */ 1917 /* */ 1918 /* <InOut> */ 1919 /* library :: A handle to the library resource. */ 1920 /* */ 1921 /* <Input> */ 1922 /* pathname :: A path to the font file. */ 1923 /* */ 1924 /* face_index :: The index of the face within the font. The first */ 1925 /* face has index~0. */ 1926 /* */ 1927 /* <Output> */ 1928 /* aface :: A handle to a new face object. If `face_index' is */ 1929 /* greater than or equal to zero, it must be non-NULL. */ 1930 /* See @FT_Open_Face for more details. */ 1931 /* */ 1932 /* <Return> */ 1933 /* FreeType error code. 0~means success. */ 1934 /* */ 1935 /* <Note> */ 1936 /* Use @FT_Done_Face to destroy the created @FT_Face object (along */ 1937 /* with its slot and sizes). */ 1938 /* */ 1939 FT_EXPORT( FT_Error ) 1940 FT_New_Face( FT_Library library, 1941 const char* filepathname, 1942 FT_Long face_index, 1943 FT_Face *aface ); 1944 1945 1946 /*************************************************************************/ 1947 /* */ 1948 /* <Function> */ 1949 /* FT_New_Memory_Face */ 1950 /* */ 1951 /* <Description> */ 1952 /* This function calls @FT_Open_Face to open a font that has been */ 1953 /* loaded into memory. */ 1954 /* */ 1955 /* <InOut> */ 1956 /* library :: A handle to the library resource. */ 1957 /* */ 1958 /* <Input> */ 1959 /* file_base :: A pointer to the beginning of the font data. */ 1960 /* */ 1961 /* file_size :: The size of the memory chunk used by the font data. */ 1962 /* */ 1963 /* face_index :: The index of the face within the font. The first */ 1964 /* face has index~0. */ 1965 /* */ 1966 /* <Output> */ 1967 /* aface :: A handle to a new face object. If `face_index' is */ 1968 /* greater than or equal to zero, it must be non-NULL. */ 1969 /* See @FT_Open_Face for more details. */ 1970 /* */ 1971 /* <Return> */ 1972 /* FreeType error code. 0~means success. */ 1973 /* */ 1974 /* <Note> */ 1975 /* You must not deallocate the memory before calling @FT_Done_Face. */ 1976 /* */ 1977 FT_EXPORT( FT_Error ) 1978 FT_New_Memory_Face( FT_Library library, 1979 const FT_Byte* file_base, 1980 FT_Long file_size, 1981 FT_Long face_index, 1982 FT_Face *aface ); 1983 1984 1985 /*************************************************************************/ 1986 /* */ 1987 /* <Function> */ 1988 /* FT_Open_Face */ 1989 /* */ 1990 /* <Description> */ 1991 /* Create a face object from a given resource described by */ 1992 /* @FT_Open_Args. */ 1993 /* */ 1994 /* <InOut> */ 1995 /* library :: A handle to the library resource. */ 1996 /* */ 1997 /* <Input> */ 1998 /* args :: A pointer to an `FT_Open_Args' structure that must */ 1999 /* be filled by the caller. */ 2000 /* */ 2001 /* face_index :: The index of the face within the font. The first */ 2002 /* face has index~0. */ 2003 /* */ 2004 /* <Output> */ 2005 /* aface :: A handle to a new face object. If `face_index' is */ 2006 /* greater than or equal to zero, it must be non-NULL. */ 2007 /* See note below. */ 2008 /* */ 2009 /* <Return> */ 2010 /* FreeType error code. 0~means success. */ 2011 /* */ 2012 /* <Note> */ 2013 /* Unlike FreeType 1.x, this function automatically creates a glyph */ 2014 /* slot for the face object that can be accessed directly through */ 2015 /* `face->glyph'. */ 2016 /* */ 2017 /* FT_Open_Face can be used to quickly check whether the font */ 2018 /* format of a given font resource is supported by FreeType. If the */ 2019 /* `face_index' field is negative, the function's return value is~0 */ 2020 /* if the font format is recognized, or non-zero otherwise; */ 2021 /* the function returns a more or less empty face handle in `*aface' */ 2022 /* (if `aface' isn't NULL). The only useful field in this special */ 2023 /* case is `face->num_faces' that gives the number of faces within */ 2024 /* the font file. After examination, the returned @FT_Face structure */ 2025 /* should be deallocated with a call to @FT_Done_Face. */ 2026 /* */ 2027 /* Each new face object created with this function also owns a */ 2028 /* default @FT_Size object, accessible as `face->size'. */ 2029 /* */ 2030 /* One @FT_Library instance can have multiple face objects, this is, */ 2031 /* @FT_Open_Face and its siblings can be called multiple times using */ 2032 /* the same `library' argument. */ 2033 /* */ 2034 /* See the discussion of reference counters in the description of */ 2035 /* @FT_Reference_Face. */ 2036 /* */ 2037 FT_EXPORT( FT_Error ) 2038 FT_Open_Face( FT_Library library, 2039 const FT_Open_Args* args, 2040 FT_Long face_index, 2041 FT_Face *aface ); 2042 2043 2044 /*************************************************************************/ 2045 /* */ 2046 /* <Function> */ 2047 /* FT_Attach_File */ 2048 /* */ 2049 /* <Description> */ 2050 /* This function calls @FT_Attach_Stream to attach a file. */ 2051 /* */ 2052 /* <InOut> */ 2053 /* face :: The target face object. */ 2054 /* */ 2055 /* <Input> */ 2056 /* filepathname :: The pathname. */ 2057 /* */ 2058 /* <Return> */ 2059 /* FreeType error code. 0~means success. */ 2060 /* */ 2061 FT_EXPORT( FT_Error ) 2062 FT_Attach_File( FT_Face face, 2063 const char* filepathname ); 2064 2065 2066 /*************************************************************************/ 2067 /* */ 2068 /* <Function> */ 2069 /* FT_Attach_Stream */ 2070 /* */ 2071 /* <Description> */ 2072 /* `Attach' data to a face object. Normally, this is used to read */ 2073 /* additional information for the face object. For example, you can */ 2074 /* attach an AFM file that comes with a Type~1 font to get the */ 2075 /* kerning values and other metrics. */ 2076 /* */ 2077 /* <InOut> */ 2078 /* face :: The target face object. */ 2079 /* */ 2080 /* <Input> */ 2081 /* parameters :: A pointer to @FT_Open_Args that must be filled by */ 2082 /* the caller. */ 2083 /* */ 2084 /* <Return> */ 2085 /* FreeType error code. 0~means success. */ 2086 /* */ 2087 /* <Note> */ 2088 /* The meaning of the `attach' (i.e., what really happens when the */ 2089 /* new file is read) is not fixed by FreeType itself. It really */ 2090 /* depends on the font format (and thus the font driver). */ 2091 /* */ 2092 /* Client applications are expected to know what they are doing */ 2093 /* when invoking this function. Most drivers simply do not implement */ 2094 /* file attachments. */ 2095 /* */ 2096 FT_EXPORT( FT_Error ) 2097 FT_Attach_Stream( FT_Face face, 2098 FT_Open_Args* parameters ); 2099 2100 2101 /*************************************************************************/ 2102 /* */ 2103 /* <Function> */ 2104 /* FT_Reference_Face */ 2105 /* */ 2106 /* <Description> */ 2107 /* A counter gets initialized to~1 at the time an @FT_Face structure */ 2108 /* is created. This function increments the counter. @FT_Done_Face */ 2109 /* then only destroys a face if the counter is~1, otherwise it simply */ 2110 /* decrements the counter. */ 2111 /* */ 2112 /* This function helps in managing life-cycles of structures that */ 2113 /* reference @FT_Face objects. */ 2114 /* */ 2115 /* <Input> */ 2116 /* face :: A handle to a target face object. */ 2117 /* */ 2118 /* <Return> */ 2119 /* FreeType error code. 0~means success. */ 2120 /* */ 2121 /* <Since> */ 2122 /* 2.4.2 */ 2123 /* */ 2124 FT_EXPORT( FT_Error ) 2125 FT_Reference_Face( FT_Face face ); 2126 2127 2128 /*************************************************************************/ 2129 /* */ 2130 /* <Function> */ 2131 /* FT_Done_Face */ 2132 /* */ 2133 /* <Description> */ 2134 /* Discard a given face object, as well as all of its child slots and */ 2135 /* sizes. */ 2136 /* */ 2137 /* <Input> */ 2138 /* face :: A handle to a target face object. */ 2139 /* */ 2140 /* <Return> */ 2141 /* FreeType error code. 0~means success. */ 2142 /* */ 2143 /* <Note> */ 2144 /* See the discussion of reference counters in the description of */ 2145 /* @FT_Reference_Face. */ 2146 /* */ 2147 FT_EXPORT( FT_Error ) 2148 FT_Done_Face( FT_Face face ); 2149 2150 2151 /*************************************************************************/ 2152 /* */ 2153 /* <Function> */ 2154 /* FT_Select_Size */ 2155 /* */ 2156 /* <Description> */ 2157 /* Select a bitmap strike. */ 2158 /* */ 2159 /* <InOut> */ 2160 /* face :: A handle to a target face object. */ 2161 /* */ 2162 /* <Input> */ 2163 /* strike_index :: The index of the bitmap strike in the */ 2164 /* `available_sizes' field of @FT_FaceRec structure. */ 2165 /* */ 2166 /* <Return> */ 2167 /* FreeType error code. 0~means success. */ 2168 /* */ 2169 FT_EXPORT( FT_Error ) 2170 FT_Select_Size( FT_Face face, 2171 FT_Int strike_index ); 2172 2173 2174 /*************************************************************************/ 2175 /* */ 2176 /* <Enum> */ 2177 /* FT_Size_Request_Type */ 2178 /* */ 2179 /* <Description> */ 2180 /* An enumeration type that lists the supported size request types. */ 2181 /* */ 2182 /* <Values> */ 2183 /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */ 2184 /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */ 2185 /* used to determine both scaling values. */ 2186 /* */ 2187 /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */ 2188 /* The real dimension. The sum of the the `ascender' and (minus */ 2189 /* of) the `descender' fields of @FT_FaceRec are used to determine */ 2190 /* both scaling values. */ 2191 /* */ 2192 /* FT_SIZE_REQUEST_TYPE_BBOX :: */ 2193 /* The font bounding box. The width and height of the `bbox' field */ 2194 /* of @FT_FaceRec are used to determine the horizontal and vertical */ 2195 /* scaling value, respectively. */ 2196 /* */ 2197 /* FT_SIZE_REQUEST_TYPE_CELL :: */ 2198 /* The `max_advance_width' field of @FT_FaceRec is used to */ 2199 /* determine the horizontal scaling value; the vertical scaling */ 2200 /* value is determined the same way as */ 2201 /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */ 2202 /* values are set to the smaller one. This type is useful if you */ 2203 /* want to specify the font size for, say, a window of a given */ 2204 /* dimension and 80x24 cells. */ 2205 /* */ 2206 /* FT_SIZE_REQUEST_TYPE_SCALES :: */ 2207 /* Specify the scaling values directly. */ 2208 /* */ 2209 /* <Note> */ 2210 /* The above descriptions only apply to scalable formats. For bitmap */ 2211 /* formats, the behaviour is up to the driver. */ 2212 /* */ 2213 /* See the note section of @FT_Size_Metrics if you wonder how size */ 2214 /* requesting relates to scaling values. */ 2215 /* */ 2216 typedef enum FT_Size_Request_Type_ 2217 { 2218 FT_SIZE_REQUEST_TYPE_NOMINAL, 2219 FT_SIZE_REQUEST_TYPE_REAL_DIM, 2220 FT_SIZE_REQUEST_TYPE_BBOX, 2221 FT_SIZE_REQUEST_TYPE_CELL, 2222 FT_SIZE_REQUEST_TYPE_SCALES, 2223 2224 FT_SIZE_REQUEST_TYPE_MAX 2225 2226 } FT_Size_Request_Type; 2227 2228 2229 /*************************************************************************/ 2230 /* */ 2231 /* <Struct> */ 2232 /* FT_Size_RequestRec */ 2233 /* */ 2234 /* <Description> */ 2235 /* A structure used to model a size request. */ 2236 /* */ 2237 /* <Fields> */ 2238 /* type :: See @FT_Size_Request_Type. */ 2239 /* */ 2240 /* width :: The desired width. */ 2241 /* */ 2242 /* height :: The desired height. */ 2243 /* */ 2244 /* horiResolution :: The horizontal resolution. If set to zero, */ 2245 /* `width' is treated as a 26.6 fractional pixel */ 2246 /* value. */ 2247 /* */ 2248 /* vertResolution :: The vertical resolution. If set to zero, */ 2249 /* `height' is treated as a 26.6 fractional pixel */ 2250 /* value. */ 2251 /* */ 2252 /* <Note> */ 2253 /* If `width' is zero, then the horizontal scaling value is set equal */ 2254 /* to the vertical scaling value, and vice versa. */ 2255 /* */ 2256 typedef struct FT_Size_RequestRec_ 2257 { 2258 FT_Size_Request_Type type; 2259 FT_Long width; 2260 FT_Long height; 2261 FT_UInt horiResolution; 2262 FT_UInt vertResolution; 2263 2264 } FT_Size_RequestRec; 2265 2266 2267 /*************************************************************************/ 2268 /* */ 2269 /* <Struct> */ 2270 /* FT_Size_Request */ 2271 /* */ 2272 /* <Description> */ 2273 /* A handle to a size request structure. */ 2274 /* */ 2275 typedef struct FT_Size_RequestRec_ *FT_Size_Request; 2276 2277 2278 /*************************************************************************/ 2279 /* */ 2280 /* <Function> */ 2281 /* FT_Request_Size */ 2282 /* */ 2283 /* <Description> */ 2284 /* Resize the scale of the active @FT_Size object in a face. */ 2285 /* */ 2286 /* <InOut> */ 2287 /* face :: A handle to a target face object. */ 2288 /* */ 2289 /* <Input> */ 2290 /* req :: A pointer to a @FT_Size_RequestRec. */ 2291 /* */ 2292 /* <Return> */ 2293 /* FreeType error code. 0~means success. */ 2294 /* */ 2295 /* <Note> */ 2296 /* Although drivers may select the bitmap strike matching the */ 2297 /* request, you should not rely on this if you intend to select a */ 2298 /* particular bitmap strike. Use @FT_Select_Size instead in that */ 2299 /* case. */ 2300 /* */ 2301 /* The relation between the requested size and the resulting glyph */ 2302 /* size is dependent entirely on how the size is defined in the */ 2303 /* source face. The font designer chooses the final size of each */ 2304 /* glyph relative to this size. For more information refer to */ 2305 /* `http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html' */ 2306 /* */ 2307 /* Don't use this function if you are using the FreeType cache API. */ 2308 /* */ 2309 FT_EXPORT( FT_Error ) 2310 FT_Request_Size( FT_Face face, 2311 FT_Size_Request req ); 2312 2313 2314 /*************************************************************************/ 2315 /* */ 2316 /* <Function> */ 2317 /* FT_Set_Char_Size */ 2318 /* */ 2319 /* <Description> */ 2320 /* This function calls @FT_Request_Size to request the nominal size */ 2321 /* (in points). */ 2322 /* */ 2323 /* <InOut> */ 2324 /* face :: A handle to a target face object. */ 2325 /* */ 2326 /* <Input> */ 2327 /* char_width :: The nominal width, in 26.6 fractional points. */ 2328 /* */ 2329 /* char_height :: The nominal height, in 26.6 fractional points. */ 2330 /* */ 2331 /* horz_resolution :: The horizontal resolution in dpi. */ 2332 /* */ 2333 /* vert_resolution :: The vertical resolution in dpi. */ 2334 /* */ 2335 /* <Return> */ 2336 /* FreeType error code. 0~means success. */ 2337 /* */ 2338 /* <Note> */ 2339 /* If either the character width or height is zero, it is set equal */ 2340 /* to the other value. */ 2341 /* */ 2342 /* If either the horizontal or vertical resolution is zero, it is set */ 2343 /* equal to the other value. */ 2344 /* */ 2345 /* A character width or height smaller than 1pt is set to 1pt; if */ 2346 /* both resolution values are zero, they are set to 72dpi. */ 2347 /* */ 2348 /* Don't use this function if you are using the FreeType cache API. */ 2349 /* */ 2350 FT_EXPORT( FT_Error ) 2351 FT_Set_Char_Size( FT_Face face, 2352 FT_F26Dot6 char_width, 2353 FT_F26Dot6 char_height, 2354 FT_UInt horz_resolution, 2355 FT_UInt vert_resolution ); 2356 2357 2358 /*************************************************************************/ 2359 /* */ 2360 /* <Function> */ 2361 /* FT_Set_Pixel_Sizes */ 2362 /* */ 2363 /* <Description> */ 2364 /* This function calls @FT_Request_Size to request the nominal size */ 2365 /* (in pixels). */ 2366 /* */ 2367 /* <InOut> */ 2368 /* face :: A handle to the target face object. */ 2369 /* */ 2370 /* <Input> */ 2371 /* pixel_width :: The nominal width, in pixels. */ 2372 /* */ 2373 /* pixel_height :: The nominal height, in pixels. */ 2374 /* */ 2375 /* <Return> */ 2376 /* FreeType error code. 0~means success. */ 2377 /* */ 2378 /* <Note> */ 2379 /* You should not rely on the resulting glyphs matching, or being */ 2380 /* constrained, to this pixel size. Refer to @FT_Request_Size to */ 2381 /* understand how requested sizes relate to actual sizes. */ 2382 /* */ 2383 /* Don't use this function if you are using the FreeType cache API. */ 2384 /* */ 2385 FT_EXPORT( FT_Error ) 2386 FT_Set_Pixel_Sizes( FT_Face face, 2387 FT_UInt pixel_width, 2388 FT_UInt pixel_height ); 2389 2390 2391 /*************************************************************************/ 2392 /* */ 2393 /* <Function> */ 2394 /* FT_Load_Glyph */ 2395 /* */ 2396 /* <Description> */ 2397 /* A function used to load a single glyph into the glyph slot of a */ 2398 /* face object. */ 2399 /* */ 2400 /* <InOut> */ 2401 /* face :: A handle to the target face object where the glyph */ 2402 /* is loaded. */ 2403 /* */ 2404 /* <Input> */ 2405 /* glyph_index :: The index of the glyph in the font file. For */ 2406 /* CID-keyed fonts (either in PS or in CFF format) */ 2407 /* this argument specifies the CID value. */ 2408 /* */ 2409 /* load_flags :: A flag indicating what to load for this glyph. The */ 2410 /* @FT_LOAD_XXX constants can be used to control the */ 2411 /* glyph loading process (e.g., whether the outline */ 2412 /* should be scaled, whether to load bitmaps or not, */ 2413 /* whether to hint the outline, etc). */ 2414 /* */ 2415 /* <Return> */ 2416 /* FreeType error code. 0~means success. */ 2417 /* */ 2418 /* <Note> */ 2419 /* The loaded glyph may be transformed. See @FT_Set_Transform for */ 2420 /* the details. */ 2421 /* */ 2422 /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */ 2423 /* returned for invalid CID values (this is, for CID values that */ 2424 /* don't have a corresponding glyph in the font). See the discussion */ 2425 /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */ 2426 /* */ 2427 FT_EXPORT( FT_Error ) 2428 FT_Load_Glyph( FT_Face face, 2429 FT_UInt glyph_index, 2430 FT_Int32 load_flags ); 2431 2432 2433 /*************************************************************************/ 2434 /* */ 2435 /* <Function> */ 2436 /* FT_Load_Char */ 2437 /* */ 2438 /* <Description> */ 2439 /* A function used to load a single glyph into the glyph slot of a */ 2440 /* face object, according to its character code. */ 2441 /* */ 2442 /* <InOut> */ 2443 /* face :: A handle to a target face object where the glyph */ 2444 /* is loaded. */ 2445 /* */ 2446 /* <Input> */ 2447 /* char_code :: The glyph's character code, according to the */ 2448 /* current charmap used in the face. */ 2449 /* */ 2450 /* load_flags :: A flag indicating what to load for this glyph. The */ 2451 /* @FT_LOAD_XXX constants can be used to control the */ 2452 /* glyph loading process (e.g., whether the outline */ 2453 /* should be scaled, whether to load bitmaps or not, */ 2454 /* whether to hint the outline, etc). */ 2455 /* */ 2456 /* <Return> */ 2457 /* FreeType error code. 0~means success. */ 2458 /* */ 2459 /* <Note> */ 2460 /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */ 2461 /* */ 2462 FT_EXPORT( FT_Error ) 2463 FT_Load_Char( FT_Face face, 2464 FT_ULong char_code, 2465 FT_Int32 load_flags ); 2466 2467 2468 /************************************************************************* 2469 * 2470 * @enum: 2471 * FT_LOAD_XXX 2472 * 2473 * @description: 2474 * A list of bit-field constants used with @FT_Load_Glyph to indicate 2475 * what kind of operations to perform during glyph loading. 2476 * 2477 * @values: 2478 * FT_LOAD_DEFAULT :: 2479 * Corresponding to~0, this value is used as the default glyph load 2480 * operation. In this case, the following happens: 2481 * 2482 * 1. FreeType looks for a bitmap for the glyph corresponding to the 2483 * face's current size. If one is found, the function returns. 2484 * The bitmap data can be accessed from the glyph slot (see note 2485 * below). 2486 * 2487 * 2. If no embedded bitmap is searched or found, FreeType looks for a 2488 * scalable outline. If one is found, it is loaded from the font 2489 * file, scaled to device pixels, then `hinted' to the pixel grid 2490 * in order to optimize it. The outline data can be accessed from 2491 * the glyph slot (see note below). 2492 * 2493 * Note that by default, the glyph loader doesn't render outlines into 2494 * bitmaps. The following flags are used to modify this default 2495 * behaviour to more specific and useful cases. 2496 * 2497 * FT_LOAD_NO_SCALE :: 2498 * Don't scale the loaded outline glyph but keep it in font units. 2499 * 2500 * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and 2501 * unsets @FT_LOAD_RENDER. 2502 * 2503 * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using 2504 * FT_LOAD_NO_SCALE usually yields meaningless outlines because the 2505 * subglyphs must be scaled and positioned with hinting instructions. 2506 * This can be solved by loading the font without FT_LOAD_NO_SCALE and 2507 * setting the character size to `font->units_per_EM'. 2508 * 2509 * FT_LOAD_NO_HINTING :: 2510 * Disable hinting. This generally generates `blurrier' bitmap glyphs 2511 * when the glyph are rendered in any of the anti-aliased modes. See 2512 * also the note below. 2513 * 2514 * This flag is implied by @FT_LOAD_NO_SCALE. 2515 * 2516 * FT_LOAD_RENDER :: 2517 * Call @FT_Render_Glyph after the glyph is loaded. By default, the 2518 * glyph is rendered in @FT_RENDER_MODE_NORMAL mode. This can be 2519 * overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME. 2520 * 2521 * This flag is unset by @FT_LOAD_NO_SCALE. 2522 * 2523 * FT_LOAD_NO_BITMAP :: 2524 * Ignore bitmap strikes when loading. Bitmap-only fonts ignore this 2525 * flag. 2526 * 2527 * @FT_LOAD_NO_SCALE always sets this flag. 2528 * 2529 * FT_LOAD_VERTICAL_LAYOUT :: 2530 * Load the glyph for vertical text layout. In particular, the 2531 * `advance' value in the @FT_GlyphSlotRec structure is set to the 2532 * `vertAdvance' value of the `metrics' field. 2533 * 2534 * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use 2535 * this flag currently. Reason is that in this case vertical metrics 2536 * get synthesized, and those values are not always consistent across 2537 * various font formats. 2538 * 2539 * FT_LOAD_FORCE_AUTOHINT :: 2540 * Indicates that the auto-hinter is preferred over the font's native 2541 * hinter. See also the note below. 2542 * 2543 * FT_LOAD_CROP_BITMAP :: 2544 * Indicates that the font driver should crop the loaded bitmap glyph 2545 * (i.e., remove all space around its black bits). Not all drivers 2546 * implement this. 2547 * 2548 * FT_LOAD_PEDANTIC :: 2549 * Indicates that the font driver should perform pedantic verifications 2550 * during glyph loading. This is mostly used to detect broken glyphs 2551 * in fonts. By default, FreeType tries to handle broken fonts also. 2552 * 2553 * In particular, errors from the TrueType bytecode engine are not 2554 * passed to the application if this flag is not set; this might 2555 * result in partially hinted or distorted glyphs in case a glyph's 2556 * bytecode is buggy. 2557 * 2558 * FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH :: 2559 * Ignored. Deprecated. 2560 * 2561 * FT_LOAD_NO_RECURSE :: 2562 * Indicate that the font driver should not load composite glyphs 2563 * recursively. Instead, it should set the `num_subglyph' and 2564 * `subglyphs' values of the glyph slot accordingly, and set 2565 * `glyph->format' to @FT_GLYPH_FORMAT_COMPOSITE. The description of 2566 * subglyphs can then be accessed with @FT_Get_SubGlyph_Info. 2567 * 2568 * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM. 2569 * 2570 * FT_LOAD_IGNORE_TRANSFORM :: 2571 * Indicates that the transform matrix set by @FT_Set_Transform should 2572 * be ignored. 2573 * 2574 * FT_LOAD_MONOCHROME :: 2575 * This flag is used with @FT_LOAD_RENDER to indicate that you want to 2576 * render an outline glyph to a 1-bit monochrome bitmap glyph, with 2577 * 8~pixels packed into each byte of the bitmap data. 2578 * 2579 * Note that this has no effect on the hinting algorithm used. You 2580 * should rather use @FT_LOAD_TARGET_MONO so that the 2581 * monochrome-optimized hinting algorithm is used. 2582 * 2583 * FT_LOAD_LINEAR_DESIGN :: 2584 * Indicates that the `linearHoriAdvance' and `linearVertAdvance' 2585 * fields of @FT_GlyphSlotRec should be kept in font units. See 2586 * @FT_GlyphSlotRec for details. 2587 * 2588 * FT_LOAD_NO_AUTOHINT :: 2589 * Disable auto-hinter. See also the note below. 2590 * 2591 * FT_LOAD_COLOR :: 2592 * This flag is used to request loading of color embedded-bitmap 2593 * images. The resulting color bitmaps, if available, will have the 2594 * @FT_PIXEL_MODE_BGRA format. When the flag is not used and color 2595 * bitmaps are found, they will be converted to 256-level gray 2596 * bitmaps transparently. Those bitmaps will be in the 2597 * @FT_PIXEL_MODE_GRAY format. 2598 * 2599 * @note: 2600 * By default, hinting is enabled and the font's native hinter (see 2601 * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can 2602 * disable hinting by setting @FT_LOAD_NO_HINTING or change the 2603 * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set 2604 * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be 2605 * used at all. 2606 * 2607 * See the description of @FT_FACE_FLAG_TRICKY for a special exception 2608 * (affecting only a handful of Asian fonts). 2609 * 2610 * Besides deciding which hinter to use, you can also decide which 2611 * hinting algorithm to use. See @FT_LOAD_TARGET_XXX for details. 2612 * 2613 * Note that the auto-hinter needs a valid Unicode cmap (either a native 2614 * one or synthesized by FreeType) for producing correct results. If a 2615 * font provides an incorrect mapping (for example, assigning the 2616 * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a 2617 * mathematical integral sign), the auto-hinter might produce useless 2618 * results. 2619 * 2620 */ 2621 #define FT_LOAD_DEFAULT 0x0 2622 #define FT_LOAD_NO_SCALE ( 1L << 0 ) 2623 #define FT_LOAD_NO_HINTING ( 1L << 1 ) 2624 #define FT_LOAD_RENDER ( 1L << 2 ) 2625 #define FT_LOAD_NO_BITMAP ( 1L << 3 ) 2626 #define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 ) 2627 #define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 ) 2628 #define FT_LOAD_CROP_BITMAP ( 1L << 6 ) 2629 #define FT_LOAD_PEDANTIC ( 1L << 7 ) 2630 #define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 ) 2631 #define FT_LOAD_NO_RECURSE ( 1L << 10 ) 2632 #define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 ) 2633 #define FT_LOAD_MONOCHROME ( 1L << 12 ) 2634 #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 ) 2635 #define FT_LOAD_NO_AUTOHINT ( 1L << 15 ) 2636 /* Bits 16..19 are used by `FT_LOAD_TARGET_' */ 2637 #define FT_LOAD_COLOR ( 1L << 20 ) 2638 2639 /* */ 2640 2641 /* used internally only by certain font drivers! */ 2642 #define FT_LOAD_ADVANCE_ONLY ( 1L << 8 ) 2643 #define FT_LOAD_SBITS_ONLY ( 1L << 14 ) 2644 2645 2646 /************************************************************************** 2647 * 2648 * @enum: 2649 * FT_LOAD_TARGET_XXX 2650 * 2651 * @description: 2652 * A list of values that are used to select a specific hinting algorithm 2653 * to use by the hinter. You should OR one of these values to your 2654 * `load_flags' when calling @FT_Load_Glyph. 2655 * 2656 * Note that font's native hinters may ignore the hinting algorithm you 2657 * have specified (e.g., the TrueType bytecode interpreter). You can set 2658 * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used. 2659 * 2660 * Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it 2661 * always implies @FT_LOAD_FORCE_AUTOHINT. 2662 * 2663 * @values: 2664 * FT_LOAD_TARGET_NORMAL :: 2665 * This corresponds to the default hinting algorithm, optimized for 2666 * standard gray-level rendering. For monochrome output, use 2667 * @FT_LOAD_TARGET_MONO instead. 2668 * 2669 * FT_LOAD_TARGET_LIGHT :: 2670 * A lighter hinting algorithm for non-monochrome modes. Many 2671 * generated glyphs are more fuzzy but better resemble its original 2672 * shape. A bit like rendering on Mac OS~X. 2673 * 2674 * As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT. 2675 * 2676 * FT_LOAD_TARGET_MONO :: 2677 * Strong hinting algorithm that should only be used for monochrome 2678 * output. The result is probably unpleasant if the glyph is rendered 2679 * in non-monochrome modes. 2680 * 2681 * FT_LOAD_TARGET_LCD :: 2682 * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally 2683 * decimated LCD displays. 2684 * 2685 * FT_LOAD_TARGET_LCD_V :: 2686 * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically 2687 * decimated LCD displays. 2688 * 2689 * @note: 2690 * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your 2691 * `load_flags'. They can't be ORed. 2692 * 2693 * If @FT_LOAD_RENDER is also set, the glyph is rendered in the 2694 * corresponding mode (i.e., the mode that matches the used algorithm 2695 * best). An exeption is FT_LOAD_TARGET_MONO since it implies 2696 * @FT_LOAD_MONOCHROME. 2697 * 2698 * You can use a hinting algorithm that doesn't correspond to the same 2699 * rendering mode. As an example, it is possible to use the `light' 2700 * hinting algorithm and have the results rendered in horizontal LCD 2701 * pixel mode, with code like 2702 * 2703 * { 2704 * FT_Load_Glyph( face, glyph_index, 2705 * load_flags | FT_LOAD_TARGET_LIGHT ); 2706 * 2707 * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD ); 2708 * } 2709 * 2710 */ 2711 #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 ) 2712 2713 #define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL ) 2714 #define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT ) 2715 #define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO ) 2716 #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD ) 2717 #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V ) 2718 2719 2720 /************************************************************************** 2721 * 2722 * @macro: 2723 * FT_LOAD_TARGET_MODE 2724 * 2725 * @description: 2726 * Return the @FT_Render_Mode corresponding to a given 2727 * @FT_LOAD_TARGET_XXX value. 2728 * 2729 */ 2730 #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) ) 2731 2732 2733 /*************************************************************************/ 2734 /* */ 2735 /* <Function> */ 2736 /* FT_Set_Transform */ 2737 /* */ 2738 /* <Description> */ 2739 /* A function used to set the transformation that is applied to glyph */ 2740 /* images when they are loaded into a glyph slot through */ 2741 /* @FT_Load_Glyph. */ 2742 /* */ 2743 /* <InOut> */ 2744 /* face :: A handle to the source face object. */ 2745 /* */ 2746 /* <Input> */ 2747 /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */ 2748 /* the identity matrix. */ 2749 /* delta :: A pointer to the translation vector. Use~0 for the null */ 2750 /* vector. */ 2751 /* */ 2752 /* <Note> */ 2753 /* The transformation is only applied to scalable image formats after */ 2754 /* the glyph has been loaded. It means that hinting is unaltered by */ 2755 /* the transformation and is performed on the character size given in */ 2756 /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */ 2757 /* */ 2758 /* Note that this also transforms the `face.glyph.advance' field, but */ 2759 /* *not* the values in `face.glyph.metrics'. */ 2760 /* */ 2761 FT_EXPORT( void ) 2762 FT_Set_Transform( FT_Face face, 2763 FT_Matrix* matrix, 2764 FT_Vector* delta ); 2765 2766 2767 /*************************************************************************/ 2768 /* */ 2769 /* <Enum> */ 2770 /* FT_Render_Mode */ 2771 /* */ 2772 /* <Description> */ 2773 /* An enumeration type that lists the render modes supported by */ 2774 /* FreeType~2. Each mode corresponds to a specific type of scanline */ 2775 /* conversion performed on the outline. */ 2776 /* */ 2777 /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */ 2778 /* field in the @FT_GlyphSlotRec structure gives the format of the */ 2779 /* returned bitmap. */ 2780 /* */ 2781 /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity. */ 2782 /* */ 2783 /* <Values> */ 2784 /* FT_RENDER_MODE_NORMAL :: */ 2785 /* This is the default render mode; it corresponds to 8-bit */ 2786 /* anti-aliased bitmaps. */ 2787 /* */ 2788 /* FT_RENDER_MODE_LIGHT :: */ 2789 /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */ 2790 /* defined as a separate value because render modes are also used */ 2791 /* indirectly to define hinting algorithm selectors. See */ 2792 /* @FT_LOAD_TARGET_XXX for details. */ 2793 /* */ 2794 /* FT_RENDER_MODE_MONO :: */ 2795 /* This mode corresponds to 1-bit bitmaps (with 2~levels of */ 2796 /* opacity). */ 2797 /* */ 2798 /* FT_RENDER_MODE_LCD :: */ 2799 /* This mode corresponds to horizontal RGB and BGR sub-pixel */ 2800 /* displays like LCD screens. It produces 8-bit bitmaps that are */ 2801 /* 3~times the width of the original glyph outline in pixels, and */ 2802 /* which use the @FT_PIXEL_MODE_LCD mode. */ 2803 /* */ 2804 /* FT_RENDER_MODE_LCD_V :: */ 2805 /* This mode corresponds to vertical RGB and BGR sub-pixel displays */ 2806 /* (like PDA screens, rotated LCD displays, etc.). It produces */ 2807 /* 8-bit bitmaps that are 3~times the height of the original */ 2808 /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */ 2809 /* */ 2810 /* <Note> */ 2811 /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */ 2812 /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */ 2813 /* (not active in the default builds). It is up to the caller to */ 2814 /* either call @FT_Library_SetLcdFilter (if available) or do the */ 2815 /* filtering itself. */ 2816 /* */ 2817 /* The selected render mode only affects vector glyphs of a font. */ 2818 /* Embedded bitmaps often have a different pixel mode like */ 2819 /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */ 2820 /* them into 8-bit pixmaps. */ 2821 /* */ 2822 typedef enum FT_Render_Mode_ 2823 { 2824 FT_RENDER_MODE_NORMAL = 0, 2825 FT_RENDER_MODE_LIGHT, 2826 FT_RENDER_MODE_MONO, 2827 FT_RENDER_MODE_LCD, 2828 FT_RENDER_MODE_LCD_V, 2829 2830 FT_RENDER_MODE_MAX 2831 2832 } FT_Render_Mode; 2833 2834 2835 /*************************************************************************/ 2836 /* */ 2837 /* <Enum> */ 2838 /* ft_render_mode_xxx */ 2839 /* */ 2840 /* <Description> */ 2841 /* These constants are deprecated. Use the corresponding */ 2842 /* @FT_Render_Mode values instead. */ 2843 /* */ 2844 /* <Values> */ 2845 /* ft_render_mode_normal :: see @FT_RENDER_MODE_NORMAL */ 2846 /* ft_render_mode_mono :: see @FT_RENDER_MODE_MONO */ 2847 /* */ 2848 #define ft_render_mode_normal FT_RENDER_MODE_NORMAL 2849 #define ft_render_mode_mono FT_RENDER_MODE_MONO 2850 2851 2852 /*************************************************************************/ 2853 /* */ 2854 /* <Function> */ 2855 /* FT_Render_Glyph */ 2856 /* */ 2857 /* <Description> */ 2858 /* Convert a given glyph image to a bitmap. It does so by inspecting */ 2859 /* the glyph image format, finding the relevant renderer, and */ 2860 /* invoking it. */ 2861 /* */ 2862 /* <InOut> */ 2863 /* slot :: A handle to the glyph slot containing the image to */ 2864 /* convert. */ 2865 /* */ 2866 /* <Input> */ 2867 /* render_mode :: This is the render mode used to render the glyph */ 2868 /* image into a bitmap. See @FT_Render_Mode for a */ 2869 /* list of possible values. */ 2870 /* */ 2871 /* <Return> */ 2872 /* FreeType error code. 0~means success. */ 2873 /* */ 2874 /* <Note> */ 2875 /* To get meaningful results, font scaling values must be set with */ 2876 /* functions like @FT_Set_Char_Size before calling FT_Render_Glyph. */ 2877 /* */ 2878 FT_EXPORT( FT_Error ) 2879 FT_Render_Glyph( FT_GlyphSlot slot, 2880 FT_Render_Mode render_mode ); 2881 2882 2883 /*************************************************************************/ 2884 /* */ 2885 /* <Enum> */ 2886 /* FT_Kerning_Mode */ 2887 /* */ 2888 /* <Description> */ 2889 /* An enumeration used to specify which kerning values to return in */ 2890 /* @FT_Get_Kerning. */ 2891 /* */ 2892 /* <Values> */ 2893 /* FT_KERNING_DEFAULT :: Return scaled and grid-fitted kerning */ 2894 /* distances (value is~0). */ 2895 /* */ 2896 /* FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning */ 2897 /* distances. */ 2898 /* */ 2899 /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */ 2900 /* units. */ 2901 /* */ 2902 typedef enum FT_Kerning_Mode_ 2903 { 2904 FT_KERNING_DEFAULT = 0, 2905 FT_KERNING_UNFITTED, 2906 FT_KERNING_UNSCALED 2907 2908 } FT_Kerning_Mode; 2909 2910 2911 /*************************************************************************/ 2912 /* */ 2913 /* <Const> */ 2914 /* ft_kerning_default */ 2915 /* */ 2916 /* <Description> */ 2917 /* This constant is deprecated. Please use @FT_KERNING_DEFAULT */ 2918 /* instead. */ 2919 /* */ 2920 #define ft_kerning_default FT_KERNING_DEFAULT 2921 2922 2923 /*************************************************************************/ 2924 /* */ 2925 /* <Const> */ 2926 /* ft_kerning_unfitted */ 2927 /* */ 2928 /* <Description> */ 2929 /* This constant is deprecated. Please use @FT_KERNING_UNFITTED */ 2930 /* instead. */ 2931 /* */ 2932 #define ft_kerning_unfitted FT_KERNING_UNFITTED 2933 2934 2935 /*************************************************************************/ 2936 /* */ 2937 /* <Const> */ 2938 /* ft_kerning_unscaled */ 2939 /* */ 2940 /* <Description> */ 2941 /* This constant is deprecated. Please use @FT_KERNING_UNSCALED */ 2942 /* instead. */ 2943 /* */ 2944 #define ft_kerning_unscaled FT_KERNING_UNSCALED 2945 2946 2947 /*************************************************************************/ 2948 /* */ 2949 /* <Function> */ 2950 /* FT_Get_Kerning */ 2951 /* */ 2952 /* <Description> */ 2953 /* Return the kerning vector between two glyphs of a same face. */ 2954 /* */ 2955 /* <Input> */ 2956 /* face :: A handle to a source face object. */ 2957 /* */ 2958 /* left_glyph :: The index of the left glyph in the kern pair. */ 2959 /* */ 2960 /* right_glyph :: The index of the right glyph in the kern pair. */ 2961 /* */ 2962 /* kern_mode :: See @FT_Kerning_Mode for more information. */ 2963 /* Determines the scale and dimension of the returned */ 2964 /* kerning vector. */ 2965 /* */ 2966 /* <Output> */ 2967 /* akerning :: The kerning vector. This is either in font units */ 2968 /* or in pixels (26.6 format) for scalable formats, */ 2969 /* and in pixels for fixed-sizes formats. */ 2970 /* */ 2971 /* <Return> */ 2972 /* FreeType error code. 0~means success. */ 2973 /* */ 2974 /* <Note> */ 2975 /* Only horizontal layouts (left-to-right & right-to-left) are */ 2976 /* supported by this method. Other layouts, or more sophisticated */ 2977 /* kernings, are out of the scope of this API function -- they can be */ 2978 /* implemented through format-specific interfaces. */ 2979 /* */ 2980 FT_EXPORT( FT_Error ) 2981 FT_Get_Kerning( FT_Face face, 2982 FT_UInt left_glyph, 2983 FT_UInt right_glyph, 2984 FT_UInt kern_mode, 2985 FT_Vector *akerning ); 2986 2987 2988 /*************************************************************************/ 2989 /* */ 2990 /* <Function> */ 2991 /* FT_Get_Track_Kerning */ 2992 /* */ 2993 /* <Description> */ 2994 /* Return the track kerning for a given face object at a given size. */ 2995 /* */ 2996 /* <Input> */ 2997 /* face :: A handle to a source face object. */ 2998 /* */ 2999 /* point_size :: The point size in 16.16 fractional points. */ 3000 /* */ 3001 /* degree :: The degree of tightness. Increasingly negative */ 3002 /* values represent tighter track kerning, while */ 3003 /* increasingly positive values represent looser track */ 3004 /* kerning. Value zero means no track kerning. */ 3005 /* */ 3006 /* <Output> */ 3007 /* akerning :: The kerning in 16.16 fractional points, to be */ 3008 /* uniformly applied between all glyphs. */ 3009 /* */ 3010 /* <Return> */ 3011 /* FreeType error code. 0~means success. */ 3012 /* */ 3013 /* <Note> */ 3014 /* Currently, only the Type~1 font driver supports track kerning, */ 3015 /* using data from AFM files (if attached with @FT_Attach_File or */ 3016 /* @FT_Attach_Stream). */ 3017 /* */ 3018 /* Only very few AFM files come with track kerning data; please refer */ 3019 /* to the Adobe's AFM specification for more details. */ 3020 /* */ 3021 FT_EXPORT( FT_Error ) 3022 FT_Get_Track_Kerning( FT_Face face, 3023 FT_Fixed point_size, 3024 FT_Int degree, 3025 FT_Fixed* akerning ); 3026 3027 3028 /*************************************************************************/ 3029 /* */ 3030 /* <Function> */ 3031 /* FT_Get_Glyph_Name */ 3032 /* */ 3033 /* <Description> */ 3034 /* Retrieve the ASCII name of a given glyph in a face. This only */ 3035 /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */ 3036 /* */ 3037 /* <Input> */ 3038 /* face :: A handle to a source face object. */ 3039 /* */ 3040 /* glyph_index :: The glyph index. */ 3041 /* */ 3042 /* buffer_max :: The maximum number of bytes available in the */ 3043 /* buffer. */ 3044 /* */ 3045 /* <Output> */ 3046 /* buffer :: A pointer to a target buffer where the name is */ 3047 /* copied to. */ 3048 /* */ 3049 /* <Return> */ 3050 /* FreeType error code. 0~means success. */ 3051 /* */ 3052 /* <Note> */ 3053 /* An error is returned if the face doesn't provide glyph names or if */ 3054 /* the glyph index is invalid. In all cases of failure, the first */ 3055 /* byte of `buffer' is set to~0 to indicate an empty name. */ 3056 /* */ 3057 /* The glyph name is truncated to fit within the buffer if it is too */ 3058 /* long. The returned string is always zero-terminated. */ 3059 /* */ 3060 /* Be aware that FreeType reorders glyph indices internally so that */ 3061 /* glyph index~0 always corresponds to the `missing glyph' (called */ 3062 /* `.notdef'). */ 3063 /* */ 3064 /* This function always returns an error if the config macro */ 3065 /* `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is not defined in `ftoptions.h'. */ 3066 /* */ 3067 FT_EXPORT( FT_Error ) 3068 FT_Get_Glyph_Name( FT_Face face, 3069 FT_UInt glyph_index, 3070 FT_Pointer buffer, 3071 FT_UInt buffer_max ); 3072 3073 3074 /*************************************************************************/ 3075 /* */ 3076 /* <Function> */ 3077 /* FT_Get_Postscript_Name */ 3078 /* */ 3079 /* <Description> */ 3080 /* Retrieve the ASCII PostScript name of a given face, if available. */ 3081 /* This only works with PostScript and TrueType fonts. */ 3082 /* */ 3083 /* <Input> */ 3084 /* face :: A handle to the source face object. */ 3085 /* */ 3086 /* <Return> */ 3087 /* A pointer to the face's PostScript name. NULL if unavailable. */ 3088 /* */ 3089 /* <Note> */ 3090 /* The returned pointer is owned by the face and is destroyed with */ 3091 /* it. */ 3092 /* */ 3093 FT_EXPORT( const char* ) 3094 FT_Get_Postscript_Name( FT_Face face ); 3095 3096 3097 /*************************************************************************/ 3098 /* */ 3099 /* <Function> */ 3100 /* FT_Select_Charmap */ 3101 /* */ 3102 /* <Description> */ 3103 /* Select a given charmap by its encoding tag (as listed in */ 3104 /* `freetype.h'). */ 3105 /* */ 3106 /* <InOut> */ 3107 /* face :: A handle to the source face object. */ 3108 /* */ 3109 /* <Input> */ 3110 /* encoding :: A handle to the selected encoding. */ 3111 /* */ 3112 /* <Return> */ 3113 /* FreeType error code. 0~means success. */ 3114 /* */ 3115 /* <Note> */ 3116 /* This function returns an error if no charmap in the face */ 3117 /* corresponds to the encoding queried here. */ 3118 /* */ 3119 /* Because many fonts contain more than a single cmap for Unicode */ 3120 /* encoding, this function has some special code to select the one */ 3121 /* that covers Unicode best (`best' in the sense that a UCS-4 cmap is */ 3122 /* preferred to a UCS-2 cmap). It is thus preferable to */ 3123 /* @FT_Set_Charmap in this case. */ 3124 /* */ 3125 FT_EXPORT( FT_Error ) 3126 FT_Select_Charmap( FT_Face face, 3127 FT_Encoding encoding ); 3128 3129 3130 /*************************************************************************/ 3131 /* */ 3132 /* <Function> */ 3133 /* FT_Set_Charmap */ 3134 /* */ 3135 /* <Description> */ 3136 /* Select a given charmap for character code to glyph index mapping. */ 3137 /* */ 3138 /* <InOut> */ 3139 /* face :: A handle to the source face object. */ 3140 /* */ 3141 /* <Input> */ 3142 /* charmap :: A handle to the selected charmap. */ 3143 /* */ 3144 /* <Return> */ 3145 /* FreeType error code. 0~means success. */ 3146 /* */ 3147 /* <Note> */ 3148 /* This function returns an error if the charmap is not part of */ 3149 /* the face (i.e., if it is not listed in the `face->charmaps' */ 3150 /* table). */ 3151 /* */ 3152 /* It also fails if a type~14 charmap is selected. */ 3153 /* */ 3154 FT_EXPORT( FT_Error ) 3155 FT_Set_Charmap( FT_Face face, 3156 FT_CharMap charmap ); 3157 3158 3159 /************************************************************************* 3160 * 3161 * @function: 3162 * FT_Get_Charmap_Index 3163 * 3164 * @description: 3165 * Retrieve index of a given charmap. 3166 * 3167 * @input: 3168 * charmap :: 3169 * A handle to a charmap. 3170 * 3171 * @return: 3172 * The index into the array of character maps within the face to which 3173 * `charmap' belongs. If an error occurs, -1 is returned. 3174 * 3175 */ 3176 FT_EXPORT( FT_Int ) 3177 FT_Get_Charmap_Index( FT_CharMap charmap ); 3178 3179 3180 /*************************************************************************/ 3181 /* */ 3182 /* <Function> */ 3183 /* FT_Get_Char_Index */ 3184 /* */ 3185 /* <Description> */ 3186 /* Return the glyph index of a given character code. This function */ 3187 /* uses a charmap object to do the mapping. */ 3188 /* */ 3189 /* <Input> */ 3190 /* face :: A handle to the source face object. */ 3191 /* */ 3192 /* charcode :: The character code. */ 3193 /* */ 3194 /* <Return> */ 3195 /* The glyph index. 0~means `undefined character code'. */ 3196 /* */ 3197 /* <Note> */ 3198 /* If you use FreeType to manipulate the contents of font files */ 3199 /* directly, be aware that the glyph index returned by this function */ 3200 /* doesn't always correspond to the internal indices used within the */ 3201 /* file. This is done to ensure that value~0 always corresponds to */ 3202 /* the `missing glyph'. If the first glyph is not named `.notdef', */ 3203 /* then for Type~1 and Type~42 fonts, `.notdef' will be moved into */ 3204 /* the glyph ID~0 position, and whatever was there will be moved to */ 3205 /* the position `.notdef' had. For Type~1 fonts, if there is no */ 3206 /* `.notdef' glyph at all, then one will be created at index~0 and */ 3207 /* whatever was there will be moved to the last index -- Type~42 */ 3208 /* fonts are considered invalid under this condition. */ 3209 /* */ 3210 FT_EXPORT( FT_UInt ) 3211 FT_Get_Char_Index( FT_Face face, 3212 FT_ULong charcode ); 3213 3214 3215 /*************************************************************************/ 3216 /* */ 3217 /* <Function> */ 3218 /* FT_Get_First_Char */ 3219 /* */ 3220 /* <Description> */ 3221 /* This function is used to return the first character code in the */ 3222 /* current charmap of a given face. It also returns the */ 3223 /* corresponding glyph index. */ 3224 /* */ 3225 /* <Input> */ 3226 /* face :: A handle to the source face object. */ 3227 /* */ 3228 /* <Output> */ 3229 /* agindex :: Glyph index of first character code. 0~if charmap is */ 3230 /* empty. */ 3231 /* */ 3232 /* <Return> */ 3233 /* The charmap's first character code. */ 3234 /* */ 3235 /* <Note> */ 3236 /* You should use this function with @FT_Get_Next_Char to be able to */ 3237 /* parse all character codes available in a given charmap. The code */ 3238 /* should look like this: */ 3239 /* */ 3240 /* { */ 3241 /* FT_ULong charcode; */ 3242 /* FT_UInt gindex; */ 3243 /* */ 3244 /* */ 3245 /* charcode = FT_Get_First_Char( face, &gindex ); */ 3246 /* while ( gindex != 0 ) */ 3247 /* { */ 3248 /* ... do something with (charcode,gindex) pair ... */ 3249 /* */ 3250 /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */ 3251 /* } */ 3252 /* } */ 3253 /* */ 3254 /* Note that `*agindex' is set to~0 if the charmap is empty. The */ 3255 /* result itself can be~0 in two cases: if the charmap is empty or */ 3256 /* if the value~0 is the first valid character code. */ 3257 /* */ 3258 FT_EXPORT( FT_ULong ) 3259 FT_Get_First_Char( FT_Face face, 3260 FT_UInt *agindex ); 3261 3262 3263 /*************************************************************************/ 3264 /* */ 3265 /* <Function> */ 3266 /* FT_Get_Next_Char */ 3267 /* */ 3268 /* <Description> */ 3269 /* This function is used to return the next character code in the */ 3270 /* current charmap of a given face following the value `char_code', */ 3271 /* as well as the corresponding glyph index. */ 3272 /* */ 3273 /* <Input> */ 3274 /* face :: A handle to the source face object. */ 3275 /* char_code :: The starting character code. */ 3276 /* */ 3277 /* <Output> */ 3278 /* agindex :: Glyph index of next character code. 0~if charmap */ 3279 /* is empty. */ 3280 /* */ 3281 /* <Return> */ 3282 /* The charmap's next character code. */ 3283 /* */ 3284 /* <Note> */ 3285 /* You should use this function with @FT_Get_First_Char to walk */ 3286 /* over all character codes available in a given charmap. See the */ 3287 /* note for this function for a simple code example. */ 3288 /* */ 3289 /* Note that `*agindex' is set to~0 when there are no more codes in */ 3290 /* the charmap. */ 3291 /* */ 3292 FT_EXPORT( FT_ULong ) 3293 FT_Get_Next_Char( FT_Face face, 3294 FT_ULong char_code, 3295 FT_UInt *agindex ); 3296 3297 3298 /*************************************************************************/ 3299 /* */ 3300 /* <Function> */ 3301 /* FT_Get_Name_Index */ 3302 /* */ 3303 /* <Description> */ 3304 /* Return the glyph index of a given glyph name. This function uses */ 3305 /* driver specific objects to do the translation. */ 3306 /* */ 3307 /* <Input> */ 3308 /* face :: A handle to the source face object. */ 3309 /* */ 3310 /* glyph_name :: The glyph name. */ 3311 /* */ 3312 /* <Return> */ 3313 /* The glyph index. 0~means `undefined character code'. */ 3314 /* */ 3315 FT_EXPORT( FT_UInt ) 3316 FT_Get_Name_Index( FT_Face face, 3317 FT_String* glyph_name ); 3318 3319 3320 /************************************************************************* 3321 * 3322 * @macro: 3323 * FT_SUBGLYPH_FLAG_XXX 3324 * 3325 * @description: 3326 * A list of constants used to describe subglyphs. Please refer to the 3327 * TrueType specification for the meaning of the various flags. 3328 * 3329 * @values: 3330 * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS :: 3331 * FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES :: 3332 * FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID :: 3333 * FT_SUBGLYPH_FLAG_SCALE :: 3334 * FT_SUBGLYPH_FLAG_XY_SCALE :: 3335 * FT_SUBGLYPH_FLAG_2X2 :: 3336 * FT_SUBGLYPH_FLAG_USE_MY_METRICS :: 3337 * 3338 */ 3339 #define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1 3340 #define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2 3341 #define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4 3342 #define FT_SUBGLYPH_FLAG_SCALE 8 3343 #define FT_SUBGLYPH_FLAG_XY_SCALE 0x40 3344 #define FT_SUBGLYPH_FLAG_2X2 0x80 3345 #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200 3346 3347 3348 /************************************************************************* 3349 * 3350 * @func: 3351 * FT_Get_SubGlyph_Info 3352 * 3353 * @description: 3354 * Retrieve a description of a given subglyph. Only use it if 3355 * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is 3356 * returned otherwise. 3357 * 3358 * @input: 3359 * glyph :: 3360 * The source glyph slot. 3361 * 3362 * sub_index :: 3363 * The index of the subglyph. Must be less than 3364 * `glyph->num_subglyphs'. 3365 * 3366 * @output: 3367 * p_index :: 3368 * The glyph index of the subglyph. 3369 * 3370 * p_flags :: 3371 * The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX. 3372 * 3373 * p_arg1 :: 3374 * The subglyph's first argument (if any). 3375 * 3376 * p_arg2 :: 3377 * The subglyph's second argument (if any). 3378 * 3379 * p_transform :: 3380 * The subglyph transformation (if any). 3381 * 3382 * @return: 3383 * FreeType error code. 0~means success. 3384 * 3385 * @note: 3386 * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be 3387 * interpreted depending on the flags returned in `*p_flags'. See the 3388 * TrueType specification for details. 3389 * 3390 */ 3391 FT_EXPORT( FT_Error ) 3392 FT_Get_SubGlyph_Info( FT_GlyphSlot glyph, 3393 FT_UInt sub_index, 3394 FT_Int *p_index, 3395 FT_UInt *p_flags, 3396 FT_Int *p_arg1, 3397 FT_Int *p_arg2, 3398 FT_Matrix *p_transform ); 3399 3400 3401 /*************************************************************************/ 3402 /* */ 3403 /* <Enum> */ 3404 /* FT_FSTYPE_XXX */ 3405 /* */ 3406 /* <Description> */ 3407 /* A list of bit flags used in the `fsType' field of the OS/2 table */ 3408 /* in a TrueType or OpenType font and the `FSType' entry in a */ 3409 /* PostScript font. These bit flags are returned by */ 3410 /* @FT_Get_FSType_Flags; they inform client applications of embedding */ 3411 /* and subsetting restrictions associated with a font. */ 3412 /* */ 3413 /* See http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for */ 3414 /* more details. */ 3415 /* */ 3416 /* <Values> */ 3417 /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */ 3418 /* Fonts with no fsType bit set may be embedded and permanently */ 3419 /* installed on the remote system by an application. */ 3420 /* */ 3421 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */ 3422 /* Fonts that have only this bit set must not be modified, embedded */ 3423 /* or exchanged in any manner without first obtaining permission of */ 3424 /* the font software copyright owner. */ 3425 /* */ 3426 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */ 3427 /* If this bit is set, the font may be embedded and temporarily */ 3428 /* loaded on the remote system. Documents containing Preview & */ 3429 /* Print fonts must be opened `read-only'; no edits can be applied */ 3430 /* to the document. */ 3431 /* */ 3432 /* FT_FSTYPE_EDITABLE_EMBEDDING :: */ 3433 /* If this bit is set, the font may be embedded but must only be */ 3434 /* installed temporarily on other systems. In contrast to Preview */ 3435 /* & Print fonts, documents containing editable fonts may be opened */ 3436 /* for reading, editing is permitted, and changes may be saved. */ 3437 /* */ 3438 /* FT_FSTYPE_NO_SUBSETTING :: */ 3439 /* If this bit is set, the font may not be subsetted prior to */ 3440 /* embedding. */ 3441 /* */ 3442 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */ 3443 /* If this bit is set, only bitmaps contained in the font may be */ 3444 /* embedded; no outline data may be embedded. If there are no */ 3445 /* bitmaps available in the font, then the font is unembeddable. */ 3446 /* */ 3447 /* <Note> */ 3448 /* While the fsType flags can indicate that a font may be embedded, a */ 3449 /* license with the font vendor may be separately required to use the */ 3450 /* font in this way. */ 3451 /* */ 3452 #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000 3453 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002 3454 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004 3455 #define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008 3456 #define FT_FSTYPE_NO_SUBSETTING 0x0100 3457 #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200 3458 3459 3460 /*************************************************************************/ 3461 /* */ 3462 /* <Function> */ 3463 /* FT_Get_FSType_Flags */ 3464 /* */ 3465 /* <Description> */ 3466 /* Return the fsType flags for a font. */ 3467 /* */ 3468 /* <Input> */ 3469 /* face :: A handle to the source face object. */ 3470 /* */ 3471 /* <Return> */ 3472 /* The fsType flags, @FT_FSTYPE_XXX. */ 3473 /* */ 3474 /* <Note> */ 3475 /* Use this function rather than directly reading the `fs_type' field */ 3476 /* in the @PS_FontInfoRec structure, which is only guaranteed to */ 3477 /* return the correct results for Type~1 fonts. */ 3478 /* */ 3479 /* <Since> */ 3480 /* 2.3.8 */ 3481 /* */ 3482 FT_EXPORT( FT_UShort ) 3483 FT_Get_FSType_Flags( FT_Face face ); 3484 3485 3486 /*************************************************************************/ 3487 /* */ 3488 /* <Section> */ 3489 /* glyph_variants */ 3490 /* */ 3491 /* <Title> */ 3492 /* Glyph Variants */ 3493 /* */ 3494 /* <Abstract> */ 3495 /* The FreeType~2 interface to Unicode Ideographic Variation */ 3496 /* Sequences (IVS), using the SFNT cmap format~14. */ 3497 /* */ 3498 /* <Description> */ 3499 /* Many CJK characters have variant forms. They are a sort of grey */ 3500 /* area somewhere between being totally irrelevant and semantically */ 3501 /* distinct; for this reason, the Unicode consortium decided to */ 3502 /* introduce Ideographic Variation Sequences (IVS), consisting of a */ 3503 /* Unicode base character and one of 240 variant selectors */ 3504 /* (U+E0100-U+E01EF), instead of further extending the already huge */ 3505 /* code range for CJK characters. */ 3506 /* */ 3507 /* An IVS is registered and unique; for further details please refer */ 3508 /* to Unicode Technical Standard #37, the Ideographic Variation */ 3509 /* Database: */ 3510 /* */ 3511 /* http://www.unicode.org/reports/tr37/ */ 3512 /* */ 3513 /* To date (November 2012), the character with the most variants is */ 3514 /* U+9089, having 31 such IVS. */ 3515 /* */ 3516 /* Adobe and MS decided to support IVS with a new cmap subtable */ 3517 /* (format~14). It is an odd subtable because it is not a mapping of */ 3518 /* input code points to glyphs, but contains lists of all variants */ 3519 /* supported by the font. */ 3520 /* */ 3521 /* A variant may be either `default' or `non-default'. A default */ 3522 /* variant is the one you will get for that code point if you look it */ 3523 /* up in the standard Unicode cmap. A non-default variant is a */ 3524 /* different glyph. */ 3525 /* */ 3526 /*************************************************************************/ 3527 3528 3529 /*************************************************************************/ 3530 /* */ 3531 /* <Function> */ 3532 /* FT_Face_GetCharVariantIndex */ 3533 /* */ 3534 /* <Description> */ 3535 /* Return the glyph index of a given character code as modified by */ 3536 /* the variation selector. */ 3537 /* */ 3538 /* <Input> */ 3539 /* face :: */ 3540 /* A handle to the source face object. */ 3541 /* */ 3542 /* charcode :: */ 3543 /* The character code point in Unicode. */ 3544 /* */ 3545 /* variantSelector :: */ 3546 /* The Unicode code point of the variation selector. */ 3547 /* */ 3548 /* <Return> */ 3549 /* The glyph index. 0~means either `undefined character code', or */ 3550 /* `undefined selector code', or `no variation selector cmap */ 3551 /* subtable', or `current CharMap is not Unicode'. */ 3552 /* */ 3553 /* <Note> */ 3554 /* If you use FreeType to manipulate the contents of font files */ 3555 /* directly, be aware that the glyph index returned by this function */ 3556 /* doesn't always correspond to the internal indices used within */ 3557 /* the file. This is done to ensure that value~0 always corresponds */ 3558 /* to the `missing glyph'. */ 3559 /* */ 3560 /* This function is only meaningful if */ 3561 /* a) the font has a variation selector cmap sub table, */ 3562 /* and */ 3563 /* b) the current charmap has a Unicode encoding. */ 3564 /* */ 3565 /* <Since> */ 3566 /* 2.3.6 */ 3567 /* */ 3568 FT_EXPORT( FT_UInt ) 3569 FT_Face_GetCharVariantIndex( FT_Face face, 3570 FT_ULong charcode, 3571 FT_ULong variantSelector ); 3572 3573 3574 /*************************************************************************/ 3575 /* */ 3576 /* <Function> */ 3577 /* FT_Face_GetCharVariantIsDefault */ 3578 /* */ 3579 /* <Description> */ 3580 /* Check whether this variant of this Unicode character is the one to */ 3581 /* be found in the `cmap'. */ 3582 /* */ 3583 /* <Input> */ 3584 /* face :: */ 3585 /* A handle to the source face object. */ 3586 /* */ 3587 /* charcode :: */ 3588 /* The character codepoint in Unicode. */ 3589 /* */ 3590 /* variantSelector :: */ 3591 /* The Unicode codepoint of the variation selector. */ 3592 /* */ 3593 /* <Return> */ 3594 /* 1~if found in the standard (Unicode) cmap, 0~if found in the */ 3595 /* variation selector cmap, or -1 if it is not a variant. */ 3596 /* */ 3597 /* <Note> */ 3598 /* This function is only meaningful if the font has a variation */ 3599 /* selector cmap subtable. */ 3600 /* */ 3601 /* <Since> */ 3602 /* 2.3.6 */ 3603 /* */ 3604 FT_EXPORT( FT_Int ) 3605 FT_Face_GetCharVariantIsDefault( FT_Face face, 3606 FT_ULong charcode, 3607 FT_ULong variantSelector ); 3608 3609 3610 /*************************************************************************/ 3611 /* */ 3612 /* <Function> */ 3613 /* FT_Face_GetVariantSelectors */ 3614 /* */ 3615 /* <Description> */ 3616 /* Return a zero-terminated list of Unicode variant selectors found */ 3617 /* in the font. */ 3618 /* */ 3619 /* <Input> */ 3620 /* face :: */ 3621 /* A handle to the source face object. */ 3622 /* */ 3623 /* <Return> */ 3624 /* A pointer to an array of selector code points, or NULL if there is */ 3625 /* no valid variant selector cmap subtable. */ 3626 /* */ 3627 /* <Note> */ 3628 /* The last item in the array is~0; the array is owned by the */ 3629 /* @FT_Face object but can be overwritten or released on the next */ 3630 /* call to a FreeType function. */ 3631 /* */ 3632 /* <Since> */ 3633 /* 2.3.6 */ 3634 /* */ 3635 FT_EXPORT( FT_UInt32* ) 3636 FT_Face_GetVariantSelectors( FT_Face face ); 3637 3638 3639 /*************************************************************************/ 3640 /* */ 3641 /* <Function> */ 3642 /* FT_Face_GetVariantsOfChar */ 3643 /* */ 3644 /* <Description> */ 3645 /* Return a zero-terminated list of Unicode variant selectors found */ 3646 /* for the specified character code. */ 3647 /* */ 3648 /* <Input> */ 3649 /* face :: */ 3650 /* A handle to the source face object. */ 3651 /* */ 3652 /* charcode :: */ 3653 /* The character codepoint in Unicode. */ 3654 /* */ 3655 /* <Return> */ 3656 /* A pointer to an array of variant selector code points that are */ 3657 /* active for the given character, or NULL if the corresponding list */ 3658 /* is empty. */ 3659 /* */ 3660 /* <Note> */ 3661 /* The last item in the array is~0; the array is owned by the */ 3662 /* @FT_Face object but can be overwritten or released on the next */ 3663 /* call to a FreeType function. */ 3664 /* */ 3665 /* <Since> */ 3666 /* 2.3.6 */ 3667 /* */ 3668 FT_EXPORT( FT_UInt32* ) 3669 FT_Face_GetVariantsOfChar( FT_Face face, 3670 FT_ULong charcode ); 3671 3672 3673 /*************************************************************************/ 3674 /* */ 3675 /* <Function> */ 3676 /* FT_Face_GetCharsOfVariant */ 3677 /* */ 3678 /* <Description> */ 3679 /* Return a zero-terminated list of Unicode character codes found for */ 3680 /* the specified variant selector. */ 3681 /* */ 3682 /* <Input> */ 3683 /* face :: */ 3684 /* A handle to the source face object. */ 3685 /* */ 3686 /* variantSelector :: */ 3687 /* The variant selector code point in Unicode. */ 3688 /* */ 3689 /* <Return> */ 3690 /* A list of all the code points that are specified by this selector */ 3691 /* (both default and non-default codes are returned) or NULL if there */ 3692 /* is no valid cmap or the variant selector is invalid. */ 3693 /* */ 3694 /* <Note> */ 3695 /* The last item in the array is~0; the array is owned by the */ 3696 /* @FT_Face object but can be overwritten or released on the next */ 3697 /* call to a FreeType function. */ 3698 /* */ 3699 /* <Since> */ 3700 /* 2.3.6 */ 3701 /* */ 3702 FT_EXPORT( FT_UInt32* ) 3703 FT_Face_GetCharsOfVariant( FT_Face face, 3704 FT_ULong variantSelector ); 3705 3706 3707 /*************************************************************************/ 3708 /* */ 3709 /* <Section> */ 3710 /* computations */ 3711 /* */ 3712 /* <Title> */ 3713 /* Computations */ 3714 /* */ 3715 /* <Abstract> */ 3716 /* Crunching fixed numbers and vectors. */ 3717 /* */ 3718 /* <Description> */ 3719 /* This section contains various functions used to perform */ 3720 /* computations on 16.16 fixed-float numbers or 2d vectors. */ 3721 /* */ 3722 /* <Order> */ 3723 /* FT_MulDiv */ 3724 /* FT_MulFix */ 3725 /* FT_DivFix */ 3726 /* FT_RoundFix */ 3727 /* FT_CeilFix */ 3728 /* FT_FloorFix */ 3729 /* FT_Vector_Transform */ 3730 /* FT_Matrix_Multiply */ 3731 /* FT_Matrix_Invert */ 3732 /* */ 3733 /*************************************************************************/ 3734 3735 3736 /*************************************************************************/ 3737 /* */ 3738 /* <Function> */ 3739 /* FT_MulDiv */ 3740 /* */ 3741 /* <Description> */ 3742 /* A very simple function used to perform the computation `(a*b)/c' */ 3743 /* with maximum accuracy (it uses a 64-bit intermediate integer */ 3744 /* whenever necessary). */ 3745 /* */ 3746 /* This function isn't necessarily as fast as some processor specific */ 3747 /* operations, but is at least completely portable. */ 3748 /* */ 3749 /* <Input> */ 3750 /* a :: The first multiplier. */ 3751 /* b :: The second multiplier. */ 3752 /* c :: The divisor. */ 3753 /* */ 3754 /* <Return> */ 3755 /* The result of `(a*b)/c'. This function never traps when trying to */ 3756 /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */ 3757 /* on the signs of `a' and `b'. */ 3758 /* */ 3759 FT_EXPORT( FT_Long ) 3760 FT_MulDiv( FT_Long a, 3761 FT_Long b, 3762 FT_Long c ); 3763 3764 3765 /* */ 3766 3767 /* The following #if 0 ... #endif is for the documentation formatter, */ 3768 /* hiding the internal `FT_MULFIX_INLINED' macro. */ 3769 3770 #if 0 3771 /*************************************************************************/ 3772 /* */ 3773 /* <Function> */ 3774 /* FT_MulFix */ 3775 /* */ 3776 /* <Description> */ 3777 /* A very simple function used to perform the computation */ 3778 /* `(a*b)/0x10000' with maximum accuracy. Most of the time this is */ 3779 /* used to multiply a given value by a 16.16 fixed-point factor. */ 3780 /* */ 3781 /* <Input> */ 3782 /* a :: The first multiplier. */ 3783 /* b :: The second multiplier. Use a 16.16 factor here whenever */ 3784 /* possible (see note below). */ 3785 /* */ 3786 /* <Return> */ 3787 /* The result of `(a*b)/0x10000'. */ 3788 /* */ 3789 /* <Note> */ 3790 /* This function has been optimized for the case where the absolute */ 3791 /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */ 3792 /* As this happens mainly when scaling from notional units to */ 3793 /* fractional pixels in FreeType, it resulted in noticeable speed */ 3794 /* improvements between versions 2.x and 1.x. */ 3795 /* */ 3796 /* As a conclusion, always try to place a 16.16 factor as the */ 3797 /* _second_ argument of this function; this can make a great */ 3798 /* difference. */ 3799 /* */ 3800 FT_EXPORT( FT_Long ) 3801 FT_MulFix( FT_Long a, 3802 FT_Long b ); 3803 3804 /* */ 3805 #endif 3806 3807 #ifdef FT_MULFIX_INLINED 3808 #define FT_MulFix( a, b ) FT_MULFIX_INLINED( a, b ) 3809 #else 3810 FT_EXPORT( FT_Long ) 3811 FT_MulFix( FT_Long a, 3812 FT_Long b ); 3813 #endif 3814 3815 3816 /*************************************************************************/ 3817 /* */ 3818 /* <Function> */ 3819 /* FT_DivFix */ 3820 /* */ 3821 /* <Description> */ 3822 /* A very simple function used to perform the computation */ 3823 /* `(a*0x10000)/b' with maximum accuracy. Most of the time, this is */ 3824 /* used to divide a given value by a 16.16 fixed-point factor. */ 3825 /* */ 3826 /* <Input> */ 3827 /* a :: The first multiplier. */ 3828 /* b :: The second multiplier. Use a 16.16 factor here whenever */ 3829 /* possible (see note below). */ 3830 /* */ 3831 /* <Return> */ 3832 /* The result of `(a*0x10000)/b'. */ 3833 /* */ 3834 /* <Note> */ 3835 /* The optimization for FT_DivFix() is simple: If (a~<<~16) fits in */ 3836 /* 32~bits, then the division is computed directly. Otherwise, we */ 3837 /* use a specialized version of @FT_MulDiv. */ 3838 /* */ 3839 FT_EXPORT( FT_Long ) 3840 FT_DivFix( FT_Long a, 3841 FT_Long b ); 3842 3843 3844 /*************************************************************************/ 3845 /* */ 3846 /* <Function> */ 3847 /* FT_RoundFix */ 3848 /* */ 3849 /* <Description> */ 3850 /* A very simple function used to round a 16.16 fixed number. */ 3851 /* */ 3852 /* <Input> */ 3853 /* a :: The number to be rounded. */ 3854 /* */ 3855 /* <Return> */ 3856 /* The result of `(a + 0x8000) & -0x10000'. */ 3857 /* */ 3858 FT_EXPORT( FT_Fixed ) 3859 FT_RoundFix( FT_Fixed a ); 3860 3861 3862 /*************************************************************************/ 3863 /* */ 3864 /* <Function> */ 3865 /* FT_CeilFix */ 3866 /* */ 3867 /* <Description> */ 3868 /* A very simple function used to compute the ceiling function of a */ 3869 /* 16.16 fixed number. */ 3870 /* */ 3871 /* <Input> */ 3872 /* a :: The number for which the ceiling function is to be computed. */ 3873 /* */ 3874 /* <Return> */ 3875 /* The result of `(a + 0x10000 - 1) & -0x10000'. */ 3876 /* */ 3877 FT_EXPORT( FT_Fixed ) 3878 FT_CeilFix( FT_Fixed a ); 3879 3880 3881 /*************************************************************************/ 3882 /* */ 3883 /* <Function> */ 3884 /* FT_FloorFix */ 3885 /* */ 3886 /* <Description> */ 3887 /* A very simple function used to compute the floor function of a */ 3888 /* 16.16 fixed number. */ 3889 /* */ 3890 /* <Input> */ 3891 /* a :: The number for which the floor function is to be computed. */ 3892 /* */ 3893 /* <Return> */ 3894 /* The result of `a & -0x10000'. */ 3895 /* */ 3896 FT_EXPORT( FT_Fixed ) 3897 FT_FloorFix( FT_Fixed a ); 3898 3899 3900 /*************************************************************************/ 3901 /* */ 3902 /* <Function> */ 3903 /* FT_Vector_Transform */ 3904 /* */ 3905 /* <Description> */ 3906 /* Transform a single vector through a 2x2 matrix. */ 3907 /* */ 3908 /* <InOut> */ 3909 /* vector :: The target vector to transform. */ 3910 /* */ 3911 /* <Input> */ 3912 /* matrix :: A pointer to the source 2x2 matrix. */ 3913 /* */ 3914 /* <Note> */ 3915 /* The result is undefined if either `vector' or `matrix' is invalid. */ 3916 /* */ 3917 FT_EXPORT( void ) 3918 FT_Vector_Transform( FT_Vector* vec, 3919 const FT_Matrix* matrix ); 3920 3921 3922 /*************************************************************************/ 3923 /* */ 3924 /* <Section> */ 3925 /* version */ 3926 /* */ 3927 /* <Title> */ 3928 /* FreeType Version */ 3929 /* */ 3930 /* <Abstract> */ 3931 /* Functions and macros related to FreeType versions. */ 3932 /* */ 3933 /* <Description> */ 3934 /* Note that those functions and macros are of limited use because */ 3935 /* even a new release of FreeType with only documentation changes */ 3936 /* increases the version number. */ 3937 /* */ 3938 /*************************************************************************/ 3939 3940 3941 /************************************************************************* 3942 * 3943 * @enum: 3944 * FREETYPE_XXX 3945 * 3946 * @description: 3947 * These three macros identify the FreeType source code version. 3948 * Use @FT_Library_Version to access them at runtime. 3949 * 3950 * @values: 3951 * FREETYPE_MAJOR :: The major version number. 3952 * FREETYPE_MINOR :: The minor version number. 3953 * FREETYPE_PATCH :: The patch level. 3954 * 3955 * @note: 3956 * The version number of FreeType if built as a dynamic link library 3957 * with the `libtool' package is _not_ controlled by these three 3958 * macros. 3959 * 3960 */ 3961 #define FREETYPE_MAJOR 2 3962 #define FREETYPE_MINOR 5 3963 #define FREETYPE_PATCH 3 3964 3965 3966 /*************************************************************************/ 3967 /* */ 3968 /* <Function> */ 3969 /* FT_Library_Version */ 3970 /* */ 3971 /* <Description> */ 3972 /* Return the version of the FreeType library being used. This is */ 3973 /* useful when dynamically linking to the library, since one cannot */ 3974 /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */ 3975 /* @FREETYPE_PATCH. */ 3976 /* */ 3977 /* <Input> */ 3978 /* library :: A source library handle. */ 3979 /* */ 3980 /* <Output> */ 3981 /* amajor :: The major version number. */ 3982 /* */ 3983 /* aminor :: The minor version number. */ 3984 /* */ 3985 /* apatch :: The patch version number. */ 3986 /* */ 3987 /* <Note> */ 3988 /* The reason why this function takes a `library' argument is because */ 3989 /* certain programs implement library initialization in a custom way */ 3990 /* that doesn't use @FT_Init_FreeType. */ 3991 /* */ 3992 /* In such cases, the library version might not be available before */ 3993 /* the library object has been created. */ 3994 /* */ 3995 FT_EXPORT( void ) 3996 FT_Library_Version( FT_Library library, 3997 FT_Int *amajor, 3998 FT_Int *aminor, 3999 FT_Int *apatch ); 4000 4001 4002 /*************************************************************************/ 4003 /* */ 4004 /* <Function> */ 4005 /* FT_Face_CheckTrueTypePatents */ 4006 /* */ 4007 /* <Description> */ 4008 /* Parse all bytecode instructions of a TrueType font file to check */ 4009 /* whether any of the patented opcodes are used. This is only useful */ 4010 /* if you want to be able to use the unpatented hinter with */ 4011 /* fonts that do *not* use these opcodes. */ 4012 /* */ 4013 /* Note that this function parses *all* glyph instructions in the */ 4014 /* font file, which may be slow. */ 4015 /* */ 4016 /* <Input> */ 4017 /* face :: A face handle. */ 4018 /* */ 4019 /* <Return> */ 4020 /* 1~if this is a TrueType font that uses one of the patented */ 4021 /* opcodes, 0~otherwise. */ 4022 /* */ 4023 /* <Note> */ 4024 /* Since May 2010, TrueType hinting is no longer patented. */ 4025 /* */ 4026 /* <Since> */ 4027 /* 2.3.5 */ 4028 /* */ 4029 FT_EXPORT( FT_Bool ) 4030 FT_Face_CheckTrueTypePatents( FT_Face face ); 4031 4032 4033 /*************************************************************************/ 4034 /* */ 4035 /* <Function> */ 4036 /* FT_Face_SetUnpatentedHinting */ 4037 /* */ 4038 /* <Description> */ 4039 /* Enable or disable the unpatented hinter for a given face. */ 4040 /* Only enable it if you have determined that the face doesn't */ 4041 /* use any patented opcodes (see @FT_Face_CheckTrueTypePatents). */ 4042 /* */ 4043 /* <Input> */ 4044 /* face :: A face handle. */ 4045 /* */ 4046 /* value :: New boolean setting. */ 4047 /* */ 4048 /* <Return> */ 4049 /* The old setting value. This will always be false if this is not */ 4050 /* an SFNT font, or if the unpatented hinter is not compiled in this */ 4051 /* instance of the library. */ 4052 /* */ 4053 /* <Note> */ 4054 /* Since May 2010, TrueType hinting is no longer patented. */ 4055 /* */ 4056 /* <Since> */ 4057 /* 2.3.5 */ 4058 /* */ 4059 FT_EXPORT( FT_Bool ) 4060 FT_Face_SetUnpatentedHinting( FT_Face face, 4061 FT_Bool value ); 4062 4063 /* */ 4064 4065 4066 FT_END_HEADER 4067 4068 #endif /* __FREETYPE_H__ */ 4069 4070 4071 /* END */ 4072