libcamera: Add geometry.h

Add geometry-related definitions in the geometry.h internal header.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

1 files changed, 49 insertions, 0 deletions

diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp
new file mode 100644
index 00000000..57f4fc77
--- /dev/null
+++ b/src/libcamera/geometry.cpp
@@ -0,0 +1,49 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2019, Google Inc.
+ *
+ * geometry.cpp - Geometry-related structures
+ */
+
+#include "geometry.h"
+
+/**
+ * \file geometry.h
+ * \brief Data structures related to geometric objects
+ */
+
+namespace libcamera {
+
+/**
+ * \struct Rectangle
+ * \brief Describe a rectangle's position and dimensions
+ *
+ * Rectangles are used to identify an area of an image. They are specified by
+ * the coordinates of top-left corner and their horizontal and vertical size.
+ *
+ * The measure unit of the rectangle coordinates and size, as well as the
+ * reference point from which the Rectangle::x and Rectangle::y displacements
+ * refers to, are defined by the context were rectangle is used.
+ */
+
+/**
+ * \var Rectangle::x
+ * \brief The horizontal coordinate of the rectangle's top-left corner
+ */
+
+/**
+ * \var Rectangle::y
+ * \brief The vertical coordinate of the rectangle's top-left corner
+ */
+
+/**
+ * \var Rectangle::w
+ * \brief The distance between the left and right sides
+ */
+
+/**
+ * \var Rectangle::h
+ * \brief The distance between the top and bottom sides
+ */
+
+} /* namespace libcamera */