From f434e299067c8d7ae43fbb6e021b283c3f2303c8 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Sat, 21 Aug 2010 09:01:51 +0200 Subject: [PATCH] In the documentation, explain what `padding' means. --- include/freetype/ftimage.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h index 0272e92d2..04b5e04f7 100644 --- a/include/freetype/ftimage.h +++ b/include/freetype/ftimage.h @@ -268,9 +268,21 @@ FT_BEGIN_HEADER /* flow. In all cases, the pitch is an offset to add */ /* to a bitmap pointer in order to go down one row. */ /* */ + /* Note that `padding' means the alignment of a */ + /* bitmap to a byte border, and FreeType functions */ + /* normally align to the smallest possible integer */ + /* value. */ + /* */ /* For the B/W rasterizer, `pitch' is always an even */ /* number. */ /* */ + /* To change the pitch of a bitmap (say, to make it a */ + /* multiple of 4), use @FT_Bitmap_Convert. */ + /* Alternatively, you might use callback functions to */ + /* directly render to the application's surface; see */ + /* the file `example2.cpp' in the tutorial for a */ + /* demonstration. */ + /* */ /* buffer :: A typeless pointer to the bitmap buffer. This */ /* value should be aligned on 32-bit boundaries in */ /* most cases. */