8#ifndef __LIBCAMERA_GEOMETRY_H__
9#define __LIBCAMERA_GEOMETRY_H__
14#include <libcamera/compiler.h>
28 constexpr Point(
int xpos,
int ypos)
44bool operator==(
const Point &lhs,
const Point &rhs);
45static inline bool operator!=(
const Point &lhs,
const Point &rhs)
58 constexpr Size(
unsigned int w,
unsigned int h)
78 width = (
width + hAlignment - 1) / hAlignment * hAlignment;
79 height = (
height + vAlignment - 1) / vAlignment * vAlignment;
112 unsigned int vAlignment)
const
115 width / hAlignment * hAlignment,
116 height / vAlignment * vAlignment
121 unsigned int vAlignment)
const
124 (
width + hAlignment - 1) / hAlignment * hAlignment,
125 (
height + vAlignment - 1) / vAlignment * vAlignment
173bool operator==(
const Size &lhs,
const Size &rhs);
174bool operator<(
const Size &lhs,
const Size &rhs);
176static inline bool operator!=(
const Size &lhs,
const Size &rhs)
178 return !(lhs == rhs);
181static inline bool operator<=(
const Size &lhs,
const Size &rhs)
183 return lhs < rhs || lhs == rhs;
186static inline bool operator>(
const Size &lhs,
const Size &rhs)
188 return !(lhs <= rhs);
191static inline bool operator>=(
const Size &lhs,
const Size &rhs)
215 unsigned int hstep,
unsigned int vstep)
233 return !(lhs == rhs);
249 constexpr Rectangle(
int xpos,
int ypos,
unsigned int w,
unsigned int h)
285 const Size &denominator)
const;
289bool operator==(
const Rectangle &lhs,
const Rectangle &rhs);
290static inline bool operator!=(
const Rectangle &lhs,
const Rectangle &rhs)
292 return !(lhs == rhs);
Describe a point in two-dimensional space.
Definition: geometry.h:21
int y
The y-coordinate of the Point.
Definition: geometry.h:34
constexpr Point()
Construct a Point with x and y set to 0.
Definition: geometry.h:23
constexpr Point operator-() const
Negate a Point by negating both its x and y coordinates.
Definition: geometry.h:38
int x
The x-coordinate of the Point.
Definition: geometry.h:33
constexpr Point(int xpos, int ypos)
Construct a Point at given xpos and ypos values.
Definition: geometry.h:28
const std::string toString() const
Assemble and return a string describing the point.
Definition: geometry.cpp:56
Describe a rectangle's position and dimensions.
Definition: geometry.h:237
Rectangle & scaleBy(const Size &numerator, const Size &denominator)
Apply a non-uniform rational scaling in place to this Rectangle.
Definition: geometry.cpp:665
int y
The vertical coordinate of the rectangle's top-left corner.
Definition: geometry.h:260
Point center() const
Retrieve the center point of this rectangle.
Definition: geometry.cpp:637
__nodiscard Rectangle translatedBy(const Point &point) const
Translate a Rectangle by the given amounts.
Definition: geometry.cpp:778
unsigned int height
The distance between the top and bottom sides.
Definition: geometry.h:262
constexpr Rectangle(const Size &size)
Construct a Rectangle of size with its top left corner located at (0,0)
Definition: geometry.h:254
constexpr Rectangle(int xpos, int ypos, const Size &size)
Construct a Rectangle with the given position and size.
Definition: geometry.h:244
const std::string toString() const
Assemble and return a string describing the rectangle.
Definition: geometry.cpp:624
constexpr Rectangle(int xpos, int ypos, unsigned int w, unsigned int h)
Construct a Rectangle with the given position and size.
Definition: geometry.h:249
Point topLeft() const
Retrieve the coordinates of the top left corner of this Rectangle.
Definition: geometry.h:274
__nodiscard Rectangle enclosedIn(const Rectangle &boundary) const
Enclose a Rectangle so as not to exceed another Rectangle.
Definition: geometry.cpp:735
bool isNull() const
Check if the rectangle is null.
Definition: geometry.h:264
unsigned int width
The distance between the left and right sides.
Definition: geometry.h:261
Rectangle & translateBy(const Point &point)
Translate this Rectangle in place by the given Point.
Definition: geometry.cpp:684
Size size() const
Retrieve the size of this rectangle.
Definition: geometry.h:269
constexpr Rectangle()
Construct a Rectangle with all coordinates set to 0.
Definition: geometry.h:239
int x
The horizontal coordinate of the rectangle's top-left corner.
Definition: geometry.h:259
__nodiscard Rectangle boundedTo(const Rectangle &bound) const
Calculate the intersection of this Rectangle with another.
Definition: geometry.cpp:704
__nodiscard Rectangle scaledBy(const Size &numerator, const Size &denominator) const
Apply a non-uniform rational scaling to this Rectangle.
Definition: geometry.cpp:759
Describe a range of sizes.
Definition: geometry.h:197
SizeRange(const Size &minSize, const Size &maxSize, unsigned int hstep, unsigned int vstep)
Construct a size range with specified min, max and step.
Definition: geometry.h:214
SizeRange(const Size &minSize, const Size &maxSize)
Construct a size range with specified min and max, and steps of 1.
Definition: geometry.h:209
unsigned int vStep
The vertical step.
Definition: geometry.h:227
SizeRange(const Size &size)
Construct a size range representing a single size.
Definition: geometry.h:204
Size max
The maximum size.
Definition: geometry.h:225
unsigned int hStep
The horizontal step.
Definition: geometry.h:226
SizeRange()
Construct a size range initialized to 0.
Definition: geometry.h:199
Size min
The minimum size.
Definition: geometry.h:224
bool contains(const Size &size) const
Test if a size is contained in the range.
Definition: geometry.cpp:513
std::string toString() const
Assemble and return a string describing the size range.
Definition: geometry.cpp:528
Describe a two-dimensional size.
Definition: geometry.h:51
Size & operator/=(float factor)
Scale this size down by the given factor in place.
Definition: geometry.cpp:358
__nodiscard constexpr Size shrunkBy(const Size &margins) const
Shrink the size by margins.
Definition: geometry.h:153
Size & alignUpTo(unsigned int hAlignment, unsigned int vAlignment)
Align the size up horizontally and vertically in place.
Definition: geometry.h:76
Size & shrinkBy(const Size &margins)
Shrink the size by margins in place.
Definition: geometry.h:104
const std::string toString() const
Assemble and return a string describing the size.
Definition: geometry.cpp:125
Size operator/(float factor) const
Scale size down by the given factor.
Definition: geometry.cpp:336
__nodiscard constexpr Size expandedTo(const Size &expand) const
Expand the size to expand.
Definition: geometry.h:137
constexpr Size()
Construct a Size with width and height set to 0.
Definition: geometry.h:53
__nodiscard constexpr Size alignedDownTo(unsigned int hAlignment, unsigned int vAlignment) const
Align the size down horizontally and vertically.
Definition: geometry.h:111
Size & boundTo(const Size &bound)
Bound the size to bound in place.
Definition: geometry.h:83
__nodiscard constexpr Size grownBy(const Size &margins) const
Grow the size by margins.
Definition: geometry.h:145
unsigned int width
The Size width.
Definition: geometry.h:63
Size & alignDownTo(unsigned int hAlignment, unsigned int vAlignment)
Align the size down horizontally and vertically in place.
Definition: geometry.h:69
__nodiscard Rectangle centeredTo(const Point ¢er) const
Center a rectangle of this size at a given Point.
Definition: geometry.cpp:313
constexpr Size(unsigned int w, unsigned int h)
Construct a Size with given width and height.
Definition: geometry.h:58
bool isNull() const
Check if the size is null.
Definition: geometry.h:66
Size & expandTo(const Size &expand)
Expand the size to expand.
Definition: geometry.h:90
__nodiscard constexpr Size boundedTo(const Size &bound) const
Bound the size to bound.
Definition: geometry.h:129
__nodiscard Size boundedToAspectRatio(const Size &ratio) const
Bound the size down to match the aspect ratio given by ratio.
Definition: geometry.cpp:264
__nodiscard Size expandedToAspectRatio(const Size &ratio) const
Expand the size to match the aspect ratio given by ratio.
Definition: geometry.cpp:289
Size operator*(float factor) const
Scale size up by the given factor.
Definition: geometry.cpp:326
__nodiscard constexpr Size alignedUpTo(unsigned int hAlignment, unsigned int vAlignment) const
Align the size up horizontally and vertically.
Definition: geometry.h:120
unsigned int height
The Size height.
Definition: geometry.h:64
Size & growBy(const Size &margins)
Grow the size by margins in place.
Definition: geometry.h:97
Size & operator*=(float factor)
Scale this size up by the given factor in place.
Definition: geometry.cpp:346
Top-level libcamera namespace.
Definition: backtrace.h:17
bool operator<(const Size &lhs, const Size &rhs)
Compare sizes for smaller than order.
Definition: geometry.cpp:385
bool operator==(const Point &lhs, const Point &rhs)
Compare points for equality.
Definition: geometry.cpp:75