ReadOIIO: document how RoD is computed from EXR dataWindow

closes NatronGitHub/Natron#996
NatronGitHub · Aug 13, 2024 · f547e5f · f547e5f
1 parent c05d785
commit f547e5f
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/OIIO/ReadOIIO.cpp b/OIIO/ReadOIIO.cpp
@@ -125,11 +125,15 @@ typedef ImageInput* ImageInputPtr;
 
 #define kPluginName "ReadOIIO"
 #define kPluginGrouping "Image/Readers"
-#define kPluginDescription                                                        \
-    "Read images using OpenImageIO.\n\n"                                          \
-    "Output is always Premultiplied (alpha is associated).\n\n"                   \
-    "The \"Image Premult\" parameter controls the file premultiplication state, " \
-    "and can be used to fix wrong file metadata (see the help for that parameter)."
+#define kPluginDescription                                                              \
+    "Read images using OpenImageIO.\n\n"                                                \
+    "Output is always Premultiplied (alpha is associated).\n\n"                         \
+    "The \"Image Premult\" parameter controls the file premultiplication state, "       \
+    "and can be used to fix wrong file metadata (see the help for that parameter).\n\n" \
+    "When reading an OpenEXR file with a dataWindow, it is converted to an OpenFX "     \
+    "region of definition by flipping the y axis (y axis goes down in OpenEXR, "        \
+    "up in OpenFX), and adding 1 pixel in every direction if the \"Edge Pixels\" "      \
+    "parameter says that a black border should be added."
 #define kPluginIdentifier "fr.inria.openfx.ReadOIIO"
 #define kPluginVersionMajor 2 // Incrementing this number means that you have broken backwards compatibility of the plug-in.
 #define kPluginVersionMinor 0 // Increment this when you have fixed a bug or made it faster.