api: remove redundant ImageSpec from ImageCache (issue #4436)

AcademySoftwareFoundation / OpenImageIO

Reading, writing, and processing images in a wide variety of file formats, using a format-agnostic API, aimed at VFX applications.

https://openimageio.readthedocs.org

Apache License 2.0

1.98k stars 597 forks source link

api: remove redundant ImageSpec from ImageCache (issue #4436) #4442

Closed bfraboni closed 1 month ago

bfraboni commented 1 month ago

Description

First draft of frontend changes for issue #4436.

Checklist:

[x] change imagespec, get_imagespec API calls in ImageCache, ImageCacheImpl, TextureSystem and all calls.
[x] add get_cache_dimensions to access cache internal mip level dimensions
[x] add get_cache_dimensions unit tests once we validate the new version
[ ] change backend to reduce memory usage (might be a different PR)

lgritz commented 1 month ago

Other than the comment I made about elaborating the description a bit, this is all looking great to me.

We talked in a different channel about adding back some very minimal inline methods to keep back compatibility for now, so I know that's still on its way, but if that ends up straightforward, we should be able to merge this without any trouble. Then the API will be nailed down and you can do the further changes to the internals without any additional compatibility breaks during our upcoming beta period.

bfraboni commented 1 month ago

I've added the backwards compatible methods for ImageCache get_imagespec() and imagespec(), and TextureSystem get_imagespec(). I think the CI is happy now, I just need to write unit tests for the newer get_cache_dimensions() method and it'll be good to go. Thank you @lgritz for the directions !

bfraboni commented 1 month ago

I've just rebased the PR and added the unit tests for get_cache_dimensions()