epaper::Point Struct Reference

#include <geometry.hpp>

Public Member Functions
constexpr	Point () noexcept
	Default constructor initializes to origin (0, 0).
constexpr	Point (std::size_t x_coord, std::size_t y_coord) noexcept
	Construct a point at the specified coordinates.
constexpr auto	translate (const Point &offset) const noexcept -> Point
	Translate this point by an offset.
constexpr auto	operator== (const Point &other) const noexcept -> bool
	Equality comparison.
constexpr auto	operator!= (const Point &other) const noexcept -> bool
	Inequality comparison.

Public Attributes
std::size_t	x
	X coordinate (horizontal position)
std::size_t	y
	Y coordinate (vertical position)

Constructor & Destructor Documentation

Point() [1/2]

constexpr epaper::Point::Point ( )

inlineconstexprnoexcept

Default constructor initializes to origin (0, 0).

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp.

Point() [2/2]

constexpr epaper::Point::Point ( std::size_t  x_coord, std::size_t  y_coord  )

inlineconstexprnoexcept

Construct a point at the specified coordinates.

Parameters

x_coord	X coordinate
y_coord	Y coordinate

Member Function Documentation

operator!=()

constexpr auto epaper::Point::operator!= ( const Point &  other ) const -> bool

inlineconstexprnoexcept

Inequality comparison.

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp.

operator==()

constexpr auto epaper::Point::operator== ( const Point &  other ) const -> bool

inlineconstexprnoexcept

Equality comparison.

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp.

translate()

constexpr auto epaper::Point::translate ( const Point &  offset ) const -> Point

inlineconstexprnoexcept

Translate this point by an offset.

Parameters

offset

The offset to add to this point

Returns

New point with offset applied

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp.

Member Data Documentation

x

std::size_t epaper::Point::x

X coordinate (horizontal position)

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp, and /mnt/nas/libepaper/include/epaper/draw/builders.hpp.

y

std::size_t epaper::Point::y

Y coordinate (vertical position)

Examples

/mnt/nas/libepaper/include/epaper/core/geometry.hpp, and /mnt/nas/libepaper/include/epaper/draw/builders.hpp.

---

The documentation for this struct was generated from the following file:

• include/epaper/core/geometry.hpp