diff options
author | Bastien Montagne <bastien@blender.org> | 2022-05-06 12:08:10 +0300 |
---|---|---|
committer | Bastien Montagne <bastien@blender.org> | 2022-05-06 12:11:33 +0300 |
commit | 84756b68e68c8a25b820a8c3dda01ec7f0a59353 (patch) | |
tree | e8cb9348f1cd0f61f3f56f16bd22a7b9934b91c4 /source/blender/makesrna/intern/rna_image.c | |
parent | 62450e8485ded339889e292e41453398dad5adcc (diff) |
Add documentation about Image/ImBuf to python/RNA API.
Related to T95616, the relationship between Image ID and ImBuf 'cached'
buffers can be fairly confusing when using the RNA API.
Reviewed By: campbellbarton, jbakker
Differential Revision: https://developer.blender.org/D14833
Diffstat (limited to 'source/blender/makesrna/intern/rna_image.c')
-rw-r--r-- | source/blender/makesrna/intern/rna_image.c | 35 |
1 files changed, 22 insertions, 13 deletions
diff --git a/source/blender/makesrna/intern/rna_image.c b/source/blender/makesrna/intern/rna_image.c index 3a93a44e0d1..bd3b03add95 100644 --- a/source/blender/makesrna/intern/rna_image.c +++ b/source/blender/makesrna/intern/rna_image.c @@ -1073,22 +1073,31 @@ static void rna_def_image(BlenderRNA *brna) RNA_def_property_ui_text(prop, "Depth", "Image bit depth"); RNA_def_property_clear_flag(prop, PROP_EDITABLE); - prop = RNA_def_int_vector(srna, - "size", - 2, - NULL, - 0, - 0, - "Size", - "Width and height in pixels, zero when image data can't be loaded", - 0, - 0); + prop = RNA_def_int_vector( + srna, + "size", + 2, + NULL, + 0, + 0, + "Size", + "Width and height of the image buffer in pixels, zero when image data can't be loaded", + 0, + 0); RNA_def_property_subtype(prop, PROP_PIXEL); RNA_def_property_int_funcs(prop, "rna_Image_size_get", NULL, NULL); RNA_def_property_clear_flag(prop, PROP_EDITABLE); - prop = RNA_def_float_vector( - srna, "resolution", 2, NULL, 0, 0, "Resolution", "X/Y pixels per meter", 0, 0); + prop = RNA_def_float_vector(srna, + "resolution", + 2, + NULL, + 0, + 0, + "Resolution", + "X/Y pixels per meter, for the image buffer", + 0, + 0); RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY); RNA_def_property_float_funcs(prop, "rna_Image_resolution_get", "rna_Image_resolution_set", NULL); @@ -1105,7 +1114,7 @@ static void rna_def_image(BlenderRNA *brna) prop = RNA_def_property(srna, "pixels", PROP_FLOAT, PROP_NONE); RNA_def_property_flag(prop, PROP_DYNAMIC); RNA_def_property_multi_array(prop, 1, NULL); - RNA_def_property_ui_text(prop, "Pixels", "Image pixels in floating-point values"); + RNA_def_property_ui_text(prop, "Pixels", "Image buffer pixels in floating-point values"); RNA_def_property_dynamic_array_funcs(prop, "rna_Image_pixels_get_length"); RNA_def_property_float_funcs(prop, "rna_Image_pixels_get", "rna_Image_pixels_set", NULL); |