diff options
author | Campbell Barton <ideasman42@gmail.com> | 2008-03-10 15:17:58 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2008-03-10 15:17:58 +0300 |
commit | 2b42733105b4f7a89a880e53ea706a24515f0840 (patch) | |
tree | a0dadb144815524b7ecfbe995636f8d2e2a70cec /source/blender/python/api2_2x/doc | |
parent | 0ec0f2a02fb4d6e87db8fe8c7b9027ceab0263af (diff) |
Applied [#7076] Updated Python Image API to use float buffers in getPixelF/setPixelF
and added an image.updateDisplay() function to update imbuf->rect from imbuf->rect_float
also corrected some docstrings and epydocs
Diffstat (limited to 'source/blender/python/api2_2x/doc')
-rw-r--r-- | source/blender/python/api2_2x/doc/Armature.py | 10 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Group.py | 6 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Image.py | 16 |
3 files changed, 27 insertions, 5 deletions
diff --git a/source/blender/python/api2_2x/doc/Armature.py b/source/blender/python/api2_2x/doc/Armature.py index 0dbaf28d6f8..68916af6166 100644 --- a/source/blender/python/api2_2x/doc/Armature.py +++ b/source/blender/python/api2_2x/doc/Armature.py @@ -192,6 +192,16 @@ class Armature: @note: Must have called makeEditable() first. @rtype: None """ + def copy(): + """ + Return a copy of this armature. + @rtype: Armature + """ + def __copy__(): + """ + Return a copy of this armature. + @rtype: Armature + """ import id_generics Armature.__doc__ += id_generics.attributes diff --git a/source/blender/python/api2_2x/doc/Group.py b/source/blender/python/api2_2x/doc/Group.py index aca7c56b4a5..6bd6e105ec3 100644 --- a/source/blender/python/api2_2x/doc/Group.py +++ b/source/blender/python/api2_2x/doc/Group.py @@ -121,6 +121,12 @@ class Group: @rtype: Group @return: a copy of this group """ + def copy (): + """ + Make a copy of this group + @rtype: Group + @return: a copy of this group + """ import id_generics Group.__doc__ += id_generics.attributes diff --git a/source/blender/python/api2_2x/doc/Image.py b/source/blender/python/api2_2x/doc/Image.py index 6d613b3c8fe..6b725fa9f78 100644 --- a/source/blender/python/api2_2x/doc/Image.py +++ b/source/blender/python/api2_2x/doc/Image.py @@ -48,7 +48,7 @@ def New (name, width, height, depth): @type height: int @param height: The height of the new Image object, between 1 and 5000. @type depth: int - @param depth: The colour depth of the new Image object. (8:Grey, 24:RGB, 32:RGBA). (Not implimented yet, all new images will be 24bit) + @param depth: The colour depth of the new Image object. (32:RGBA 8bit channels, 128:RGBA 32bit high dynamic range float channels). @rtype: Blender Image @return: A new Blender Image object. """ @@ -83,7 +83,7 @@ class Image: @type filename: string @ivar size: The [width, height] dimensions of the image (in pixels). @type size: list - @ivar depth: The pixel depth of the image. [8, 16, 18, 24, 32] + @ivar depth: The pixel depth of the image, read only. [8, 16, 18, 24, 32, 128 (for 32bit float color channels)] @type depth: int @ivar xrep: Texture tiling: the number of repetitions in the x (horizontal) axis. [1, 16]. @@ -137,14 +137,14 @@ class Image: def getDepth(): """ - Get the pixel depth of this image. + Get the pixel depth of this image. [8,16,24,32,128 for 32bit float images] @rtype: int """ 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. + For float image types, returned values can be greater then the useual [0.0, 1.0] range. Pixel coordinates are in the range from 0 to N-1. See L{getMaxXY} @returns: [ r, g, b, a] @rtype: list of 4 floats @@ -229,6 +229,12 @@ class Image: @returns: None """ + def updateDisplay(): + """ + Update the display image from the floating point buffer (if it exists) + @returns: None + """ + def glLoad(): """ Load this image's data into OpenGL texture memory, if it is not already @@ -306,7 +312,7 @@ class Image: 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. + For float image types, returned values can be greater then the useual [0.0, 1.0] range. Pixel coordinates are in the range from 0 to N-1. See L{getMaxXY} @type x: int @type y: int |