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;
98 unsigned int vAlignment)
const
101 width / hAlignment * hAlignment,
102 height / vAlignment * vAlignment
107 unsigned int vAlignment)
const
110 (
width + hAlignment - 1) / hAlignment * hAlignment,
111 (
height + vAlignment - 1) / vAlignment * vAlignment
143bool operator==(
const Size &lhs,
const Size &rhs);
144bool operator<(
const Size &lhs,
const Size &rhs);
146static inline bool operator!=(
const Size &lhs,
const Size &rhs)
148 return !(lhs == rhs);
151static inline bool operator<=(
const Size &lhs,
const Size &rhs)
153 return lhs < rhs || lhs == rhs;
156static inline bool operator>(
const Size &lhs,
const Size &rhs)
158 return !(lhs <= rhs);
161static inline bool operator>=(
const Size &lhs,
const Size &rhs)
185 unsigned int hstep,
unsigned int vstep)
203 return !(lhs == rhs);
219 constexpr Rectangle(
int xpos,
int ypos,
unsigned int w,
unsigned int h)
255 const Size &denominator)
const;
259bool operator==(
const Rectangle &lhs,
const Rectangle &rhs);
260static inline bool operator!=(
const Rectangle &lhs,
const Rectangle &rhs)
262 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:207
Rectangle & scaleBy(const Size &numerator, const Size &denominator)
Apply a non-uniform rational scaling in place to this Rectangle.
Definition: geometry.cpp:623
int y
The vertical coordinate of the rectangle's top-left corner.
Definition: geometry.h:230
Point center() const
Retrieve the center point of this rectangle.
Definition: geometry.cpp:595
__nodiscard Rectangle translatedBy(const Point &point) const
Translate a Rectangle by the given amounts.
Definition: geometry.cpp:736
unsigned int height
The distance between the top and bottom sides.
Definition: geometry.h:232
constexpr Rectangle(const Size &size)
Construct a Rectangle of size with its top left corner located at (0,0)
Definition: geometry.h:224
constexpr Rectangle(int xpos, int ypos, const Size &size)
Construct a Rectangle with the given position and size.
Definition: geometry.h:214
const std::string toString() const
Assemble and return a string describing the rectangle.
Definition: geometry.cpp:582
constexpr Rectangle(int xpos, int ypos, unsigned int w, unsigned int h)
Construct a Rectangle with the given position and size.
Definition: geometry.h:219
Point topLeft() const
Retrieve the coordinates of the top left corner of this Rectangle.
Definition: geometry.h:244
__nodiscard Rectangle enclosedIn(const Rectangle &boundary) const
Enclose a Rectangle so as not to exceed another Rectangle.
Definition: geometry.cpp:693
bool isNull() const
Check if the rectangle is null.
Definition: geometry.h:234
unsigned int width
The distance between the left and right sides.
Definition: geometry.h:231
Rectangle & translateBy(const Point &point)
Translate this Rectangle in place by the given Point.
Definition: geometry.cpp:642
Size size() const
Retrieve the size of this rectangle.
Definition: geometry.h:239
constexpr Rectangle()
Construct a Rectangle with all coordinates set to 0.
Definition: geometry.h:209
int x
The horizontal coordinate of the rectangle's top-left corner.
Definition: geometry.h:229
__nodiscard Rectangle boundedTo(const Rectangle &bound) const
Calculate the intersection of this Rectangle with another.
Definition: geometry.cpp:662
__nodiscard Rectangle scaledBy(const Size &numerator, const Size &denominator) const
Apply a non-uniform rational scaling to this Rectangle.
Definition: geometry.cpp:717
Describe a range of sizes.
Definition: geometry.h:167
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:184
SizeRange(const Size &minSize, const Size &maxSize)
Construct a size range with specified min and max, and steps of 1.
Definition: geometry.h:179
unsigned int vStep
The vertical step.
Definition: geometry.h:197
SizeRange(const Size &size)
Construct a size range representing a single size.
Definition: geometry.h:174
Size max
The maximum size.
Definition: geometry.h:195
unsigned int hStep
The horizontal step.
Definition: geometry.h:196
SizeRange()
Construct a size range initialized to 0.
Definition: geometry.h:169
Size min
The minimum size.
Definition: geometry.h:194
bool contains(const Size &size) const
Test if a size is contained in the range.
Definition: geometry.cpp:471
std::string toString() const
Assemble and return a string describing the size range.
Definition: geometry.cpp:486
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:316
Size & alignUpTo(unsigned int hAlignment, unsigned int vAlignment)
Align the size up horizontally and vertically in place.
Definition: geometry.h:76
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:294
constexpr __nodiscard Size expandedTo(const Size &expand) const
Expand the size to expand.
Definition: geometry.h:123
constexpr Size()
Construct a Size with width and height set to 0.
Definition: geometry.h:53
constexpr __nodiscard Size alignedDownTo(unsigned int hAlignment, unsigned int vAlignment) const
Align the size down horizontally and vertically.
Definition: geometry.h:97
Size & boundTo(const Size &bound)
Bound the size to bound in place.
Definition: geometry.h:83
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:271
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
constexpr __nodiscard Size boundedTo(const Size &bound) const
Bound the size to bound.
Definition: geometry.h:115
__nodiscard Size boundedToAspectRatio(const Size &ratio) const
Bound the size down to match the aspect ratio given by ratio.
Definition: geometry.cpp:222
__nodiscard Size expandedToAspectRatio(const Size &ratio) const
Expand the size to match the aspect ratio given by ratio.
Definition: geometry.cpp:247
Size operator*(float factor) const
Scale size up by the given factor.
Definition: geometry.cpp:284
constexpr __nodiscard Size alignedUpTo(unsigned int hAlignment, unsigned int vAlignment) const
Align the size up horizontally and vertically.
Definition: geometry.h:106
unsigned int height
The Size height.
Definition: geometry.h:64
Size & operator*=(float factor)
Scale this size up by the given factor in place.
Definition: geometry.cpp:304
Top-level libcamera namespace.
Definition: bound_method.h:15
bool operator<(const Size &lhs, const Size &rhs)
Compare sizes for smaller than order.
Definition: geometry.cpp:343
bool operator==(const Point &lhs, const Point &rhs)
Compare points for equality.
Definition: geometry.cpp:75