opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
osc::Rgba< T > Struct Template Referencefinal

#include <rgba.h>

Collaboration diagram for osc::Rgba< T >:
[legend]

Public Types

using value_type = T
 
using reference = value_type &
 
using const_reference = const value_type &
 
using size_type = size_t
 
using iterator = value_type *
 
using const_iterator = const value_type *
 

Public Member Functions

 Rgba ()=default
 
constexpr Rgba (value_type v)
 
constexpr Rgba (value_type v, value_type alpha)
 
constexpr Rgba (const Vector< value_type, 3 > &v)
 
constexpr Rgba (const Vector< value_type, 3 > &v, value_type alpha)
 
constexpr Rgba (const Vector< value_type, 4 > &v)
 
template<ColorComponent U>
requires std::constructible_from<T, const U&>
constexpr Rgba (const Vector< U, 4 > &v)
 
constexpr Rgba (value_type r_, value_type g_, value_type b_, value_type a_)
 
constexpr Rgba (value_type r_, value_type g_, value_type b_)
 
template<ColorComponent U>
requires std::constructible_from<T, const U&>
 not (std::convertible_to< U, T >)) const expr Rgba(const Rgba< U > &v)
 
constexpr Rgba (const Rgb< T > &rgb, T alpha=T{1.0f})
 
constexpr reference operator[] (size_type pos)
 
constexpr const_reference operator[] (size_type pos) const
 
constexpr size_t size () const
 
constexpr iterator begin ()
 
constexpr const_iterator begin () const
 
constexpr iterator end ()
 
constexpr const_iterator end () const
 
constexpr Rgba with_alpha (value_type a_) const
 
constexpr Rgba with_element (size_type pos, value_type value) const
 
constexpr Rgb< T > rgb () const
 

Static Public Member Functions

static constexpr Rgba clear ()
 
static constexpr Rgba white ()
 
static constexpr Rgba lightest_grey ()
 
static constexpr Rgba lighter_grey ()
 
static constexpr Rgba light_grey ()
 
static constexpr Rgba dark_grey ()
 
static constexpr Rgba darker_grey ()
 
static constexpr Rgba darkest_grey ()
 
static constexpr Rgba black ()
 
static constexpr Rgba muted_red ()
 
static constexpr Rgba red ()
 
static constexpr Rgba muted_green ()
 
static constexpr Rgba green ()
 
static constexpr Rgba dark_green ()
 
static constexpr Rgba muted_blue ()
 
static constexpr Rgba blue ()
 
static constexpr Rgba cyan ()
 
static constexpr Rgba magenta ()
 
static constexpr Rgba muted_yellow ()
 
static constexpr Rgba yellow ()
 
static constexpr Rgba orange ()
 
static constexpr Rgba purple ()
 

Public Attributes

value_type r {}
 
value_type g {}
 
value_type b {}
 
value_type a {}
 

Friends

bool operator== (const Rgba &, const Rgba &)=default
 
constexpr friend Rgba & operator*= (Rgba &lhs, const Rgba &rhs)
 
constexpr friend Rgba operator* (const Rgba &lhs, const Rgba &rhs)
 
constexpr friend Rgba operator* (value_type lhs, const Rgba &rhs)
 

Member Typedef Documentation

◆ const_iterator

template<ColorComponent T>
using osc::Rgba< T >::const_iterator = const value_type*

◆ const_reference

template<ColorComponent T>
using osc::Rgba< T >::const_reference = const value_type&

◆ iterator

template<ColorComponent T>
using osc::Rgba< T >::iterator = value_type*

◆ reference

template<ColorComponent T>
using osc::Rgba< T >::reference = value_type&

◆ size_type

template<ColorComponent T>
using osc::Rgba< T >::size_type = size_t

◆ value_type

template<ColorComponent T>
using osc::Rgba< T >::value_type = T

Constructor & Destructor Documentation

◆ Rgba() [1/10]

template<ColorComponent T>
osc::Rgba< T >::Rgba ( )
default

◆ Rgba() [2/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( value_type  v)
inlineexplicitconstexpr

◆ Rgba() [3/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( value_type  v,
value_type  alpha 
)
inlineconstexpr

◆ Rgba() [4/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( const Vector< value_type, 3 > &  v)
inlineexplicitconstexpr

◆ Rgba() [5/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( const Vector< value_type, 3 > &  v,
value_type  alpha 
)
inlineconstexpr

◆ Rgba() [6/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( const Vector< value_type, 4 > &  v)
inlineexplicitconstexpr

◆ Rgba() [7/10]

template<ColorComponent T>
template<ColorComponent U>
requires std::constructible_from<T, const U&>
constexpr osc::Rgba< T >::Rgba ( const Vector< U, 4 > &  v)
inlineexplicitconstexpr

◆ Rgba() [8/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( value_type  r_,
value_type  g_,
value_type  b_,
value_type  a_ 
)
inlineconstexpr

◆ Rgba() [9/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( value_type  r_,
value_type  g_,
value_type  b_ 
)
inlineconstexpr

◆ Rgba() [10/10]

template<ColorComponent T>
constexpr osc::Rgba< T >::Rgba ( const Rgb< T > &  rgb,
T  alpha = T{1.0f} 
)
inlineconstexpr

Member Function Documentation

◆ begin() [1/2]

template<ColorComponent T>
constexpr iterator osc::Rgba< T >::begin ( )
inlineconstexpr

◆ begin() [2/2]

template<ColorComponent T>
constexpr const_iterator osc::Rgba< T >::begin ( ) const
inlineconstexpr

◆ black()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::black ( )
inlinestaticconstexpr

◆ blue()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::blue ( )
inlinestaticconstexpr

◆ clear()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::clear ( )
inlinestaticconstexpr

◆ cyan()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::cyan ( )
inlinestaticconstexpr

◆ dark_green()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::dark_green ( )
inlinestaticconstexpr

◆ dark_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::dark_grey ( )
inlinestaticconstexpr

◆ darker_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::darker_grey ( )
inlinestaticconstexpr

◆ darkest_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::darkest_grey ( )
inlinestaticconstexpr

◆ end() [1/2]

template<ColorComponent T>
constexpr iterator osc::Rgba< T >::end ( )
inlineconstexpr

◆ end() [2/2]

template<ColorComponent T>
constexpr const_iterator osc::Rgba< T >::end ( ) const
inlineconstexpr

◆ green()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::green ( )
inlinestaticconstexpr

◆ light_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::light_grey ( )
inlinestaticconstexpr

◆ lighter_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::lighter_grey ( )
inlinestaticconstexpr

◆ lightest_grey()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::lightest_grey ( )
inlinestaticconstexpr

◆ magenta()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::magenta ( )
inlinestaticconstexpr

◆ muted_blue()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::muted_blue ( )
inlinestaticconstexpr

◆ muted_green()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::muted_green ( )
inlinestaticconstexpr

◆ muted_red()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::muted_red ( )
inlinestaticconstexpr

◆ muted_yellow()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::muted_yellow ( )
inlinestaticconstexpr

◆ not()

template<ColorComponent T>
template<ColorComponent U>
requires std::constructible_from<T, const U&>
osc::Rgba< T >::not ( std::convertible_to< U, T >  ) const &
inlineexplicit

◆ operator[]() [1/2]

template<ColorComponent T>
constexpr reference osc::Rgba< T >::operator[] ( size_type  pos)
inlineconstexpr

◆ operator[]() [2/2]

template<ColorComponent T>
constexpr const_reference osc::Rgba< T >::operator[] ( size_type  pos) const
inlineconstexpr

◆ orange()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::orange ( )
inlinestaticconstexpr

◆ purple()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::purple ( )
inlinestaticconstexpr

◆ red()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::red ( )
inlinestaticconstexpr

◆ rgb()

template<ColorComponent T>
constexpr Rgb< T > osc::Rgba< T >::rgb ( ) const
inlineconstexpr

◆ size()

template<ColorComponent T>
constexpr size_t osc::Rgba< T >::size ( ) const
inlineconstexpr

◆ white()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::white ( )
inlinestaticconstexpr

◆ with_alpha()

template<ColorComponent T>
constexpr Rgba osc::Rgba< T >::with_alpha ( value_type  a_) const
inlineconstexpr

◆ with_element()

template<ColorComponent T>
constexpr Rgba osc::Rgba< T >::with_element ( size_type  pos,
value_type  value 
) const
inlineconstexpr

◆ yellow()

template<ColorComponent T>
static constexpr Rgba osc::Rgba< T >::yellow ( )
inlinestaticconstexpr

Friends And Related Symbol Documentation

◆ operator* [1/2]

template<ColorComponent T>
constexpr friend Rgba operator* ( const Rgba< T > &  lhs,
const Rgba< T > &  rhs 
)
friend

◆ operator* [2/2]

template<ColorComponent T>
constexpr friend Rgba operator* ( value_type  lhs,
const Rgba< T > &  rhs 
)
friend

◆ operator*=

template<ColorComponent T>
constexpr friend Rgba & operator*= ( Rgba< T > &  lhs,
const Rgba< T > &  rhs 
)
friend

◆ operator==

template<ColorComponent T>
bool operator== ( const Rgba< T > &  ,
const Rgba< T > &   
)
friend

Member Data Documentation

◆ a

template<ColorComponent T>
value_type osc::Rgba< T >::a {}

◆ b

template<ColorComponent T>
value_type osc::Rgba< T >::b {}

◆ g

template<ColorComponent T>
value_type osc::Rgba< T >::g {}

◆ r

template<ColorComponent T>
value_type osc::Rgba< T >::r {}
The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.8