changeset 19966:27187c1ac20b

Cosmetics: add some comments.
author eugeni
date Sun, 24 Sep 2006 16:15:47 +0000
parents 70352570e9ae
children e3ced2d5bc13
files libass/ass_bitmap.c libass/ass_bitmap.h
diffstat 2 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libass/ass_bitmap.c	Sun Sep 24 16:04:37 2006 +0000
+++ b/libass/ass_bitmap.c	Sun Sep 24 16:15:47 2006 +0000
@@ -174,6 +174,12 @@
 	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;
--- a/libass/ass_bitmap.h	Sun Sep 24 16:04:37 2006 +0000
+++ b/libass/ass_bitmap.h	Sun Sep 24 16:15:47 2006 +0000
@@ -12,7 +12,17 @@
 	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