@@ -193,21 +193,18 @@ Input image | | goes to output image | |
* \param[in] t0 The first transform to apply
* \param[in] t1 The second transform to apply
*
- * Compose two transforms by applying \a t1 after \a t0. The operation
- * is conceptually equivalent to the canonical notion of function composition,
- * with inverse order of operands. If in the canonical function composition
- * notation "f * g" equals to "f(g())", the notation for Transforms composition
- * "t0 * t1" equals to "t1(t0()))" where \a t0 is applied first, then \a t1.
- *
- * For example, `HFlip * Transpose` performs `HFlip` first and then the
- * `Transpose` yielding `Rot270`, as shown below.
+ * Compose two transforms into a transform that is equivalent to first applying
+ * \a t0 and then applying \a t1. For example, `HFlip * Transpose` performs
+ * `HFlip` first and then the `Transpose` yielding `Rot270`, as shown below.
~~~
A-B B-A B-D
Input image | | -> HFLip -> | | -> Transpose -> | | = Rot270
C-D D-C A-C
~~~
- * Note that composition is generally non-commutative for Transforms,
- * and not the same as XOR-ing the underlying bit representations.
+ * Note that composition is generally non-commutative for Transforms, and not
+ * the same as XOR-ing the underlying bit representations.
+ *
+ * \return A Transform equivalent to applying \a t0 and then \a t1
*/
Transform operator*(Transform t0, Transform t1)
{
- Simplify documentation Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/libcamera/transform.cpp | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-)