libcamera: geometry: Add helper functions to the Size class

Pipeline handlers commonly have to calculate the minimum or maximum of
multiple sizes, or align a size's width and height. Add helper functions
to the Size class to perform those tasks.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
This commit is contained in:
Laurent Pinchart
2020-07-10 11:23:25 +03:00
parent 74c8b50833
commit 6c0afb8b33
3 changed files with 98 additions and 0 deletions
+36
View File
@@ -122,6 +122,42 @@ const std::string Size::toString() const
return std::to_string(width) + "x" + std::to_string(height);
}
/**
* \fn Size::alignedDownTo(unsigned int hAlignment, unsigned int vAlignment)
* \brief Align the size down horizontally and vertically
* \param[in] hAlignment Horizontal alignment
* \param[in] vAlignment Vertical alignment
* \return A Size whose width and height are equal to the width and height of
* this size rounded down to the nearest multiple of \a hAlignment and
* \a vAlignment respectively
*/
/**
* \fn Size::alignedUpTo(unsigned int hAlignment, unsigned int vAlignment)
* \brief Align the size up horizontally and vertically
* \param[in] hAlignment Horizontal alignment
* \param[in] vAlignment Vertical alignment
* \return A Size whose width and height are equal to the width and height of
* this size rounded up to the nearest multiple of \a hAlignment and
* \a vAlignment respectively
*/
/**
* \fn Size::boundedTo(const Size &bound)
* \brief Bound the size to \a bound
* \param[in] bound The maximum size
* \return A Size whose width and height are the minimum of the width and
* height of this size and the \a bound size
*/
/**
* \fn Size::expandedTo(const Size &expand)
* \brief Expand the size to \a expand
* \param[in] expand The minimum size
* \return A Size whose width and height are the maximum of the width and
* height of this size and the \a expand size
*/
/**
* \brief Compare sizes for equality
* \return True if the two sizes are equal, false otherwise