impeller::TSize< T > Struct Template Reference

#include <size.h>

Public Types
using	Type = T

Public Member Functions
constexpr	TSize ()
constexpr	TSize (Type width, Type height)
template<class U >
constexpr	TSize (const TSize< U > &other)
constexpr TSize	operator* (Scalar scale) const
constexpr TSize	operator/ (Scalar scale) const
constexpr TSize	operator/ (const TSize &s) const
constexpr bool	operator== (const TSize &s) const
constexpr bool	operator!= (const TSize &s) const
constexpr TSize	operator+ (const TSize &s) const
constexpr TSize	operator- (const TSize &s) const
constexpr TSize	operator- () const
constexpr TSize	Min (const TSize &o) const
constexpr TSize	Max (const TSize &o) const
constexpr Type	MaxDimension () const
constexpr TSize	Abs () const
constexpr TSize	Floor () const
constexpr TSize	Ceil () const
constexpr TSize	Round () const
constexpr Type	Area () const
constexpr bool	IsEmpty () const
	Returns true if either of the width or height are 0, negative, or NaN.
constexpr bool	IsSquare () const
constexpr size_t	MipCount () const

Static Public Member Functions
static constexpr TSize	MakeWH (Type width, Type height)
static constexpr TSize	Infinite ()
template<class U >
static constexpr TSize	Ceil (const TSize< U > &other)

Public Attributes
Type	width = {}
Type	height = {}

Detailed Description

template<class T>
struct impeller::TSize< T >

Definition at line 19 of file size.h.

Member Typedef Documentation

Type

template<class T >

using impeller::TSize< T >::Type = T

Definition at line 20 of file size.h.

Constructor & Destructor Documentation

TSize() [1/3]

template<class T >

constexpr impeller::TSize< T >::TSize ( )

inlineconstexpr

Definition at line 25 of file size.h.

{}

TSize() [2/3]

template<class T >

constexpr impeller::TSize< T >::TSize ( Type  width, Type  height  )

inlineconstexpr

Definition at line 27 of file size.h.

: width(width), height(height) {}

TSize() [3/3]

template<class T >

template<class U >

constexpr impeller::TSize< T >::TSize ( const TSize< U > &  other )

inlineexplicitconstexpr

Definition at line 30 of file size.h.

      : TSize(static_cast<Type>(other.width), static_cast<Type>(other.height)) {
  }

Member Function Documentation

Abs()

template<class T >

constexpr TSize impeller::TSize< T >::Abs ( ) const

inlineconstexpr

Definition at line 90 of file size.h.

{ return {std::fabs(width), std::fabs(height)}; }

Area()

template<class T >

constexpr Type impeller::TSize< T >::Area ( ) const

inlineconstexpr

Definition at line 102 of file size.h.

{ return width * height; }

Ceil() [1/2]

template<class T >

constexpr TSize impeller::TSize< T >::Ceil ( ) const

inlineconstexpr

Definition at line 96 of file size.h.

{ return {std::ceil(width), std::ceil(height)}; }

Ceil() [2/2]

template<class T >

template<class U >

static constexpr TSize impeller::TSize< T >::Ceil ( const TSize< U > &  other )

inlinestaticconstexpr

Definition at line 110 of file size.h.

                                                     {
    return TSize{static_cast<Type>(std::ceil(other.width)),
                 static_cast<Type>(std::ceil(other.height))};
  }

Floor()

template<class T >

constexpr TSize impeller::TSize< T >::Floor ( ) const

inlineconstexpr

Definition at line 92 of file size.h.

                                {
    return {std::floor(width), std::floor(height)};
  }

Infinite()

template<class T >

static constexpr TSize impeller::TSize< T >::Infinite ( )

inlinestaticconstexpr

Definition at line 38 of file size.h.

                                    {
    return TSize{std::numeric_limits<Type>::max(),
                 std::numeric_limits<Type>::max()};
  }

IsEmpty()

template<class T >

constexpr bool impeller::TSize< T >::IsEmpty ( ) const

inlineconstexpr

Returns true if either of the width or height are 0, negative, or NaN.

Definition at line 105 of file size.h.

{ return !(width > 0 && height > 0); }

IsSquare()

template<class T >

constexpr bool impeller::TSize< T >::IsSquare ( ) const

inlineconstexpr

Definition at line 107 of file size.h.

{ return width == height; }

MakeWH()

template<class T >

static constexpr TSize impeller::TSize< T >::MakeWH ( Type  width, Type  height  )

inlinestaticconstexpr

Definition at line 34 of file size.h.

                                                         {
    return TSize{width, height};
  }

Max()

template<class T >

constexpr TSize impeller::TSize< T >::Max ( const TSize< T > &  o ) const

inlineconstexpr

Definition at line 81 of file size.h.

                                            {
    return {
        std::max(width, o.width),
        std::max(height, o.height),
    };
  }

MaxDimension()

template<class T >

constexpr Type impeller::TSize< T >::MaxDimension ( ) const

inlineconstexpr

Definition at line 88 of file size.h.

{ return std::max(width, height); }

Min()

template<class T >

constexpr TSize impeller::TSize< T >::Min ( const TSize< T > &  o ) const

inlineconstexpr

Definition at line 74 of file size.h.

                                            {
    return {
        std::min(width, o.width),
        std::min(height, o.height),
    };
  }

MipCount()

template<class T >

constexpr size_t impeller::TSize< T >::MipCount ( ) const

inlineconstexpr

Definition at line 115 of file size.h.

                                    {
    constexpr size_t minimum_mip = 1u;
    if (IsEmpty()) {
      return minimum_mip;
    }
    size_t result = std::max(ceil(log2(width)), ceil(log2(height)));
    return std::max(result, minimum_mip);
  }

operator!=()

template<class T >

constexpr bool impeller::TSize< T >::operator!= ( const TSize< T > &  s ) const

inlineconstexpr

Definition at line 60 of file size.h.

                                                  {
    return s.width != width || s.height != height;
  }

operator*()

template<class T >

constexpr TSize impeller::TSize< T >::operator* ( Scalar  scale ) const

inlineconstexpr

Definition at line 43 of file size.h.

                                                {
    return {width * scale, height * scale};
  }

operator+()

template<class T >

constexpr TSize impeller::TSize< T >::operator+ ( const TSize< T > &  s ) const

inlineconstexpr

Definition at line 64 of file size.h.

                                                  {
    return {width + s.width, height + s.height};
  }

operator-() [1/2]

template<class T >

constexpr TSize impeller::TSize< T >::operator- ( ) const

inlineconstexpr

Definition at line 72 of file size.h.

{ return {-width, -height}; }

operator-() [2/2]

template<class T >

constexpr TSize impeller::TSize< T >::operator- ( const TSize< T > &  s ) const

inlineconstexpr

Definition at line 68 of file size.h.

                                                  {
    return {width - s.width, height - s.height};
  }

operator/() [1/2]

template<class T >

constexpr TSize impeller::TSize< T >::operator/ ( const TSize< T > &  s ) const

inlineconstexpr

Definition at line 52 of file size.h.

                                                  {
    return {width / s.width, height / s.height};
  }

operator/() [2/2]

template<class T >

constexpr TSize impeller::TSize< T >::operator/ ( Scalar  scale ) const

inlineconstexpr

Definition at line 47 of file size.h.

                                                {
    return {static_cast<Scalar>(width) / scale,
            static_cast<Scalar>(height) / scale};
  }

operator==()

template<class T >

constexpr bool impeller::TSize< T >::operator== ( const TSize< T > &  s ) const

inlineconstexpr

Definition at line 56 of file size.h.

                                                  {
    return s.width == width && s.height == height;
  }

Round()

template<class T >

constexpr TSize impeller::TSize< T >::Round ( ) const

inlineconstexpr

Definition at line 98 of file size.h.

                                {
    return {std::round(width), std::round(height)};
  }

Member Data Documentation

height

template<class T >

Type impeller::TSize< T >::height = {}

Definition at line 23 of file size.h.

{};

width

template<class T >

Type impeller::TSize< T >::width = {}

Definition at line 22 of file size.h.

{};

---

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

• impeller/geometry/size.h