f3d-app · mwestphal · Jul 11, 2023 · Jul 10, 2023 · Jul 10, 2023 · Jul 10, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -58,6 +58,7 @@ jobs:
         build_type: [standard]
         include:
           - raytracing_label: raytracing
+          - exclude_deprecated_label: no-exclude-deprecated
           - bundle_label: no-bundle
           - egl_label: no-egl
           - vtk_version: v9.0.0
@@ -68,11 +69,23 @@ jobs:
             os: macos
             vtk_version: commit
             raytracing_label: no-raytracing
+            exclude_deprecated_label: no-exclude-deprecated
             bundle_label: bundle
+            egl_label: no-egl
           - build_type: headless
             os: ubuntu
             vtk_version: commit
+            raytracing_label: raytracing
+            exclude_deprecated_label: no-exclude-deprecated
+            bundle_label: no-bundle
             egl_label: egl
+          - build_type: exclude_deprecated
+            os: ubuntu
+            vtk_version: commit
+            raytracing_label: raytracing
+            exclude_deprecated_label: exclude-deprecated
+            bundle_label: no-bundle
+            egl_label: no-egl
 
     runs-on: ${{matrix.os}}-latest
     container: ${{ matrix.os == 'ubuntu' && 'ghcr.io/f3d-app/f3d-ci' || null }}
@@ -163,6 +176,7 @@ jobs:
         -DCMAKE_PREFIX_PATH:PATH=$(pwd)/../dependencies/install/
         -DF3D_BINDINGS_JAVA=ON
         -DF3D_BINDINGS_PYTHON=ON
+        -DF3D_EXCLUDE_DEPRECATED=${{ matrix.exclude_deprecated_label == 'exclude-deprecated' && 'ON' || 'OFF' }}
         -DF3D_LINUX_GENERATE_MAN=ON
         -DF3D_LINUX_INSTALL_DEFAULT_CONFIGURATION_FILE_IN_PREFIX=ON
         -DF3D_MACOS_BUNDLE=${{ matrix.bundle_label == 'bundle' && 'ON' || 'OFF' }}
@@ -388,7 +402,6 @@ jobs:
         -DF3D_PLUGIN_BUILD_DRACO=ON
         -DF3D_PLUGIN_BUILD_OCCT=ON
         -DF3D_STRICT_BUILD=ON
-        -DF3D_EXCLUDE_DEPRECATED=ON
         -DF3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS=ON
 
     - name: Build

diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md
@@ -7,7 +7,12 @@ For F3D users:
  - Fixed an issue with the binary release when opening draco files
  - Fixed an issue with matcap textures
 
+For libf3d users:
+ - Reworked image API to support many file formats to read (EXR, HDR) and write (PNG, JPG, TIF, BMP)
+ - Deprecated previous image API
+
 For developers:
+ - Added a deprecation framework
 
 For F3D packagers:
  - Fixed compatibility with FreeBSD

diff --git a/python/F3DPythonBindings.cxx b/python/F3DPythonBindings.cxx
@@ -288,7 +288,7 @@ PYBIND11_MODULE(f3d, module)
     [=](const f3d::image& img)
     {
       PyErr_WarnEx(PyExc_DeprecationWarning, "getData is deprecated, use getContent instead.", 1);
-      getImageBytes(img);
+      return getImageBytes(img);
     });
 #pragma GCC diagnostic pop
 #endif

diff --git a/python/testing/CMakeLists.txt b/python/testing/CMakeLists.txt
@@ -5,6 +5,11 @@ list(APPEND pyf3dTests_list
      TestPythonUtils.py
     )
 
+if(NOT F3D_EXCLUDE_DEPRECATED)
+  list(APPEND pyf3dTests_list
+       TestPythonImageDataDeprecated.py)
+endif()
+
 if(NOT F3D_MACOS_BUNDLE)
   list(APPEND pyf3dTests_list
        TestPythonPlugins.py

diff --git a/python/testing/TestPythonImageData.py b/python/testing/TestPythonImageData.py
@@ -42,7 +42,7 @@
 
 '''set data back'''
 
-img.setData(data)
+img.setContent(data)
 assert img.getContent() == data
 
 '''check channel type and save image'''
@@ -57,7 +57,7 @@
 '''attempt to set partial data back'''
 
 try:
-    img.setData(data[:-1])
+    img.setContent(data[:-1])
     assert False, 'expected exception'
 except ValueError:
     assert True
diff --git a/python/testing/TestPythonImageDataDeprecated.py b/python/testing/TestPythonImageDataDeprecated.py
@@ -0,0 +1,55 @@
+import sys
+if sys.platform.startswith('win32'):
+  import os
+  os.add_dll_directory(sys.argv[1])
+
+import f3d
+
+engine = f3d.engine(f3d.window.NATIVE_OFFSCREEN)
+window = engine.getWindow()
+window.setSize(300, 200)
+
+
+'''with background -> RGB image'''
+
+img = window.renderToImage()
+width = img.getWidth()
+height = img.getHeight()
+depth = img.getChannelCount()
+data = img.getData()
+
+assert width == window.getWidth()
+assert height == window.getHeight()
+assert depth == 3
+assert isinstance(data, (bytes, bytearray))
+assert len(data) == depth * width * height
+
+
+'''without background -> RGBA image'''
+
+img = window.renderToImage(True)
+width = img.getWidth()
+height = img.getHeight()
+depth = img.getChannelCount()
+data = img.getData()
+
+assert width == window.getWidth()
+assert height == window.getHeight()
+assert depth == 4
+assert isinstance(data, (bytes, bytearray))
+assert len(data) == depth * width * height
+
+
+'''set data back'''
+
+img.setData(data)
+assert img.getData() == data
+
+
+'''attempt to set partial data back'''
+
+try:
+    img.setData(data[:-1])
+    assert False, 'expected exception'
+except ValueError:
+    assert True