terminalpp/rectangle_8hpp_source.html

#pragma once


#include "terminalpp/detail/export.hpp"

#include "terminalpp/extent.hpp"

#include "terminalpp/point.hpp"


#include <iosfwd>


namespace terminalpp {


//* =========================================================================

//* =========================================================================


struct TERMINALPP_EXPORT rectangle

{

    //* =====================================================================

    //* =====================================================================

    constexpr rectangle() noexcept = default;


    //* =====================================================================

    //* =====================================================================


    constexpr rectangle(

        terminalpp::point origin, terminalpp::extent size) noexcept

      : origin_(origin), size_(size)

    {

    }


    //* =====================================================================

    //* =====================================================================

    [[nodiscard]] constexpr friend auto operator<=>(

        rectangle const &lhs, rectangle const &rhs) noexcept = default;


    terminalpp::point origin_;


    terminalpp::extent size_;

};


//* =====================================================================

//* =====================================================================

TERMINALPP_EXPORT

std::ostream &operator<<(std::ostream &out, rectangle const &rect);


}  // namespace terminalpp

terminalpp::effect
A structure representing an ANSI graphics effect (e.g. intensity, underlining)
Definition effect.hpp:27

terminalpp::effect::effect
constexpr effect() noexcept
Initialises the intensity to the default (normal) value.
Definition effect.hpp:31

terminalpp::extent
A class that represents a direction with distance in space (a vector).
Definition extent.hpp:18

terminalpp::point
A class that represents a position in space.
Definition point.hpp:17

terminalpp::rectangle
A class that represents a rectangle in space.
Definition rectangle.hpp:15

terminalpp::rectangle::operator<=>
constexpr friend auto operator<=>(rectangle const &lhs, rectangle const &rhs) noexcept=default
Relational operators for rectangles.

terminalpp::rectangle::size_
terminalpp::extent size_
The size (amount the rectangle extends right and down) of the rectangle.
Definition rectangle.hpp:45

terminalpp::rectangle::rectangle
constexpr rectangle() noexcept=default
Default Constructor.

terminalpp::rectangle::origin_
terminalpp::point origin_
The origin (top-left point) of the rectangle.
Definition rectangle.hpp:41