Page MenuHome

Add documentation about Image/ImBuf to python/RNA API.
ClosedPublic

Authored by Bastien Montagne (mont29) on May 3 2022, 4:07 PM.

Details

Summary

Related to T95616, the relationship between Image ID and ImBuf 'cached'
buffers can be fairly confusing when using the RNA API.

Diff Detail

Repository
rB Blender
Branch
tmp (branched from master)
Build Status
Buildable 21941
Build 21941: arc lint + arc unit

Event Timeline

Bastien Montagne (mont29) requested review of this revision.May 3 2022, 4:07 PM
Bastien Montagne (mont29) created this revision.

Some minor nodes but in general this seems fine. No extra review needed from my side.

doc/python_api/examples/bpy.types.Image.py
5
5–26

There are a few notes that could be included here, although they don't fit the style of introductory documentation so well. Nevertheless they may still be worth including.

  • file(s) on disk part is not always true in the case of packed and generated images.
  • In what situations one images references multiple ImBuf's (UDIM, multi-view/stereo, animation... etc).

There is room for some more detailed examples too, something that involved loading, modifying and saving an image would be good. Although that can be separate from this patch (another example file).

This revision is now accepted and ready to land.May 4 2022, 1:10 AM