[AD] getpixel() documentation

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


A thread came up on allegro.cc (
http://www.allegro.cc/forums/thread/574279 ) that suggested a possible
improvement on the documentation of getpixel().

Attached is a diff that adds "see also" links to getr, getg, getb and
geta, as well as an explicit mention on how to extract the individual
color components of the value returned from getpixel().

/T

--
Feed me a stray cat.
--- allegro._tx.old	Thu Mar 23 16:09:56 2006
+++ allegro._tx	Thu Mar 23 16:11:43 2006
@@ -5993,7 +5993,7 @@
    mode.
 
 @@int @getpixel(BITMAP *bmp, int x, int y);
-@domain.hid putpixel, _getpixel, is_inside_bitmap
+@xref putpixel, _getpixel, is_inside_bitmap, getr, getg, getb, geta
 @eref ex12bit, exalpha, exflame, exlights
 @shortdesc Reads a pixel from a bitmap.
    Reads a pixel from point (x, y) in the bitmap.
@@ -6007,6 +6007,8 @@
    the test against -1 as a predicate for such bitmaps. In this cases, the
    only reliable predicate is is_inside_bitmap().
 
+   To extract the individual color components, use the getr() / getg() /
+   getb() / geta() family of functions.
 @@int @_getpixel(BITMAP *bmp, int x, int y);
 @@int @_getpixel15(BITMAP *bmp, int x, int y);
 @@int @_getpixel16(BITMAP *bmp, int x, int y);




Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/