LiteFX 0.4.1.2025
Computer Graphics Engine
Loading...
Searching...
No Matches
LiteFX::Math::Size2d Class Reference

#include <math.hpp>

Inherits LiteFX::Math::Vector< size_t, 2 >.

Public Member Functions

 Size2d () noexcept
 
 Size2d (size_t v) noexcept
 
 Size2d (size_t w, size_t h) noexcept
 
 Size2d (const Size2d &)
 
 Size2d (Size2d &&) noexcept
 
 ~Size2d () noexcept=default
 
Size2doperator= (const Size2d &_other)
 
Size2doperator= (Size2d &&_other) noexcept
 
 operator Size3d () const noexcept
 
 operator Size4d () const noexcept
 
Size2d operator/ (size_t s) noexcept
 
Size2doperator/= (size_t s) noexcept
 
Size2d operator* (size_t s) noexcept
 
Size2doperator*= (size_t s) noexcept
 
Size2d operator+ (const Size2d &s) noexcept
 
Size2doperator+= (const Size2d &s) noexcept
 
Size2d operator- (const Size2d &s) noexcept
 
Size2doperator-= (const Size2d &s) noexcept
 
size_t width () const noexcept
 
size_t & width () noexcept
 
size_t height () const noexcept
 
size_t & height () noexcept
 
- Public Member Functions inherited from LiteFX::Math::Vector< size_t, 2 >
constexpr Vector () noexcept=default
 Initializes an empty vector.
 
constexpr Vector (Vector &&_other) noexcept=default
 Initializes a vector by taking over another vector.
 
constexpr Vector (const Vector &_other)=default
 Initializes a vector with the values provided by another vector.
 
constexpr Vector (size_t val) noexcept
 Initializes a vector where all elements take the value provided by val .
 
constexpr Vector (size_t x, size_t y) noexcept
 Initializes a 2D vector using the values provided by x and y .
 
constexpr Vector (size_t x, size_t y, size_t z) noexcept
 Initializes a 3D vector using the values provided by x , y and z .
 
constexpr Vector (size_t x, size_t y, size_t z, size_t w) noexcept
 Initializes a 4D vector using the values provided by x , y , z and w .
 
constexpr Vector (std::ranges::input_range auto &&input) noexcept
 Initializes the vector from an arbitrary input range.
 
constexpr Vectoroperator= (Vector &&_other) noexcept=default
 Moves the elements of the other vector to the current vector.
 
constexpr Vectoroperator= (const Vector &_other)=default
 Copys the elements of another vector into the current vector.
 
constexpr auto & operator= (std::ranges::input_range auto &&input) noexcept
 Copies the values from an arbitrary input range into the current vector instance.
 
constexpr ~Vector () noexcept=default
 Destroys the vector.
 
constexpr size_t operator[] (unsigned int i) const noexcept
 Returns a value from the vector, indexed by the parameter i .
 
constexpr size_t & operator[] (unsigned int i) noexcept
 Returns a reference to a value from the vector, indexed by the parameter i .
 
constexpr auto begin () noexcept
 Returns an interator for that addresses the begin of the vector elements.
 
constexpr auto end () noexcept
 Returns an interator for that addresses the end of the vector elements.
 
constexpr auto cbegin () const noexcept
 Returns a constant interator for that addresses the begin of the vector elements.
 
constexpr auto cend () const noexcept
 Returns a constant interator for that addresses the end of the vector elements.
 
constexpr const scalar_typeelements () const noexcept
 Returns a pointer to the elements of the vector.
 
constexpr operator std::array< size_t, DIM > () const noexcept
 Converts the vector to an instance of std::array.
 
constexpr operator std::vector< size_t > () const
 Converts the vector into an instance of type std::vector.
 
constexpr int size () const noexcept
 Returns the number of dimensions of the vector.
 
constexpr scalar_type x () const noexcept
 Returns the value of the x component of the vector.
 
constexpr scalar_typex () noexcept
 Returns a reference of the value of the x component of the vector.
 
constexpr scalar_type y () const noexcept
 Returns the value of the y component of the vector.
 
constexpr scalar_typey () noexcept
 Returns a reference of the value of the y component of the vector.
 
constexpr scalar_type z () const noexcept
 Returns the value of the z component of the vector.
 
constexpr scalar_typez () noexcept
 Returns a reference of the value of the z component of the vector.
 
constexpr scalar_type w () const noexcept
 Returns the value of the w component of the vector.
 
constexpr scalar_typew () noexcept
 Returns a reference of the value of the w component of the vector.
 

Additional Inherited Members

- Public Types inherited from LiteFX::Math::Vector< size_t, 2 >
using scalar_type
 The type of the vector elements.
 
using vec_type
 The type of the vector itself.
 
- Static Public Attributes inherited from LiteFX::Math::Vector< size_t, 2 >
static constexpr size_t vec_size
 Stores the size of the vector.
 
- Protected Types inherited from LiteFX::Math::Vector< size_t, 2 >
using array_type
 
- Protected Attributes inherited from LiteFX::Math::Vector< size_t, 2 >
array_type m_elements
 

Constructor & Destructor Documentation

◆ Size2d() [1/5]

Size2d::Size2d ( )
noexcept

◆ Size2d() [2/5]

Size2d::Size2d ( size_t v)
noexcept

◆ Size2d() [3/5]

Size2d::Size2d ( size_t w,
size_t h )
noexcept

◆ Size2d() [4/5]

Size2d::Size2d ( const Size2d & _other)

◆ Size2d() [5/5]

Size2d::Size2d ( Size2d && _other)
noexcept

◆ ~Size2d()

LiteFX::Math::Size2d::~Size2d ( )
defaultnoexcept

Member Function Documentation

◆ height() [1/2]

size_t Size2d::height ( ) const
noexcept

◆ height() [2/2]

size_t & Size2d::height ( )
noexcept

◆ operator Size3d()

Size2d::operator Size3d ( ) const
noexcept

◆ operator Size4d()

Size2d::operator Size4d ( ) const
noexcept

◆ operator*()

Size2d Size2d::operator* ( size_t s)
noexcept

◆ operator*=()

Size2d & Size2d::operator*= ( size_t s)
noexcept

◆ operator+()

Size2d Size2d::operator+ ( const Size2d & s)
noexcept

◆ operator+=()

Size2d & Size2d::operator+= ( const Size2d & s)
noexcept

◆ operator-()

Size2d Size2d::operator- ( const Size2d & s)
noexcept

◆ operator-=()

Size2d & Size2d::operator-= ( const Size2d & s)
noexcept

◆ operator/()

Size2d Size2d::operator/ ( size_t s)
noexcept

◆ operator/=()

Size2d & Size2d::operator/= ( size_t s)
noexcept

◆ operator=() [1/2]

Size2d & Size2d::operator= ( const Size2d & _other)

◆ operator=() [2/2]

Size2d & Size2d::operator= ( Size2d && _other)
noexcept

◆ width() [1/2]

size_t Size2d::width ( ) const
noexcept

◆ width() [2/2]

size_t & Size2d::width ( )
noexcept