Cosmetics: add some comments.

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@19972 b3059339-0415-0410-9bf9-f77b7e298cf2

diff --git a/libass/ass_bitmap.c b/libass/ass_bitmap.c
index 8eee401205a2c23fc05fc613c301acec9caef3d8..7a587947f295207760e01e7d5d86520e286bb1c9 100644 (file)
--- a/libass/ass_bitmap.c
+++ b/libass/ass_bitmap.c
@@ -174,6 +174,12 @@ static bitmap_t* glyph_to_bitmap_internal(FT_Glyph glyph, int bord)
        return bm;
 }
 
+/**
+ * \brief fix outline bitmap and generate shadow bitmap
+ * Two things are done here:
+ * 1. Glyph bitmap is subtracted from outline bitmap. This way looks much better in some cases.
+ * 2. Shadow bitmap is created as a sum of glyph and outline bitmaps.
+ */
 static bitmap_t* fix_outline_and_shadow(bitmap_t* bm_g, bitmap_t* bm_o)
 {
        int x, y;

diff --git a/libass/ass_bitmap.h b/libass/ass_bitmap.h
index 0cf2eb2cb1f749cf4ea3cf533631ea493192ce22..9b5d75d9f7890ae72faa7aa9bbe3dec5331c4360 100644 (file)
--- a/libass/ass_bitmap.h
+++ b/libass/ass_bitmap.h
@@ -12,7 +12,17 @@ typedef struct bitmap_s {
        unsigned char* buffer; // w x h buffer
 } bitmap_t;
 
+/**
+ * \brief perform glyph rendering
+ * \param glyph original glyph
+ * \param outline_glyph "border" glyph, produced from original by FreeType's glyph stroker
+ * \param bm_g out: pointer to the bitmap of original glyph is returned here
+ * \param bm_o out: pointer to the bitmap of outline (border) glyph is returned here
+ * \param bm_g out: pointer to the bitmap of glyph shadow is returned here
+ * \param be 1 = produces blurred bitmaps, 0 = normal bitmaps
+ */
 int glyph_to_bitmap(ass_synth_priv_t* priv, FT_Glyph glyph, FT_Glyph outline_glyph, bitmap_t** bm_g, bitmap_t** bm_o, bitmap_t** bm_s, int be);
+
 void ass_free_bitmap(bitmap_t* bm);
 
 #endif