summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2023-02-16 06:35:33 +0100
committerWerner Lemberg <wl@gnu.org>2023-02-16 06:35:33 +0100
commit0eca6ead82b4e6f739b57e49a3029d0b31fd1652 (patch)
treee557ce5a3157f073ca597534f09a22dc61ffafd6
parentdacbb55433079fb3539163862958a6b9466a0661 (diff)
downloadfreetype2-0eca6ead82b4e6f739b57e49a3029d0b31fd1652.tar.gz
Documentation improvement for `FT_Bitmap`.
Fixes #1205.
-rw-r--r--include/freetype/ftimage.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index 2e8e6734c..738b515ed 100644
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -19,7 +19,7 @@
/**************************************************************************
*
* Note: A 'raster' is simply a scan-line converter, used to render
- * FT_Outlines into FT_Bitmaps.
+ * `FT_Outline`s into `FT_Bitmap`s.
*
*/
@@ -256,6 +256,12 @@ FT_BEGIN_HEADER
* palette ::
* A typeless pointer to the bitmap palette; this field is intended for
* paletted pixel modes. Not used currently.
+ *
+ * @note:
+ * `width` and `rows` refer to the *physical* size of the bitmap, not the
+ * *logical* one. For example, if @FT_Pixel_Mode is set to
+ * `FT_PIXEL_MODE_LCD`, the logical width is a just a third of the
+ * physical one.
*/
typedef struct FT_Bitmap_
{