terminalpp::extent Struct Reference

A class that represents a direction with distance in space (a vector). More...

#include <extent.hpp>

Public Member Functions
constexpr	extent () noexcept
	Default Constructor.
constexpr	extent (coordinate_type w, coordinate_type h) noexcept
	Constructor.
constexpr extent &	operator+= (extent const &rhs) noexcept
	Addition.
constexpr extent &	operator-= (extent const &rhs) noexcept
	Subtraction.

Public Attributes
coordinate_type	width_
coordinate_type	height_

Friends
constexpr friend auto	operator+ (extent lhs, extent const &rhs) noexcept
	Addition.
constexpr friend auto	operator- (extent lhs, extent const &rhs) noexcept
	Subtraction.
constexpr friend auto	operator<=> (extent const &lhs, extent const &rhs) noexcept=default
	Relational operators for extents.

Detailed Description

A class that represents a direction with distance in space (a vector).

A class that represents a direction in space, with width being the extent in the horizontal axis, and height being the extent in the vertical axis.

Constructor & Destructor Documentation

extent() [1/2]

constexpr terminalpp::extent::extent ( )

inlineconstexprnoexcept

Default Constructor.

Constructs an extent, leaving the width and height zeroed.

extent() [2/2]

constexpr terminalpp::extent::extent ( coordinate_type  w, coordinate_type  h  )

inlineconstexprnoexcept

Constructor.

Constructs an extent with width and height being set to the passed-in arguments.

---

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

• /home/runner/work/terminalpp/terminalpp/include/terminalpp/extent.hpp