add introspection descriptions for orientation module

dterrahe · Jun 20, 2024 · 8925aa6 · 8925aa6
1 parent 1306475
commit 8925aa6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/src/common/image.h b/src/common/image.h
@@ -132,20 +132,20 @@ typedef enum dt_exif_image_orientation_t
 
 typedef enum dt_image_orientation_t
 {
-  ORIENTATION_NULL    = -1,     //-1, or autodetect
-  ORIENTATION_NONE    = 0,      // 0
-  ORIENTATION_FLIP_Y  = 1 << 0, // 1
-  ORIENTATION_FLIP_X  = 1 << 1, // 2
-  ORIENTATION_SWAP_XY = 1 << 2, // 4
+  ORIENTATION_NULL    = -1,     //-1 $DESCRIPTION: "autodetect"
+  ORIENTATION_NONE    = 0,      // 0 $DESCRIPTION: "no rotation"
+  ORIENTATION_FLIP_Y  = 1 << 0, // 1 $DESCRIPTION: "flip vertically"
+  ORIENTATION_FLIP_X  = 1 << 1, // 2 $DESCRIPTION: "Flip horizontally"
+  ORIENTATION_SWAP_XY = 1 << 2, // 4 $DESCRIPTION: "transpose"
 
   /* ClockWise rotation == "-"; CounterClockWise rotation == "+" */
-  ORIENTATION_FLIP_HORIZONTALLY = ORIENTATION_FLIP_X, // 2
-  ORIENTATION_FLIP_VERTICALLY   = ORIENTATION_FLIP_Y, // 1
-  ORIENTATION_ROTATE_180_DEG    = ORIENTATION_FLIP_Y | ORIENTATION_FLIP_X, // 3
-  ORIENTATION_TRANSPOSE         = ORIENTATION_SWAP_XY, // 4
-  ORIENTATION_ROTATE_CCW_90_DEG = ORIENTATION_FLIP_X | ORIENTATION_SWAP_XY, // 6
-  ORIENTATION_ROTATE_CW_90_DEG  = ORIENTATION_FLIP_Y | ORIENTATION_SWAP_XY, // 5
-  ORIENTATION_TRANSVERSE        = ORIENTATION_FLIP_Y | ORIENTATION_FLIP_X | ORIENTATION_SWAP_XY // 7
+  ORIENTATION_FLIP_HORIZONTALLY = ORIENTATION_FLIP_X,                       // 2
+  ORIENTATION_FLIP_VERTICALLY   = ORIENTATION_FLIP_Y,                       // 1
+  ORIENTATION_ROTATE_180_DEG    = ORIENTATION_FLIP_Y | ORIENTATION_FLIP_X,  // 3 $DESCRIPTION: "rotate 180°"
+  ORIENTATION_TRANSPOSE         = ORIENTATION_SWAP_XY,                      // 4
+  ORIENTATION_ROTATE_CCW_90_DEG = ORIENTATION_FLIP_X | ORIENTATION_SWAP_XY, // 6 $DESCRIPTION: "rotate 90°"
+  ORIENTATION_ROTATE_CW_90_DEG  = ORIENTATION_FLIP_Y | ORIENTATION_SWAP_XY, // 5 $DESCRIPTION: "rotate -90°"
+  ORIENTATION_TRANSVERSE        = ORIENTATION_FLIP_Y | ORIENTATION_FLIP_X | ORIENTATION_SWAP_XY // 7 $DESCRIPTION: "transverse"
 } dt_image_orientation_t;
 
 typedef enum dt_image_correction_type_t

diff --git a/src/iop/flip.c b/src/iop/flip.c
@@ -27,6 +27,7 @@
 #include <string.h>
 
 #include "common/debug.h"
+#include "common/image.h"
 #include "common/opencl.h"
 #include "control/conf.h"
 #include "control/control.h"