ref: 432bb50ff539e7672723dc9161e44046710a1334
parent: 6abce2c2b04a14bd711d5d0fee3ba23e9612a747
author: Alexei Podtelezhnikov <[email protected]>
date: Tue Apr 23 17:51:42 EDT 2019
Clarify docs.
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -945,8 +945,8 @@
* This flag is set to indicate direct rendering. In this mode, client
* applications must provide their own span callback. This lets them
* directly draw or compose over an existing bitmap. If this bit is
- * not set, the target pixmap's buffer _must_ be zeroed before
- * rendering.
+ * _not_ set, the target pixmap's buffer _must_ be zeroed before
+ * rendering and the output will be clipped to its size.
*
* Direct rendering is only possible with anti-aliased glyphs.
*
@@ -953,11 +953,8 @@
* FT_RASTER_FLAG_CLIP ::
* This flag is only used in direct rendering mode. If set, the output
* will be clipped to a box specified in the `clip_box` field of the
- * @FT_Raster_Params structure.
- *
- * Note that by default, the glyph bitmap is clipped to the target
- * pixmap, except in direct rendering mode where all spans are
- * generated if no clipping box is set.
+ * @FT_Raster_Params structure. Otherwise, the `clip_box` is
+ * effectively set to the bounding box and all spans are generated.
*/
#define FT_RASTER_FLAG_DEFAULT 0x0
#define FT_RASTER_FLAG_AA 0x1