Add a comment about why 3-channel images aren't supported.

Signed-off-by: Robert Quill <robert.quill@imgtec.com>
KomputeProject · Sep 2, 2024 · 4417e0d · 4417e0d
1 parent b792ed5
commit 4417e0d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/Image.cpp b/src/Image.cpp
@@ -27,6 +27,8 @@ Image::init(void* data,
     }
 
     if (numChannels > 4 || numChannels == 3) {
+        // We don't support 3-channel images because they are not supported by Metal or Mesa (llvmpipe)
+        // See comment here: https://github.com/KomputeProject/kompute/pull/388#discussion_r1720959531
         throw std::runtime_error(
           "Kompute Images can only have up to 1, 2 or 4 channels");
     }

diff --git a/test/TestImage.cpp b/test/TestImage.cpp
@@ -48,6 +48,9 @@ TEST(TestImage, DataTypes)
 
       // 3-channel images are not supported and should throw an exception.
       // This is tested by a different test.
+
+      // We don't support 3-channel images because they are not supported by Metal or Mesa (llvmpipe)
+      // See comment here: https://github.com/KomputeProject/kompute/pull/388#discussion_r1720959531
       if (numChannels == 3)
       {
         continue;