freetype/docs
Alexei Podtelezhnikov e8f0969dcf [base, smooth] Remove LCD filter from face properties.
This removes the internal face property that sets the filtering weights.
The global filtering algorithms and weights are now optimized to work
well under all conditions.

* include/freetype/internal/ftobjs.h (FT_Face_InternalRec): Do it.
* include/freetype/freetype.h (FT_Face_Properties): Revised docs.
* include/freetype/ftparams.h (FT_PARAM_TAG_LCD_FILTER_WEIGHTS): Ditto.
* src/base/ftlcdfil.c (ft_lcd_padding): Updated.
* src/base/ftobjs.c (ft_open_face_internal, FT_Face_Properties): Ditto.
* src/smooth/ftsmooth.c (ft_smooth_render): Ditto.
* docs/CHANGES: Updated.
2026-01-25 15:00:08 -05:00
..
markdown Fix various typos. 2024-08-13 23:29:13 -04:00
oldlogs Update all copyright notices. 2025-09-06 06:14:03 +02:00
.gitignore [docs] (1/2) Move static web assets (#56745). 2019-12-21 19:13:37 +01:00
CHANGES [base, smooth] Remove LCD filter from face properties. 2026-01-25 15:00:08 -05:00
CMAKE * docs/CMAKE: New dummy file. 2013-11-10 06:26:52 +01:00
CUSTOMIZE Update all copyright notices. 2025-09-06 06:14:03 +02:00
DEBUG Update all copyright notices. 2025-09-06 06:14:03 +02:00
DOCGUIDE Update all copyright notices. 2025-09-06 06:14:03 +02:00
formats.txt Improve documentation of the 'BDF ' table as used in X11 .otb files. 2025-12-04 07:46:36 +01:00
freetype-config.1 * Version 2.14.1 released. 2025-09-11 13:16:53 +02:00
freetype-web.txt * docs/*: Typos. 2023-11-25 09:00:11 -05:00
FTL.TXT Replace 'www.freetype.org' with 'freetype.org'. 2025-06-03 10:35:16 +02:00
GPLv2.TXT Update license documentation. 2011-06-18 08:06:57 +02:00
INSTALL Update all copyright notices. 2025-09-06 06:14:03 +02:00
INSTALL.ANY Update all copyright notices. 2025-09-06 06:14:03 +02:00
INSTALL.CROSS Update all copyright notices. 2025-09-06 06:14:03 +02:00
INSTALL.GNU Update all copyright notices. 2025-09-06 06:14:03 +02:00
INSTALL.MAC Minor documentation updates. 2017-01-13 10:33:09 +01:00
INSTALL.UNIX Update all copyright notices. 2025-09-06 06:14:03 +02:00
INSTALL.VMS Update all copyright notices. 2025-09-06 06:14:03 +02:00
MAKEPP Fix links (mostly http -> https). 2018-12-25 22:44:05 +01:00
PROBLEMS * docs/PROBLEMS: Mention rendering differences on different 2011-02-24 20:01:00 +01:00
raster.txt Update all copyright notices. 2025-09-06 06:14:03 +02:00
README * Version 2.13.1 released. 2023-06-24 08:11:05 +02:00
release Typo. 2025-09-14 11:05:41 +02:00
TODO Update all copyright notices. 2025-09-06 06:14:03 +02:00
VERSIONS.TXT * Version 2.14.1 released. 2025-09-11 13:16:53 +02:00

After saying `make refdoc' or `make refdoc-venv' the `reference/' directory
contains the FreeType API reference.  You need Python >= 3.5 and pip to make
this target.

There are two ways to generate the documentation:

1. Using `make refdoc':

    - Ensure `python' and `pip' are available.
    - Install pip package `docwriter' with `pip install --user docwriter'.
    - Make target with `make refdoc'.
    - This target can be run offline once required packages are installed.

2. Using `make refdoc-venv' (requires internet access):

    - Ensure `python', `pip' and Python package `virtualenv' are available.
    - Make target with `make refdoc-venv'.
    - This may or may not require internet access every time depending on
    pip and system caching.

Some troubleshooting tips:

* Regularly run `pip install --upgrade docwriter' to check for updates which
may include bug fixes.

* `Docwriter' does not support Python 2.  Ensure that Python >= 3.5 is
installed and available as `python3'/`python'.

* Ensure that `docwriter' is installed in the same Python target that
`make refdoc' uses (python3/python).

* If none of this works, send a mail to `freetype-devel@nongnu.org' or file
an issue at `https://github.com/freetype/docwriter/issues'.