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

ftbitmap.h: Improve documentation.

This commit is contained in:
Werner Lemberg 2018-08-23 13:13:20 +02:00
parent 45524679c6
commit c90cc6443b
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/freetype/ftbitmap.h
View File

@ -46,10 +46,16 @@ FT_BEGIN_HEADER
* Handling FT_Bitmap objects.
*
* @description:
* This section contains functions for handling @FT_Bitmap objects.
* Note that none of the functions changes the bitmap's `flow' (as
* indicated by the sign of the `pitch' field in `FT_Bitmap').
* This section contains functions for handling @FT_Bitmap objects,
* automatically adjusting the target's bitmap buffer size as needed.
*
* Note that none of the functions changes the bitmap's `flow' (as
* indicated by the sign of the `pitch' field in @FT_Bitmap).
*
* To set the flow, assign an appropriate positive or negative value to
* the `pitch' field of the target @FT_Bitmap object after calling
* @FT_Bitmap_Init but before calling any of the other functions
* described here.
*/
@ -98,6 +104,10 @@ FT_BEGIN_HEADER
*
* @return:
* FreeType error code. 0~means success.
*
* @note:
* `source->buffer' and `target->buffer' must neither be equal nor
* overlap.
*/
FT_EXPORT( FT_Error )
FT_Bitmap_Copy( FT_Library library,
@ -187,6 +197,9 @@ FT_BEGIN_HEADER
*
* The `library' argument is taken to have access to FreeType's
* memory handling functions.
*
* `source->buffer' and `target->buffer' must neither be equal nor
* overlap.
*/
FT_EXPORT( FT_Error )
FT_Bitmap_Convert( FT_Library library,
@ -241,6 +254,9 @@ FT_BEGIN_HEADER
* `4~*~width'. Both `source' and `target' must have the same bitmap
* flow (as indicated by the sign of the `pitch' field).
*
* `source->buffer' and `target->buffer' must neither be equal nor
* overlap.
*
* @since:
* 2.10
*/