diff options
author | Campbell Barton <ideasman42@gmail.com> | 2008-03-12 14:13:57 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2008-03-12 14:13:57 +0300 |
commit | af93553640edda4e08cad4d5f8c621e389ff792a (patch) | |
tree | 576d9e5a79f69c4977a37969626755602e29869d /source/blender/python/api2_2x/doc | |
parent | 51c58f3ca2dd86ed0382997f46f36a8686b427a7 (diff) |
Moved recent addition of get/setPixelF to get/setPixelHDR and kept get/setPixelF limited to 0.0-1.0 range, to prevent existing scripts breaking.
Diffstat (limited to 'source/blender/python/api2_2x/doc')
-rw-r--r-- | source/blender/python/api2_2x/doc/Image.py | 33 |
1 files changed, 31 insertions, 2 deletions
diff --git a/source/blender/python/api2_2x/doc/Image.py b/source/blender/python/api2_2x/doc/Image.py index 6b725fa9f78..92a05c2604d 100644 --- a/source/blender/python/api2_2x/doc/Image.py +++ b/source/blender/python/api2_2x/doc/Image.py @@ -141,7 +141,7 @@ class Image: @rtype: int """ - def getPixelF(x, y): + def getPixelHDR(x, y): """ Get the the colors of the current pixel in the form [r,g,b,a]. For float image types, returned values can be greater then the useual [0.0, 1.0] range. @@ -153,6 +153,20 @@ class Image: @param x: the x coordinate of pixel. @param y: the y coordinate of pixel. """ + + 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 + @type x: int + @type y: int + @param x: the x coordinate of pixel. + @param y: the y coordinate of pixel. + """ + def getPixelI(x, y): """ Get the the colors of the current pixel in the form [r,g,b,a]. @@ -309,7 +323,7 @@ class Image: @param speed: The new value in [1, 100]. """ - def setPixelF(x, y, (r, g, b,a )): + def setPixelHDR(x, y, (r, g, b,a )): """ Set the the colors of the current pixel in the form [r,g,b,a]. For float image types, returned values can be greater then the useual [0.0, 1.0] range. @@ -324,6 +338,21 @@ class Image: @rtype: none """ + def setPixelF(x, y, (r, g, b,a )): + """ + Set the the colors of the current pixel in the form [r,g,b,a]. + Color values must be floats in the range 0.0 - 1.0. + Pixel coordinates are in the range from 0 to N-1. See L{getMaxXY} + @type x: int + @type y: int + @type r: float + @type g: float + @type b: float + @type a: float + @returns: nothing + @rtype: none + """ + def setPixelI(x, y, (r, g, b, a)): """ Set the the colors of the current pixel in the form [r,g,b,a]. |