Rename Image.getPixel() to .getPixelF() as per discussion
authorStephen Swaney <sswaney@centurytel.net>
Sun, 22 May 2005 18:43:29 +0000 (18:43 +0000)
committerStephen Swaney <sswaney@centurytel.net>
Sun, 22 May 2005 18:43:29 +0000 (18:43 +0000)
 to match OpenGl conventions and prepare for integer versions.

source/blender/python/api2_2x/Image.c
source/blender/python/api2_2x/doc/Image.py

index f485d80200cadfda28698d660c228203abf1f390..87d7bfbcc8b2e69488318794f1cfccfc5be2cc85 100644 (file)
@@ -213,12 +213,13 @@ static PyObject *M_Image_Load( PyObject * self, PyObject * args )
 
 
 /**
- * getPixel( x, y )
- *  returns float list of pixel colors in rgba order
+ * getPixelF( x, y )
+ *  returns float list of pixel colors in rgba order.
+ *  returned values are floats normalized to 0.0 - 1.0.
  *  blender images are all 4x8 bit at the moment apr-2005
  */
 
-static PyObject *Image_getPixel( BPy_Image * self, PyObject * args )
+static PyObject *Image_getPixelF( BPy_Image * self, PyObject * args )
 {
 
        PyObject *attr;
@@ -329,7 +330,7 @@ static PyObject *Image_setYRep( BPy_Image * self, PyObject * args );
 static PyObject *Image_reload( BPy_Image * self );
 static PyObject *Image_glLoad( BPy_Image * self );
 static PyObject *Image_glFree( BPy_Image * self );
-static PyObject *Image_getPixel( BPy_Image * self, PyObject * args );
+static PyObject *Image_getPixelF( BPy_Image * self, PyObject * args );
 static PyObject *Image_getMaxXY( BPy_Image * self );
 
 /*****************************************************************************/
@@ -337,7 +338,7 @@ static PyObject *Image_getMaxXY( BPy_Image * self );
 /*****************************************************************************/
 static PyMethodDef BPy_Image_methods[] = {
        /* name, method, flags, doc */
-       {"getPixel", ( PyCFunction ) Image_getPixel, METH_VARARGS,
+       {"getPixelF", ( PyCFunction ) Image_getPixelF, METH_VARARGS,
         "(float, float) - Get colors of specified pixel as [r,g,b,a]"},
        {"getMaxXY", ( PyCFunction ) Image_getMaxXY, METH_VARARGS,
         "() - Get maximum x & y coordinates of current image as [x, y]"},
index 4ebd6721c545d3920a0064e0323907d4f07e4a11..a7b2cb693eb2f0f1062d0f526239beaec9da874e 100644 (file)
@@ -94,9 +94,10 @@ class Image:
     @rtype: int
     """
 
-  def getPixel(x, y):
+  def getPixelF(x, y):
     """
        Get the the colors of the current pixel in the form [r,g,b,a].
+       Returned values are floats normalized to 0.0 - 1.0.
        Pixel coordinates are in the range from 0 to N-1.  See L{getMaxXY}
        @returns: [ r, g, b, a]
        @rtype: list of 4 floats