From 891720ae8c7c616660a8400855cf8a9f408902cc Mon Sep 17 00:00:00 2001 From: Jacopo Mondi Date: Thu, 19 Oct 2023 16:01:24 +0200 Subject: [PATCH] Documentation: Add figures to document Orientation Add figures in Documentation/rotation/ to document the plane transformations defined by the Orientation enumeration. Signed-off-by: Jacopo Mondi Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- Documentation/Doxyfile.in | 2 + Documentation/images/rotation/rotate0.svg | 132 +++++++++++++++++ .../images/rotation/rotate0Mirror.svg | 135 ++++++++++++++++++ Documentation/images/rotation/rotate180.svg | 135 ++++++++++++++++++ .../images/rotation/rotate180Mirror.svg | 135 ++++++++++++++++++ Documentation/images/rotation/rotate270.svg | 135 ++++++++++++++++++ .../images/rotation/rotate270Mirror.svg | 135 ++++++++++++++++++ Documentation/images/rotation/rotate90.svg | 135 ++++++++++++++++++ .../images/rotation/rotate90Mirror.svg | 135 ++++++++++++++++++ src/libcamera/orientation.cpp | 17 +++ 10 files changed, 1096 insertions(+) create mode 100644 Documentation/images/rotation/rotate0.svg create mode 100644 Documentation/images/rotation/rotate0Mirror.svg create mode 100644 Documentation/images/rotation/rotate180.svg create mode 100644 Documentation/images/rotation/rotate180Mirror.svg create mode 100644 Documentation/images/rotation/rotate270.svg create mode 100644 Documentation/images/rotation/rotate270Mirror.svg create mode 100644 Documentation/images/rotation/rotate90.svg create mode 100644 Documentation/images/rotation/rotate90Mirror.svg diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index 697a14d1d..a86ea6c1e 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -78,6 +78,8 @@ EXPAND_ONLY_PREDEF = YES INCLUDE_PATH = "@TOP_SRCDIR@/include/libcamera" INCLUDE_FILE_PATTERNS = *.h +IMAGE_PATH = "@TOP_SRCDIR@/Documentation/images" + PREDEFINED = __DOXYGEN__ \ __cplusplus \ __attribute__(x)= \ diff --git a/Documentation/images/rotation/rotate0.svg b/Documentation/images/rotation/rotate0.svg new file mode 100644 index 000000000..13cde16ad --- /dev/null +++ b/Documentation/images/rotation/rotate0.svg @@ -0,0 +1,132 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate0Mirror.svg b/Documentation/images/rotation/rotate0Mirror.svg new file mode 100644 index 000000000..a7edda873 --- /dev/null +++ b/Documentation/images/rotation/rotate0Mirror.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate180.svg b/Documentation/images/rotation/rotate180.svg new file mode 100644 index 000000000..d092a5322 --- /dev/null +++ b/Documentation/images/rotation/rotate180.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate180Mirror.svg b/Documentation/images/rotation/rotate180Mirror.svg new file mode 100644 index 000000000..d4a77d500 --- /dev/null +++ b/Documentation/images/rotation/rotate180Mirror.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate270.svg b/Documentation/images/rotation/rotate270.svg new file mode 100644 index 000000000..13ea1e5df --- /dev/null +++ b/Documentation/images/rotation/rotate270.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate270Mirror.svg b/Documentation/images/rotation/rotate270Mirror.svg new file mode 100644 index 000000000..6116f50aa --- /dev/null +++ b/Documentation/images/rotation/rotate270Mirror.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate90.svg b/Documentation/images/rotation/rotate90.svg new file mode 100644 index 000000000..af6276383 --- /dev/null +++ b/Documentation/images/rotation/rotate90.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/images/rotation/rotate90Mirror.svg b/Documentation/images/rotation/rotate90Mirror.svg new file mode 100644 index 000000000..1760c4622 --- /dev/null +++ b/Documentation/images/rotation/rotate90Mirror.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/libcamera/orientation.cpp b/src/libcamera/orientation.cpp index a3465383d..965f5a8b9 100644 --- a/src/libcamera/orientation.cpp +++ b/src/libcamera/orientation.cpp @@ -37,6 +37,23 @@ namespace libcamera { * For example, Orientation::Rotate90Mirror describes the orientation obtained * by rotating the image 90 degrees clockwise first and then applying a * horizontal mirroring. + * + * \var CameraConfiguration::Rotate0 + * \image html rotation/rotate0.svg + * \var CameraConfiguration::Rotate0Mirror + * \image html rotation/rotate0Mirror.svg + * \var CameraConfiguration::Rotate180 + * \image html rotation/rotate180.svg + * \var CameraConfiguration::Rotate180Mirror + * \image html rotation/rotate180Mirror.svg + * \var CameraConfiguration::Rotate90Mirror + * \image html rotation/rotate90Mirror.svg + * \var CameraConfiguration::Rotate270 + * \image html rotation/rotate270.svg + * \var CameraConfiguration::Rotate270Mirror + * \image html rotation/rotate270Mirror.svg + * \var CameraConfiguration::Rotate90 + * \image html rotation/rotate90.svg */ /**