Commit 97b2de58987d80d28b61ca9ec51e1c3952922b96
2000-07-10T00:06:22
More formatting. Synchronizing docu in include/freetype with src/base.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 6b86a9c..b992b00 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -1977,7 +1977,7 @@
/* An enumeration used to specify which kerning values to return in */
/* FT_Get_Kerning(). */
/* */
- /* <Field> */
+ /* <Fields> */
/* ft_kerning_default :: Return scaled and grid-fitted kerning */
/* distances (value is 0). */
/* */
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index 51cb1cc..4772d8c 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -7,22 +7,28 @@
/* Copyright 1996-2000 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
-/* This file is part of the FreeType project, and may only be used */
-/* modified and distributed under the terms of the FreeType project */
+/* This file is part of the FreeType project, and may only be used, */
+/* modified, and distributed under the terms of the FreeType project */
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
/* this file you indicate that you have read the license and */
/* understand and accept it fully. */
/* */
-/* This file contains the definition of several convenience functions */
-/* that can be used by client applications to easily retrieve glyph */
-/* bitmaps and outlines from a given face. */
-/* */
-/* These functions should be optional if you're writing a font server */
-/* or text layout engine on top of FreeType. However, they are pretty */
-/* handy for many other simple uses of the library.. */
-/* */
/***************************************************************************/
+
+ /*************************************************************************/
+ /* */
+ /* This file contains the definition of several convenience functions */
+ /* that can be used by client applications to easily retrieve glyph */
+ /* bitmaps and outlines from a given face. */
+ /* */
+ /* These functions should be optional if you are writing a font server */
+ /* or text layout engine on top of FreeType. However, they are pretty */
+ /* handy for many other simple uses of the library. */
+ /* */
+ /*************************************************************************/
+
+
#ifndef FTGLYPH_H
#define FTGLYPH_H
@@ -35,24 +41,26 @@
/* forward declaration to a private type */
typedef struct FT_Glyph_Class_ FT_Glyph_Class;
- /***********************************************************************
- *
- * <Struct>
- * FT_GlyphRec
- *
- * <Description>
- * The root glyph structure contains a given glyph image plus its
- * advance width in 16.16 fixed float format..
- *
- * <Field>
- * library :: a handle to the FreeType library object.
- * clazz :: a pointer to the glyph's class. Private.
- * format :: the format of the glyph's image
- * advance :: a 16.16 vector that gives the glyph's advance width
- *
- ***********************************************************************/
-
- typedef struct FT_GlyphRec_
+
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* FT_GlyphRec */
+ /* */
+ /* <Description> */
+ /* The root glyph structure contains a given glyph image plus its */
+ /* advance width in 16.16 fixed float format. */
+ /* */
+ /* <Fields> */
+ /* library :: A handle to the FreeType library object. */
+ /* */
+ /* clazz :: A pointer to the glyph's class. Private. */
+ /* */
+ /* format :: The format of the glyph's image. */
+ /* */
+ /* advance :: A 16.16 vector that gives the glyph's advance width. */
+ /* */
+ typedef struct FT_GlyphRec_
{
FT_Library library;
const FT_Glyph_Class* clazz;
@@ -62,36 +70,37 @@
} FT_GlyphRec, *FT_Glyph;
- /***********************************************************************
- *
- * <Struct>
- * FT_BitmapGlyphRec
- *
- * <Description>
- * A structure used for bitmap glyph images.. This really is
- * a "sub-class" of "FT_GlyphRec".
- *
- * <Field>
- * root :: the root FT_Glyph fields
- * left :: left-side bearing, i.e. the horizontal distance from
- * the current pen position to the left border of the glyph
- * bitmap.
- * top :: top-side bearing, i.e. the vertical distance from the
- * current pen position to the top border of the glyph bitmap
- * this distance is positive for upwards-y !!
- * bitmap :: a descriptor for the bitmap.
- *
- * <Note>
- * You can typecast a FT_Glyph to FT_BitmapGlyph when you have
- * glyph->format == ft_glyph_format_bitmap. This lets you access
- * the bitmap's content easily..
- *
- * the corresponding pixel buffer is always owned by the BitmapGlyph
- * and is thus created and destroyed with it..
- *
- ***********************************************************************/
-
- typedef struct FT_BitmapGlyphRec_
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* FT_BitmapGlyphRec */
+ /* */
+ /* <Description> */
+ /* A structure used for bitmap glyph images. This really is a */
+ /* `sub-class' of `FT_GlyphRec'. */
+ /* */
+ /* <Fields> */
+ /* root :: The root FT_Glyph fields. */
+ /* */
+ /* left :: The left-side bearing, i.e., the horizontal distance */
+ /* from the current pen position to the left border of the */
+ /* glyph bitmap. */
+ /* */
+ /* top :: The top-side bearing, i.e., the vertical distance from */
+ /* the current pen position to the top border of the glyph */
+ /* bitmap. This distance is positive for upwards-y! */
+ /* */
+ /* bitmap :: A descriptor for the bitmap. */
+ /* */
+ /* <Note> */
+ /* You can typecast FT_Glyph to FT_BitmapGlyph if you have */
+ /* glyph->format == ft_glyph_format_bitmap. This lets you access */
+ /* the bitmap's contents easily. */
+ /* */
+ /* The corresponding pixel buffer is always owned by the BitmapGlyph */
+ /* and is thus created and destroyed with it. */
+ /* */
+ typedef struct FT_BitmapGlyphRec_
{
FT_GlyphRec root;
FT_Int left;
@@ -101,34 +110,33 @@
} FT_BitmapGlyphRec, *FT_BitmapGlyph;
- /***********************************************************************
- *
- * <Struct>
- * FT_OutlineGlyphRec
- *
- * <Description>
- * A structure used for outline (vectorial) glyph images..
- * This really is a "sub-class" of FT_GlyphRec.
- *
- * <Field>
- * root :: the root FT_Glyph fields.
- * outline :: a descriptor for the outline
- *
- * <Note>
- * You can typecast a FT_Glyph to FT_OutlineGlyph when you have
- * glyph->format == ft_glyph_format_outline. This lets you access
- * the outline's content easily..
- *
- * As the outline is extracted from a glyph slot, its coordinates
- * are expressed normally in 26.6 pixels, unless the flag
- * FT_LOAD_NO_SCALE was used in FT_Load_Glyph / FT_Load_Char..
- *
- * the outline's tables are always owned by the object and are
- * destroyed with it..
- *
- ***********************************************************************/
-
- typedef struct FT_OutlineGlyphRec_
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* FT_OutlineGlyphRec */
+ /* */
+ /* <Description> */
+ /* A structure used for outline (vectorial) glyph images. This */
+ /* really is a `sub-class' of `FT_GlyphRec'. */
+ /* */
+ /* <Fields> */
+ /* root :: The root FT_Glyph fields. */
+ /* */
+ /* outline :: A descriptor for the outline. */
+ /* */
+ /* <Note> */
+ /* You can typecast FT_Glyph to FT_OutlineGlyph if you have */
+ /* glyph->format == ft_glyph_format_outline. This lets you access */
+ /* the outline's content easily. */
+ /* */
+ /* As the outline is extracted from a glyph slot, its coordinates are */
+ /* expressed normally in 26.6 pixels, unless the flag */
+ /* FT_LOAD_NO_SCALE was used in FT_Load_Glyph() or FT_Load_Char(). */
+ /* */
+ /* The outline's tables are always owned by the object and are */
+ /* destroyed with it. */
+ /* */
+ typedef struct FT_OutlineGlyphRec_
{
FT_GlyphRec root;
FT_Outline outline;
@@ -136,128 +144,78 @@
} FT_OutlineGlyphRec, *FT_OutlineGlyph;
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Get_Glyph */
+ /* */
+ /* <Description> */
+ /* A function used to extract a glyph image from a slot. */
+ /* */
+ /* <Input> */
+ /* slot :: A handle to the source glyph slot. */
+ /* */
+ /* <Output> */
+ /* aglyph :: A handle to the glyph object. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ FT_EXPORT_DEF( FT_Error ) FT_Get_Glyph( FT_GlyphSlot slot,
+ FT_Glyph* aglyph );
+
- /***********************************************************************
- *
- * <Function>
- * FT_Get_Glyph
- *
- * <Description>
- * A function used to extract one glyph image from a slot..
- *
- * <Input>
- * slot :: handle to source glyph slot.
- *
- * <Output>
- * aglyph :: handle to the glyph object.
- *
- * <Return>
- * Error code. 0 means success.
- *
- * <Note>
- *
- *
- ***********************************************************************/
-
- FT_EXPORT_DEF(FT_Error) FT_Get_Glyph( FT_GlyphSlot slot,
- FT_Glyph *aglyph );
-
- /***********************************************************************
- *
- * <Function>
- * FT_Glyph_Copy
- *
- * <Description>
- * A function used to copy one glyph image.
- *
- * <Input>
- * source :: handle to source glyph object
- *
- * <Output>
- * target :: handle to target glyph object. 0 in case of error
- *
- * <Return>
- * Error code. 0 means success.
- *
- ***********************************************************************/
-
- FT_EXPORT_DEF(FT_Error) FT_Glyph_Copy( FT_Glyph source,
- FT_Glyph *target );
-
-
- /***********************************************************************
- *
- * <Function>
- * FT_Glyph_Transform
- *
- * <Description>
- * Transforms a glyph image, when it's format is scalable
- *
- * <Input>
- * glyph :: handle to target glyph object
- *
- * matrix :: pointer to 2x2 matrix to apply
- *
- * delta :: pointer to a 2d vector to apply. coordinates are
- * expressed in 1/64th of a pixel..
- *
- * <Return>
- * error code (is not 0, the glyph format is not scalable).
- *
- * <Note>
- * the 2x2 transform matrix is also applied to the glyph's
- * advance vector
- *
- ***********************************************************************/
-
- FT_EXPORT_DEF(FT_Error) FT_Glyph_Transform( FT_Glyph glyph,
- FT_Matrix* matrix,
- FT_Vector* delta );
-
- /***********************************************************************
- *
- * <Function>
- * FT_Glyph_Get_CBox
- *
- * <Description>
- * Returns the glyph image's bounding box.
- *
- * <Input>
- * glyph :: handle to source glyph object
- * mode :: a set of bit flags that indicate how to interpret
- * the meaning of the box's coordinates
- *
- * <Output>
- * box :: the glyph bounding box. Coordinates are expressed in
- * 1/64th of pixels, it is grid-fitted..
- *
- * <Note>
- * Coordinates are relative to the glyph origin, using the Y-upwards
- * convention..
- *
- * if 'ft_glyph_bbox_subpixels' is set in "mode", the bbox coordinates
- * are returned in 26.6 pixels (i.e. 1/64th of pixels).
- *
- * otherwise, coordinates are in integer pixels.
- *
- * note that the maximum coordinates are exclusive, which means that
- * once can compute the width and height of the glyph image (be it
- * in integer or 26.6 pixels) as:
- *
- * width = bbox.xMax - bbox.xMin;
- * height = bbox.yMax - bbox.yMin;
- *
- * Note also that for 26.6 coordinates, if the 'ft_glyph_bbox_gridfit'
- * flag is set in "mode", the coordinates will also be grid-fitted,
- * which corresponds to:
- *
- * bbox.xMin = FLOOR(bbox.xMin);
- * bbox.yMin = FLOOR(bbox.yMin);
- * bbox.xMax = CEILING(bbox.xMax);
- * bbox.yMax = CEILING(bbox.yMax);
- *
- ***********************************************************************/
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Glyph_Copy */
+ /* */
+ /* <Description> */
+ /* A function used to copy a glyph image. */
+ /* */
+ /* <Input> */
+ /* source :: A handle to the source glyph object. */
+ /* */
+ /* <Output> */
+ /* target :: A handle to the target glyph object. 0 in case of */
+ /* error. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ FT_EXPORT_DEF( FT_Error ) FT_Glyph_Copy( FT_Glyph source,
+ FT_Glyph* target );
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Glyph_Transform */
+ /* */
+ /* <Description> */
+ /* Transforms a glyph image if its format is scalable. */
+ /* */
+ /* <Input> */
+ /* glyph :: A handle to the target glyph object. */
+ /* */
+ /* matrix :: A pointer to a 2x2 matrix to apply. */
+ /* */
+ /* delta :: A pointer to a 2d vector to apply. Coordinates are */
+ /* expressed in 1/64th of a pixel. */
+ /* */
+ /* <Return> */
+ /* FreeType error code (the glyph format is not scalable if it is */
+ /* not zero). */
+ /* */
+ /* <Note> */
+ /* The 2x2 transformation matrix is also applied to the glyph's */
+ /* advance vector. */
+ /* */
+ FT_EXPORT_DEF( FT_Error ) FT_Glyph_Transform( FT_Glyph glyph,
+ FT_Matrix* matrix,
+ FT_Vector* delta );
+
+
enum
{
ft_glyph_bbox_pixels = 0,
@@ -265,98 +223,150 @@
ft_glyph_bbox_gridfit = 2
};
- FT_EXPORT_DEF(void) FT_Glyph_Get_CBox( FT_Glyph glyph,
- FT_UInt bbox_mode,
- FT_BBox *cbox );
-
-
- /***********************************************************************
- *
- * <Function>
- * FT_Glyph_To_Bitmap
- *
- * <Description>
- * converts a given glyph object to a bitmap glyph object
- *
- * <InOut>
- * glyph :: pointer to a handle to the target glyph
- *
- * <Input>
- * render_mode :: a set of bit flags that describe how
- *
- * origin :: pointer to a vector used to translate the glyph image
- * before rendering. Can be 0 (for no translation). The
- * origin is expressed in 26.6 pixels..
- *
- * destroy :: a boolean that indicates that the original glyph image
- * should be destroyed by this function. The glyph is
- * never destroyed in case of error..
- *
- * <Return>
- * Error code. 0 means success
- *
- * <Note>
- * the glyph image is translated with the "origin" vector before
- * rendering.. In case of error, it it translated back to its original
- * position and the glyph is untouched..
- *
- * The first parameter is a pointer to a FT_Glyph handle, that
- * will be replaced by this function. Typically, you would use:
- *
- * {
- * FT_Glyph glyph;
- * FT_BitmapGlyph glyph_bitmap;
- *
- * // load glyph
- * error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAUT );
- *
- * // extract glyph image
- * error = FT_Get_Glyph( face->glyph, &glyph );
- *
- * // convert to a bitmap (default render mode + destroy old)
- * if (glyph->format != ft_glyph_format_bitmap)
- * {
- * error = FT_Glyph_To_Bitmap( &glyph, ft_render_mode_default, 0, 1 );
- * if (error) // glyph unchanged..
- * }
- *
- * // access bitmap content by typecasting
- * glyph_bitmap = (FT_BitmapGlyph)glyph;
- *
- * // do funny stuff with it, like blitting/drawing
- * ....
- *
- * // discard glyph image (bitmap or not)
- * FT_Done_Glyph( glyph );
- *
- *
- * This function will always fail if the glyph's format isn't scalable
- *
- ***********************************************************************/
-
- FT_EXPORT_DEF(FT_Error) FT_Glyph_To_Bitmap( FT_Glyph *the_glyph,
- FT_ULong render_mode,
- FT_Vector* origin,
- FT_Bool destroy );
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Glyph_Get_CBox */
+ /* */
+ /* <Description> */
+ /* Returns the glyph image's bounding box. */
+ /* */
+ /* <Input> */
+ /* glyph :: A handle to the source glyph object. */
+ /* */
+ /* mode :: A set of bit flags that indicate how to interpret the */
+ /* returned bounding box values. */
+ /* */
+ /* <Output> */
+ /* box :: The glyph bounding box. Coordinates are expressed in */
+ /* 1/64th of pixels if it is grid-fitted. */
+ /* */
+ /* <Note> */
+ /* Coordinates are relative to the glyph origin, using the Y-upwards */
+ /* convention. */
+ /* */
+ /* If `ft_glyph_bbox_subpixels' is set in `mode', the bbox */
+ /* coordinates are returned in 26.6 pixels (i.e. 1/64th of pixels). */
+ /* Otherwise, coordinates are expressed in integer pixels. */
+ /* */
+ /* Note that the maximum coordinates are exclusive, which means that */
+ /* one can compute the width and height of the glyph image (be it in */
+ /* integer or 26.6 pixels) as: */
+ /* */
+ /* width = bbox.xMax - bbox.xMin; */
+ /* height = bbox.yMax - bbox.yMin; */
+ /* */
+ /* Note also that for 26.6 coordinates, if the */
+ /* `ft_glyph_bbox_gridfit' flag is set in `mode;, the coordinates */
+ /* will also be grid-fitted, which corresponds to: */
+ /* */
+ /* bbox.xMin = FLOOR(bbox.xMin); */
+ /* bbox.yMin = FLOOR(bbox.yMin); */
+ /* bbox.xMax = CEILING(bbox.xMax); */
+ /* bbox.yMax = CEILING(bbox.yMax); */
+ /* */
+ /* The default value (0) for `bbox_mode' is `ft_glyph_bbox_pixels'. */
+ /* */
+ FT_EXPORT_DEF( void ) FT_Glyph_Get_CBox( FT_Glyph glyph,
+ FT_UInt bbox_mode,
+ FT_BBox* cbox );
+
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Glyph_To_Bitmap */
+ /* */
+ /* <Description> */
+ /* Converts a given glyph object to a bitmap glyph object. */
+ /* */
+ /* <InOut> */
+ /* glyph :: A pointer to a handle to the target glyph. */
+ /* */
+ /* <Input> */
+ /* render_mode :: A set of bit flags that describe how the data is */
+ /* */
+ /* */
+ /* origin :: A pointer to a vector used to translate the glyph */
+ /* image before rendering. Can be 0 (if no */
+ /* translation). The origin is expressed in */
+ /* 26.6 pixels. */
+ /* */
+ /* destroy :: A boolean that indicates that the original glyph */
+ /* image should be destroyed by this function. It is */
+ /* never destroyed in case of error. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ /* <Note> */
+ /* The glyph image is translated with the `origin' vector before */
+ /* rendering. In case of error, it it translated back to its */
+ /* original position and the glyph is left untouched. */
+ /* */
+ /* The first parameter is a pointer to a FT_Glyph handle, that will */
+ /* be replaced by this function. Typically, you would use (omitting */
+ /* error handling): */
+ /* */
+ /* */
+ /* { */
+ /* FT_Glyph glyph; */
+ /* FT_BitmapGlyph glyph_bitmap; */
+ /* */
+ /* */
+ /* // load glyph */
+ /* error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAUT ); */
+ /* */
+ /* // extract glyph image */
+ /* error = FT_Get_Glyph( face->glyph, &glyph ); */
+ /* */
+ /* // convert to a bitmap (default render mode + destroy old) */
+ /* if ( glyph->format != ft_glyph_format_bitmap ) */
+ /* { */
+ /* error = FT_Glyph_To_Bitmap( &glyph, ft_render_mode_default, */
+ /* 0, 1 ); */
+ /* if ( error ) // glyph unchanged */
+ /* ... */
+ /* } */
+ /* */
+ /* // access bitmap content by typecasting */
+ /* glyph_bitmap = (FT_BitmapGlyph)glyph; */
+ /* */
+ /* // do funny stuff with it, like blitting/drawing */
+ /* ... */
+ /* */
+ /* // discard glyph image (bitmap or not) */
+ /* FT_Done_Glyph( glyph ); */
+ /* } */
+ /* */
+ /* */
+ /* This function will always fail if the glyph's format isn't */
+ /* scalable. */
+ /* */
+ FT_EXPORT_DEF( FT_Error ) FT_Glyph_To_Bitmap( FT_Glyph* the_glyph,
+ FT_ULong render_mode,
+ FT_Vector* origin,
+ FT_Bool destroy );
- /***********************************************************************
- *
- * <Function>
- * FT_Done_Glyph
- *
- * <Description>
- * Destroys a given glyph..
- *
- * <Input>
- * glyph :: handle to target glyph object
- *
- ***********************************************************************/
-
- FT_EXPORT_DEF(void) FT_Done_Glyph( FT_Glyph glyph );
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FT_Done_Glyph */
+ /* */
+ /* <Description> */
+ /* Destroys a given glyph. */
+ /* */
+ /* <Input> */
+ /* glyph :: A handle to the target glyph object. */
+ /* */
+ FT_EXPORT_DEF( void ) FT_Done_Glyph( FT_Glyph glyph );
/* other helpful functions */
+
/*************************************************************************/
/* */
/* <Function> */
@@ -374,8 +384,11 @@
/* <MT-Note> */
/* Yes. */
/* */
- FT_EXPORT_DEF(void) FT_Matrix_Multiply( FT_Matrix* a,
- FT_Matrix* b );
+ /* <Note> */
+ /* The result is undefined if either `a' or `b' is zero. */
+ /* */
+ FT_EXPORT_DEF( void ) FT_Matrix_Multiply( FT_Matrix* a,
+ FT_Matrix* b );
/*************************************************************************/
@@ -396,7 +409,7 @@
/* <MT-Note> */
/* Yes. */
/* */
- FT_EXPORT_DEF(FT_Error) FT_Matrix_Invert( FT_Matrix* matrix );
+ FT_EXPORT_DEF( FT_Error ) FT_Matrix_Invert( FT_Matrix* matrix );
#ifdef __cplusplus
@@ -404,3 +417,6 @@
#endif
#endif /* FTGLYPH_H */
+
+
+/* END */
diff --git a/include/freetype/internal/psnames.h b/include/freetype/internal/psnames.h
index 282a2b0..bb3e658 100644
--- a/include/freetype/internal/psnames.h
+++ b/include/freetype/internal/psnames.h
@@ -163,7 +163,7 @@
* this structure holds pointers to the functions used to load and
* free the basic tables that are required in a `sfnt' font file.
*
- * <Field>
+ * <Fields>
* unicode_value :: a function used to convert a glyph name into
* a Unicode character code
*
diff --git a/src/base/ftglyph.c b/src/base/ftglyph.c
index 3bbc73a..4052e6e 100644
--- a/src/base/ftglyph.c
+++ b/src/base/ftglyph.c
@@ -633,6 +633,8 @@
/* bbox.xMax = CEILING(bbox.xMax); */
/* bbox.yMax = CEILING(bbox.yMax); */
/* */
+ /* The default value (0) for `bbox_mode' is `ft_glyph_bbox_pixels'. */
+ /* */
FT_EXPORT_FUNC( void ) FT_Glyph_Get_CBox( FT_Glyph glyph,
FT_UInt bbox_mode,
FT_BBox* cbox )