rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Formatting, documentation improvements.

This commit is contained in:
Werner Lemberg 2005-12-23 15:10:54 +00:00
parent e6bb95336a
commit 083ba0b7bc
6 changed files with 261 additions and 250 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
ChangeLog
View File

@ -1,27 +1,28 @@
2005-12-23 David Turner <david@freetype.org> 2005-12-23 David Turner <david@freetype.org>
* Jamfile, docs/reference/README: fix it so that "jam refdoc" works * Jamfile (RefDoc), docs/reference/README: Fix it so that `jam
correctly to generate the API reference in 'docs/reference' refdoc' works correctly to generate the API reference in
`docs/reference'.
* src/tools/docmaker/tohtml.py: update to output nicer fields lists * src/tools/docmaker/tohtml.py (print_html_field,
in the API reference print_html_field_list): Update to output nicer fields lists in the
API reference.
* src/base/ftobjs.c (FT_Load_Glyph): FT_LOAD_TARGET_LIGHT now * src/base/ftobjs.c (FT_Load_Glyph): FT_LOAD_TARGET_LIGHT now
forces auto-hinting forces auto-hinting.
* freetype/freetype.h: updating the documentation for
FT_LOAD_TARGET_XXX and FT_Render_Mode values
* freetype/freetype.h: Updating the documentation for
FT_LOAD_TARGET_XXX and FT_Render_Mode values.
2005-12-23 suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp> 2005-12-23 suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp>
* src/base/ftmac.c (FT_New_Face_From_Suitcase): Counts scalable * src/base/ftmac.c (FT_New_Face_From_Suitcase): Count scalable faces
faces in supported formats (sfnt, LWFN) only, and ignore bitmap in supported formats (sfnt, LWFN) only, and ignore bitmap faces in
faces in unsupported formats (fbit, NFNT). The number of available unsupported formats (fbit, NFNT). The number of available faces are
faces are passed via face->num_faces. When bitmap faces are embedded passed via face->num_faces. If bitmap faces are embedded in sfnt
in sfnt resource, face->num_fixed_size is correctly set. In public resource, face->num_fixed_size is correctly set. In public API,
API, FT_New_Face() and FT_New_Face_From_FSSpec() count the faces FT_New_Face() and FT_New_Face_From_FSSpec() count the faces as
as FT_GetFile_From_Mac_Name(), which ignores NFNT resources. FT_GetFile_From_Mac_Name(), which ignores NFNT resources.
* doc/CHANGES: Mention the changes. * doc/CHANGES: Mention the changes.

26
docs/CHANGES
View File

@ -14,9 +14,9 @@ LATEST CHANGES BETWEEN 2.2.0 and 2.1.10
II. IMPORTANT CHANGES II. IMPORTANT CHANGES
- the LIGHT hinting algorithm produces more pleasant results. Also, - The LIGHT hinting algorithm produces more pleasant results.
using the FT_LOAD_TARGET_LIGHT flags within FT_Load_Glyph will always Also, using the FT_LOAD_TARGET_LIGHT flags within FT_Load_Glyph
force auto-hinting, as a special exception. always forces auto-hinting, as a special exception.
- Face metrics (face->size->metrics) and glyph metrics are no - Face metrics (face->size->metrics) and glyph metrics are no
longer rounded. If you do not round in your applications too, longer rounded. If you do not round in your applications too,
@ -47,15 +47,15 @@ LATEST CHANGES BETWEEN 2.2.0 and 2.1.10
III. MISCELLANEOUS III. MISCELLANEOUS
- the documentation for FT_LOAD_TARGET_XXX and FT_RENDER_MODE_XXX - The documentation for FT_LOAD_TARGET_XXX and FT_RENDER_MODE_XXX
values have been updated to better reflect their uses and differences values now better reflects its usage and differences: One set is
(one set is used to specify hinting algorithm, the other to specify used to specify the hinting algorithm, the other to specify pthe
pixel rendering mode). ixel rendering mode.
- FT_New_Face() & FT_New_Face_From_FSSpec() in ftmac.c are changed - FT_New_Face() and FT_New_Face_From_FSSpec() in ftmac.c are
to count supported scalable faces (sfnt, LWFN) only, and returns changed to count supported scalable faces (sfnt, LWFN) only, and
the number of available faces via face->num_faces. Unsupported returns the number of available faces via face->num_faces.
bitmap faces (fbit, NFNT) are ignored. Unsupported bitmap faces (fbit, NFNT) are ignored.
- SFNT cmap handling has been improved, mainly to run faster. - SFNT cmap handling has been improved, mainly to run faster.
@ -70,8 +70,8 @@ LATEST CHANGES BETWEEN 2.2.0 and 2.1.10
for better readability. for better readability.
- FreeType now honours bit 1 in the `head' table of TrueType fonts - FreeType now honours bit 1 in the `head' table of TrueType fonts
(meaning `left sidebearing point at x=0'). This helps with (meaning `left sidebearing point at x=0'). This helps with some
some buggy fonts. buggy fonts.
- Rudimentary support for Adobe's new `SING Glyphlet' format. See - Rudimentary support for Adobe's new `SING Glyphlet' format. See

2
docs/reference/README
View File

@ -1,5 +1,5 @@
After saying `make refdoc' this directory contains the FreeType API After saying `make refdoc' this directory contains the FreeType API
reference. You need python to make this target. reference. You need python to make this target.
This also works with Jam, just type 'jam refdoc' in the main directory. This also works with Jam: Just type `jam refdoc' in the main directory.

135
include/freetype/freetype.h
View File

@ -2248,29 +2248,30 @@ FT_BEGIN_HEADER
FT_Int32 load_flags ); FT_Int32 load_flags );
/*************************************************************************** /*************************************************************************
* *
* @enum: * @enum:
* FT_LOAD_XXX * FT_LOAD_XXX
* *
* @description: * @description:
* A list of bit-field constants, used with @FT_Load_Glyph to indicate * A list of bit-field constants used with @FT_Load_Glyph to indicate
* what kind of operations to perform during glyph loading. * what kind of operations to perform during glyph loading.
* *
* @values: * @values:
* FT_LOAD_DEFAULT :: * FT_LOAD_DEFAULT ::
* Corresponding to 0, this value is used a default glyph load. In this * Corresponding to 0, this value is used as the default glyph load
* case, the following happens: * operation. In this case, the following happens:
* *
* 1. FreeType looks for a bitmap for the glyph corresponding to the * 1. FreeType looks for a bitmap for the glyph corresponding to the
* face's current size. If one is found, the function returns. The * face's current size. If one is found, the function returns.
* bitmap data can be accessed from the glyph slot (see note below). * The bitmap data can be accessed from the glyph slot (see note
* below).
* *
* 2. If no embedded bitmap is searched or found, FreeType looks for a * 2. If no embedded bitmap is searched or found, FreeType looks for a
* scalable outline. If one is found, it is loaded from the font * scalable outline. If one is found, it is loaded from the font
* file, scaled to device pixels, then `hinted' to the pixel grid in * file, scaled to device pixels, then `hinted' to the pixel grid
* order to optimize it. The outline data can be accessed from the * in order to optimize it. The outline data can be accessed from
* glyph slot (see note below). * the glyph slot (see note below).
* *
* Note that by default, the glyph loader doesn't render outlines into * Note that by default, the glyph loader doesn't render outlines into
* bitmaps. The following flags are used to modify this default * bitmaps. The following flags are used to modify this default
@ -2279,8 +2280,9 @@ FT_BEGIN_HEADER
* FT_LOAD_NO_SCALE :: * FT_LOAD_NO_SCALE ::
* Don't scale the vector outline being loaded to 26.6 fractional * Don't scale the vector outline being loaded to 26.6 fractional
* pixels, but kept in font units. Note that this also disables * pixels, but kept in font units. Note that this also disables
* hinting and the loading of embedded bitmaps. You should only use it * hinting and the loading of embedded bitmaps. You should only use
* when you want to retrieve the original glyph outlines in font units. * it when you want to retrieve the original glyph outlines in font
* units.
* *
* FT_LOAD_NO_HINTING :: * FT_LOAD_NO_HINTING ::
* Don't hint glyph outlines after their scaling to device pixels. * Don't hint glyph outlines after their scaling to device pixels.
@ -2302,32 +2304,33 @@ FT_BEGIN_HEADER
* *
* FT_LOAD_NO_BITMAP :: * FT_LOAD_NO_BITMAP ::
* Don't look for bitmaps when loading the glyph. Only scalable * Don't look for bitmaps when loading the glyph. Only scalable
* outlines are loaded when available, and scaled, hinted, or * outlines are loaded when available, and scaled, hinted, or rendered
* rendered depending on other bit flags. * depending on other bit flags.
* *
* This does not prevent you from rendering outlines to bitmaps * This does not prevent you from rendering outlines to bitmaps with
* with @FT_LOAD_RENDER, however. * @FT_LOAD_RENDER, however.
* *
* FT_LOAD_VERTICAL_LAYOUT :: * FT_LOAD_VERTICAL_LAYOUT ::
* Prepare the glyph image for vertical text layout. This basically * Prepare the glyph image for vertical text layout. This basically
* means that `face.glyph.advance' corresponds to the vertical * means that `face.glyph.advance' corresponds to the vertical advance
* advance height (instead of the default horizontal advance width), * height (instead of the default horizontal advance width), and that
* and that the glyph image is translated to match the vertical * the glyph image is translated to match the vertical bearings
* bearings positions. * positions.
* *
* FT_LOAD_FORCE_AUTOHINT :: * FT_LOAD_FORCE_AUTOHINT ::
* Force the use of the FreeType auto-hinter when a glyph outline is * Force the use of the FreeType auto-hinter when a glyph outline is
* loaded. You shouldn't need this in a typical application, since it * loaded. You shouldn't need this in a typical application, since it
* is mostly used to experiment with its algorithm. * is mostly used to experiment with its algorithm.
* *
* See also FT_FACE_FLAG_HINTER (@FT_FACE_FLAG_XXX), FT_LOAD_NO_HINTING * See also FT_FACE_FLAG_HINTER (@FT_FACE_FLAG_XXX),
* above, and FT_LOAD_NO_AUTOHINT below. * FT_LOAD_NO_HINTING above, and FT_LOAD_NO_AUTOHINT below.
* *
* FT_LOAD_CROP_BITMAP :: * FT_LOAD_CROP_BITMAP ::
* Indicates that the glyph loader should try to crop the bitmap (i.e., * Indicates that the glyph loader should try to crop the bitmap
* remove all space around its black bits) when loading it. This is * (i.e., remove all space around its black bits) when loading it.
* only useful when loading embedded bitmaps in certain fonts, since * This is only useful when loading embedded bitmaps in certain fonts,
* bitmaps rendered with @FT_LOAD_RENDER are always cropped by default. * since bitmaps rendered with @FT_LOAD_RENDER are always cropped by
* default.
* *
* FT_LOAD_PEDANTIC :: * FT_LOAD_PEDANTIC ::
* Indicates that the glyph loader should perform pedantic * Indicates that the glyph loader should perform pedantic
@ -2345,9 +2348,9 @@ FT_BEGIN_HEADER
* *
* FT_LOAD_NO_RECURSE :: * FT_LOAD_NO_RECURSE ::
* This flag is only used internally. It merely indicates that the * This flag is only used internally. It merely indicates that the
* glyph loader should not load composite glyphs recursively. Instead, * glyph loader should not load composite glyphs recursively.
* it should set the `num_subglyph' and `subglyphs' values of the glyph * Instead, it should set the `num_subglyph' and `subglyphs' values of
* slot accordingly, and set "glyph->format" to * the glyph slot accordingly, and set "glyph->format" to
* @FT_GLYPH_FORMAT_COMPOSITE. * @FT_GLYPH_FORMAT_COMPOSITE.
* *
* The description of sub-glyphs is not available to client * The description of sub-glyphs is not available to client
@ -2356,11 +2359,11 @@ FT_BEGIN_HEADER
* FT_LOAD_IGNORE_TRANSFORM :: * FT_LOAD_IGNORE_TRANSFORM ::
* Indicates that the glyph loader should not try to transform the * Indicates that the glyph loader should not try to transform the
* loaded glyph image. This doesn't prevent scaling, hinting, or * loaded glyph image. This doesn't prevent scaling, hinting, or
* rendering. See @FT_Set_Transform * rendering. See @FT_Set_Transform.
* *
* FT_LOAD_MONOCHROME :: * FT_LOAD_MONOCHROME ::
* This flag is used with @FT_LOAD_RENDER to indicate that you want * This flag is used with @FT_LOAD_RENDER to indicate that you want to
* to render a 1-bit monochrome glyph bitmap from a vectorial outline. * render a 1-bit monochrome glyph bitmap from a vectorial outline.
* *
* Note that this has no effect on the hinting algorithm used by the * Note that this has no effect on the hinting algorithm used by the
* glyph loader. You should better use @FT_LOAD_TARGET_MONO if you * glyph loader. You should better use @FT_LOAD_TARGET_MONO if you
@ -2380,7 +2383,7 @@ FT_BEGIN_HEADER
* and FT_LOAD_NO_HINTING above. * and FT_LOAD_NO_HINTING above.
* *
* @note: * @note:
* see also @FT_LOAD_TARGET_XXX which relate to hinting algorithm * See also @FT_LOAD_TARGET_XXX which relates to the hinting algorithm
* selection. * selection.
*/ */
#define FT_LOAD_DEFAULT 0x0 #define FT_LOAD_DEFAULT 0x0
@ -2404,62 +2407,65 @@ FT_BEGIN_HEADER
/* */ /* */
/************************************************************************** /**************************************************************************
* *
* @enum: FT_LOAD_TARGET_XXX * @enum:
* FT_LOAD_TARGET_XXX
* *
* @description: * @description:
* a list of values that are used to select a specific hinting * A list of values that are used to select a specific hinting algorithm
* algorithm to the glyph loader. You should OR one of these values * to the glyph loader. You should OR one of these values to your
* to your 'load_flags' when calling @FT_Load_Glyph. * `load_flags' when calling @FT_Load_Glyph.
* *
* note that these values are only used by the auto-hinter, and ignored * Note that these values are only used by the auto-hinter, and ignored
* by the native ones (e.g. the TrueType bytecode interpreter). You * by other hinting engines (e.g., the TrueType bytecode interpreter).
* must use @FT_LOAD_FORCE_AUTOHINT to ensure that they're always used. * You must use @FT_LOAD_FORCE_AUTOHINT to ensure that they are always
* used.
* *
* @FT_LOAD_TARGET_LIGHT being an exception, that always forces the * @FT_LOAD_TARGET_LIGHT is an exception, since it always forces the
* auto-hinter. * auto-hinter.
* *
* @values: * @values:
* FT_LOAD_TARGET_NORMAL :: * FT_LOAD_TARGET_NORMAL ::
* correspond to the default hinting algorithm, optimized for standard * This corresponds to the default hinting algorithm, optimized for
* gray-level rendering. for monochrome output, use @FT_RENDER_MODE_MONO * standard gray-level rendering. For monochrome output, use
* instead. * @FT_RENDER_MODE_MONO instead.
* *
* FT_LOAD_TARGET_LIGHT :: * FT_LOAD_TARGET_LIGHT ::
* correspond to a lighter hinting algorithm for non-monochrome modes. * A lighter hinting algorithm for non-monochrome modes. Many
* This will generate more glyphs that are more fuzzy but more faithful * generated glyphs are more fuzzy but better resemble its original
* to their original shape. A bit like Mac OS X. * shape. A bit like rendering on Mac OS X.
* *
* As a special exception, this values *always* forces auto-hinting, * As a special exception, this values *always* forces auto-hinting,
* whatever the native hinter is. * whatever the native hinter is.
* *
* FT_LOAD_TARGET_MONO :: * FT_LOAD_TARGET_MONO ::
* strong hinting algorithm that should only be used for monochrome * Strong hinting algorithm that should only be used for monochrome
* output. The result will probably be unpleasant for other rendering * output. The result will probably be unpleasant for other rendering
* modes. * modes.
* *
* FT_LOAD_TARGET_LCD :: * FT_LOAD_TARGET_LCD ::
* a variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
* decimated LCD displays. * decimated LCD displays.
* *
* FT_LOAD_TARGET_LCD_V :: * FT_LOAD_TARGET_LCD_V ::
* a variant of @FT_LOAD_TARGET_NORMAL optimized for vertically decimated * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
* LCD displays. * decimated LCD displays.
* *
* @note: * @note:
* You should use only _one_ of the FT_LOAD_TARGET_XXX values in your * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
* 'load_flags'. They can't be ORed. * `load_flags'. They can't be ORed.
* *
* If you also use the @FT_LOAD_RENDER flag, then the output will be * If you also use the @FT_LOAD_RENDER flag, then the output will be
* determined by the corresponding @FT_Render_Mode value. E.g. * determined by the corresponding @FT_Render_Mode value. For example,
* @FT_LOAD_TARGET_NORMAL will generate a gray-level pixmap * @FT_LOAD_TARGET_NORMAL generates a gray-level pixmap
* (see @FT_RENDER_MODE_NORMAL) * (see @FT_RENDER_MODE_NORMAL).
* *
* You can use a hinting algorithm that doesn't correspond to the same * You can use a hinting algorithm that doesn't correspond to the same
* rendering mode. For example, it is possible to use the `light' hinting * rendering mode. As an example, it is possible to use the `light'
* algorithm and have the results rendered in horizontal LCD pixel mode, * hinting algorithm and have the results rendered in horizontal LCD
* with code like this: * pixel mode, with code like
* *
* { * {
* FT_Load_Glyph( face, glyph_index, * FT_Load_Glyph( face, glyph_index,
@ -2477,13 +2483,16 @@ FT_BEGIN_HEADER
#define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD ) #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD )
#define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V ) #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V )
/**
* @macro: FT_LOAD_TARGET_MODE /*
* @macro:
* FT_LOAD_TARGET_MODE
* *
* @description: * @description:
* return the @FT_Render_Mode corresponding to a given @FT_LOAD_TARGET_XXX * Return the @FT_Render_Mode corresponding to a given
* value. * @FT_LOAD_TARGET_XXX value.
*/ */
#define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) ) #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
/* */ /* */
@ -2540,8 +2549,8 @@ FT_BEGIN_HEADER
/* anti-aliased bitmaps, using 256 levels of opacity. */ /* anti-aliased bitmaps, using 256 levels of opacity. */
/* */ /* */
/* FT_RENDER_MODE_LIGHT :: */ /* FT_RENDER_MODE_LIGHT :: */
/* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only defined */ /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */
/* as a separate value because render modes are also used */ /* defined as a separate value because render modes are also used */
/* indirectly to define hinting algorithm selectors. See */ /* indirectly to define hinting algorithm selectors. See */
/* @FT_LOAD_TARGET_XXX for details. */ /* @FT_LOAD_TARGET_XXX for details. */
/* */ /* */

2
src/base/ftmac.c
View File

@ -24,7 +24,7 @@
functions, and pretend the suitcase file is a collection. functions, and pretend the suitcase file is a collection.
Warning: fbit and NFNT bitmap resources are not supported yet. Warning: fbit and NFNT bitmap resources are not supported yet.
In old sfnt fonts, bitmap glyph data for each sizes are stored in In old sfnt fonts, bitmap glyph data for each size is stored in
each NFNT resources, instead of bdat table in sfnt resource. each NFNT resources, instead of bdat table in sfnt resource.
Therefore, face->num_fixed_sizes is set to 0, because bitmap Therefore, face->num_fixed_sizes is set to 0, because bitmap
data in NFNT resource is unavailable at present. data in NFNT resource is unavailable at present.

3
src/base/ftobjs.c
View File

@ -525,7 +525,8 @@
FT_DRIVER_USES_OUTLINES( driver ) ); FT_DRIVER_USES_OUTLINES( driver ) );
/* force auto-hinting for the LIGHT hinting mode */ /* force auto-hinting for the LIGHT hinting mode */
if ( autohint && FT_LOAD_TARGET_MODE(load_flags) == FT_RENDER_MODE_LIGHT ) if ( autohint &&
FT_LOAD_TARGET_MODE( load_flags ) == FT_RENDER_MODE_LIGHT )
load_flags |= FT_LOAD_FORCE_AUTOHINT; load_flags |= FT_LOAD_FORCE_AUTOHINT;
if ( autohint ) if ( autohint )