CommonLibSSE NG
RE::Color Struct Reference

#include <Color.h>

Public Types

enum  : std::size_t {
  kRed , kGreen , kBlue , kAlpha ,
  kTotal
}
 

Public Member Functions

constexpr Color () noexcept
 
constexpr Color (const Color &a_rhs) noexcept
 
constexpr Color (Color &&a_rhs) noexcept
 
constexpr Color (std::uint8_t a_red, std::uint8_t a_green, std::uint8_t a_blue, std::uint8_t a_alpha) noexcept
 
constexpr Color (std::uint32_t a_hexValue) noexcept
 
 Color (const NiColor &a_rhs)
 
 ~Color () noexcept=default
 
constexpr Coloroperator= (const Color &a_rhs) noexcept
 
constexpr Coloroperator= (Color &&a_rhs) noexcept
 
constexpr std::uint8_t & operator[] (std::size_t a_idx) noexcept
 
constexpr const std::uint8_t & operator[] (std::size_t a_idx) const noexcept
 
Color operator+ (const Color &a_rhs) const noexcept
 
Coloroperator+= (const Color &a_rhs) noexcept
 
Color operator- (const Color &a_rhs) const noexcept
 
Coloroperator-= (const Color &a_rhs) noexcept
 
Color operator* (const Color &a_rhs) const noexcept
 
Coloroperator*= (const Color &a_rhs) noexcept
 
Color operator/ (const Color &a_rhs) const noexcept
 
Coloroperator/= (const Color &a_rhs) noexcept
 
Color operator+ (std::uint8_t a_value) const noexcept
 
Coloroperator+= (std::uint8_t a_value) noexcept
 
Color operator- (std::uint8_t a_value) const noexcept
 
Coloroperator-= (std::uint8_t a_value) noexcept
 
Color operator* (std::uint8_t a_value) const noexcept
 
Coloroperator*= (std::uint8_t a_value) noexcept
 
Color operator/ (std::uint8_t a_value) const noexcept
 
Coloroperator/= (std::uint8_t a_value) noexcept
 
std::uint32_t ToInt () const
 
std::string ToHex () const
 

Public Attributes

std::uint8_t red
 
std::uint8_t green
 
std::uint8_t blue
 
std::uint8_t alpha
 

Friends

constexpr friend bool operator== (const Color &a_lhs, const Color &a_rhs) noexcept
 
constexpr friend bool operator!= (const Color &a_lhs, const Color &a_rhs) noexcept
 
Color operator- (std::uint8_t a_lhs, const Color &a_rhs)
 
Color operator* (std::uint8_t a_lhs, const Color &a_rhs)
 
Color operator/ (std::uint8_t a_lhs, const Color &a_rhs)
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : std::size_t
Enumerator
kRed 
kGreen 
kBlue 
kAlpha 
kTotal 

Constructor & Destructor Documentation

◆ Color() [1/6]

constexpr RE::Color::Color ( )
inlineconstexprnoexcept

◆ Color() [2/6]

constexpr RE::Color::Color ( const Color a_rhs)
inlineconstexprnoexcept

◆ Color() [3/6]

constexpr RE::Color::Color ( Color &&  a_rhs)
inlineconstexprnoexcept

◆ Color() [4/6]

constexpr RE::Color::Color ( std::uint8_t  a_red,
std::uint8_t  a_green,
std::uint8_t  a_blue,
std::uint8_t  a_alpha 
)
inlineconstexprnoexcept

◆ Color() [5/6]

constexpr RE::Color::Color ( std::uint32_t  a_hexValue)
inlineconstexprnoexcept

◆ Color() [6/6]

RE::Color::Color ( const NiColor a_rhs)

◆ ~Color()

RE::Color::~Color ( )
defaultnoexcept

Member Function Documentation

◆ operator*() [1/2]

Color RE::Color::operator* ( const Color a_rhs) const
inlinenoexcept

◆ operator*() [2/2]

Color RE::Color::operator* ( std::uint8_t  a_value) const
inlinenoexcept

◆ operator*=() [1/2]

Color& RE::Color::operator*= ( const Color a_rhs)
inlinenoexcept

◆ operator*=() [2/2]

Color& RE::Color::operator*= ( std::uint8_t  a_value)
inlinenoexcept

◆ operator+() [1/2]

Color RE::Color::operator+ ( const Color a_rhs) const
inlinenoexcept

◆ operator+() [2/2]

Color RE::Color::operator+ ( std::uint8_t  a_value) const
inlinenoexcept

◆ operator+=() [1/2]

Color& RE::Color::operator+= ( const Color a_rhs)
inlinenoexcept

◆ operator+=() [2/2]

Color& RE::Color::operator+= ( std::uint8_t  a_value)
inlinenoexcept

◆ operator-() [1/2]

Color RE::Color::operator- ( const Color a_rhs) const
inlinenoexcept

◆ operator-() [2/2]

Color RE::Color::operator- ( std::uint8_t  a_value) const
inlinenoexcept

◆ operator-=() [1/2]

Color& RE::Color::operator-= ( const Color a_rhs)
inlinenoexcept

◆ operator-=() [2/2]

Color& RE::Color::operator-= ( std::uint8_t  a_value)
inlinenoexcept

◆ operator/() [1/2]

Color RE::Color::operator/ ( const Color a_rhs) const
inlinenoexcept

◆ operator/() [2/2]

Color RE::Color::operator/ ( std::uint8_t  a_value) const
inlinenoexcept

◆ operator/=() [1/2]

Color& RE::Color::operator/= ( const Color a_rhs)
inlinenoexcept

◆ operator/=() [2/2]

Color& RE::Color::operator/= ( std::uint8_t  a_value)
inlinenoexcept

◆ operator=() [1/2]

constexpr Color& RE::Color::operator= ( Color &&  a_rhs)
inlineconstexprnoexcept

◆ operator=() [2/2]

constexpr Color& RE::Color::operator= ( const Color a_rhs)
inlineconstexprnoexcept

◆ operator[]() [1/2]

constexpr const std::uint8_t& RE::Color::operator[] ( std::size_t  a_idx) const
inlineconstexprnoexcept

◆ operator[]() [2/2]

constexpr std::uint8_t& RE::Color::operator[] ( std::size_t  a_idx)
inlineconstexprnoexcept

◆ ToHex()

std::string RE::Color::ToHex ( ) const

◆ ToInt()

std::uint32_t RE::Color::ToInt ( ) const

Friends And Related Function Documentation

◆ operator!=

constexpr friend bool operator!= ( const Color a_lhs,
const Color a_rhs 
)
friend

◆ operator*

Color operator* ( std::uint8_t  a_lhs,
const Color a_rhs 
)
friend

◆ operator-

Color operator- ( std::uint8_t  a_lhs,
const Color a_rhs 
)
friend

◆ operator/

Color operator/ ( std::uint8_t  a_lhs,
const Color a_rhs 
)
friend

◆ operator==

constexpr friend bool operator== ( const Color a_lhs,
const Color a_rhs 
)
friend

Member Data Documentation

◆ alpha

std::uint8_t RE::Color::alpha

◆ blue

std::uint8_t RE::Color::blue

◆ green

std::uint8_t RE::Color::green

◆ red

std::uint8_t RE::Color::red

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