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::Rgb< T > Struct Template Referencefinal

#include <rgb.h>

Collaboration diagram for osc::Rgb< 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

 Rgb ()=default
 
constexpr Rgb (value_type v)
 
constexpr Rgb (value_type r_, value_type g_, value_type b_)
 
constexpr Rgb (const Vector< value_type, 3 > &v)
 
template<ColorComponent U>
requires std::constructible_from<T, const U&>
constexpr Rgb (const Vector< U, 3 > &v)
 
template<ColorComponent U>
requires std::constructible_from<T, const U&>
 not (std::convertible_to< U, T >)) const expr Rgb(const Rgb< U > &v)
 
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
 

Static Public Member Functions

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

Public Attributes

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

Friends

bool operator== (const Rgb &, const Rgb &)=default
 

Member Typedef Documentation

◆ const_iterator

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

◆ const_reference

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

◆ iterator

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

◆ reference

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

◆ size_type

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

◆ value_type

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

Constructor & Destructor Documentation

◆ Rgb() [1/5]

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

◆ Rgb() [2/5]

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

◆ Rgb() [3/5]

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

◆ Rgb() [4/5]

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

◆ Rgb() [5/5]

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

Member Function Documentation

◆ begin() [1/2]

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

◆ begin() [2/2]

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

◆ black()

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

◆ blue()

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

◆ cyan()

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

◆ dark_green()

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

◆ dark_grey()

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

◆ darker_grey()

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

◆ darkest_grey()

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

◆ end() [1/2]

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

◆ end() [2/2]

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

◆ green()

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

◆ light_grey()

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

◆ lighter_grey()

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

◆ lightest_grey()

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

◆ magenta()

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

◆ muted_blue()

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

◆ muted_green()

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

◆ muted_red()

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

◆ muted_yellow()

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

◆ not()

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

◆ operator[]() [1/2]

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

◆ operator[]() [2/2]

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

◆ orange()

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

◆ purple()

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

◆ red()

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

◆ size()

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

◆ white()

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

◆ yellow()

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

Friends And Related Symbol Documentation

◆ operator==

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

Member Data Documentation

◆ b

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

◆ g

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

◆ r

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