[libcamera-devel] [PATCH v5 03/12] Documentation: Add figures to document Orientation
Laurent Pinchart
laurent.pinchart at ideasonboard.com
Wed Oct 18 20:56:43 CEST 2023
Hi Jacopo,
Thank you for the patch.
On Fri, Sep 01, 2023 at 05:02:06PM +0200, Jacopo Mondi via libcamera-devel wrote:
> Add figures in Documentation/rotation/ to document the plane
> transformations defined by the Orientation enumeration.
>
> Signed-off-by: Jacopo Mondi <jacopo.mondi at ideasonboard.com>
> ---
> Documentation/Doxyfile.in | 2 +
> Documentation/rotation/flip-rotate-0.eps | 170 ++++++++++++++++++
> Documentation/rotation/flip-rotate-0.png | Bin 0 -> 16488 bytes
The name of the enumerators mention the flip last, which corresponds to
the order of the operations (rotate first, then flip). Can the file
names do the same ?
> Documentation/rotation/flip-rotate-180.eps | 191 +++++++++++++++++++++
> Documentation/rotation/flip-rotate-180.png | Bin 0 -> 22198 bytes
> Documentation/rotation/flip-rotate-270.eps | 118 +++++++++++++
> Documentation/rotation/flip-rotate-270.png | Bin 0 -> 9108 bytes
> Documentation/rotation/flip-rotate-90.eps | 118 +++++++++++++
> Documentation/rotation/flip-rotate-90.png | Bin 0 -> 10918 bytes
> Documentation/rotation/rotate-0.eps | 169 ++++++++++++++++++
> Documentation/rotation/rotate-0.png | Bin 0 -> 9086 bytes
> Documentation/rotation/rotate-180.eps | 189 ++++++++++++++++++++
> Documentation/rotation/rotate-180.png | Bin 0 -> 22182 bytes
> Documentation/rotation/rotate-270.eps | 118 +++++++++++++
> Documentation/rotation/rotate-270.png | Bin 0 -> 9334 bytes
> Documentation/rotation/rotate-90.eps | 118 +++++++++++++
> Documentation/rotation/rotate-90.png | Bin 0 -> 9163 bytes
We now have .svg images in the documentation, could we do the same here
and avoid hosting binaries in the repository ?
> src/libcamera/orientation.cpp | 25 +++
> 18 files changed, 1218 insertions(+)
> create mode 100644 Documentation/rotation/flip-rotate-0.eps
> create mode 100644 Documentation/rotation/flip-rotate-0.png
> create mode 100644 Documentation/rotation/flip-rotate-180.eps
> create mode 100644 Documentation/rotation/flip-rotate-180.png
> create mode 100644 Documentation/rotation/flip-rotate-270.eps
> create mode 100644 Documentation/rotation/flip-rotate-270.png
> create mode 100644 Documentation/rotation/flip-rotate-90.eps
> create mode 100644 Documentation/rotation/flip-rotate-90.png
> create mode 100644 Documentation/rotation/rotate-0.eps
> create mode 100644 Documentation/rotation/rotate-0.png
> create mode 100644 Documentation/rotation/rotate-180.eps
> create mode 100644 Documentation/rotation/rotate-180.png
> create mode 100644 Documentation/rotation/rotate-270.eps
> create mode 100644 Documentation/rotation/rotate-270.png
> create mode 100644 Documentation/rotation/rotate-90.eps
> create mode 100644 Documentation/rotation/rotate-90.png
>
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 697a14d1dfe2..67ee51afb6e3 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"
> +
> PREDEFINED = __DOXYGEN__ \
> __cplusplus \
> __attribute__(x)= \
[snip]
> diff --git a/src/libcamera/orientation.cpp b/src/libcamera/orientation.cpp
> index f2ee14dd4182..0ab342a24727 100644
> --- a/src/libcamera/orientation.cpp
> +++ b/src/libcamera/orientation.cpp
> @@ -53,6 +53,31 @@ namespace libcamera {
> * In example Orientation::rotate90Flip describes the image transformation
> * obtained by rotating 90 degrees clockwise first and then applying an
> * horizontal mirroring.
> + *
> + * \var CameraConfiguration::rotate0
> + * \image html rotation/rotate-0.png
> + * \image latex rotation/rotate-0.eps
> + * \var CameraConfiguration::rotate0Flip
> + * \image html rotation/flip-rotate-0.png
> + * \image latex rotation/flip-rotate-0.eps
> + * \var CameraConfiguration::rotate180
> + * \image html rotation/rotate-180.png
> + * \image latex rotation/rotate-180.eps
> + * \var CameraConfiguration::rotate180Flip
> + * \image html rotation/flip-rotate-180.png
> + * \image latex rotation/flip-rotate-180.eps
> + * \var CameraConfiguration::rotate90Flip
> + * \image html rotation/flip-rotate-90.png
> + * \image latex rotation/flip-rotate-90.eps
> + * \var CameraConfiguration::rotate270
> + * \image html rotation/rotate-270.png
> + * \image latex rotation/rotate-270.eps
> + * \var CameraConfiguration::rotate270Flip
> + * \image html rotation/flip-rotate-270.png
> + * \image latex rotation/flip-rotate-270.eps
> + * \var CameraConfiguration::rotate90
> + * \image html rotation/rotate-90.png
> + * \image latex rotation/rotate-90.eps
> */
>
> /**
--
Regards,
Laurent Pinchart
More information about the libcamera-devel
mailing list