OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::Color Struct Reference

#include <Color.hpp>

Public Types

using value_type = uint8
 

Public Member Functions

SIV3D_NODISCARD_CXX20 Color ()=default
 デフォルトコンストラクタ More...
 
SIV3D_NODISCARD_CXX20 Color (const Color &)=default
 コピーコンストラクタ More...
 
constexpr SIV3D_NODISCARD_CXX20 Color (value_type _r, value_type _g, value_type _b, value_type _a=255) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 Color (value_type rgb, value_type _a=255) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 Color (Color rgb, value_type _a) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 Color (const ColorF &color) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 Color (const ColorF &color, value_type _a) noexcept
 
SIV3D_NODISCARD_CXX20 Color (const HSV &hsva) noexcept
 
SIV3D_NODISCARD_CXX20 Color (const HSV &hsv, value_type _a) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 Color (StringView code) noexcept
 
constexpr Coloroperator= (const Color &) noexcept=default
 
constexpr Coloroperator= (const ColorF &color) noexcept
 
Coloroperator= (const HSV &hsva) noexcept
 
constexpr Color operator~ () const noexcept
 
constexpr ColorsetR (uint32 _r) noexcept
 
constexpr ColorsetG (uint32 _g) noexcept
 
constexpr ColorsetB (uint32 _b) noexcept
 
constexpr ColorsetA (uint32 _a) noexcept
 
constexpr ColorsetRGB (uint32 rgb) noexcept
 
constexpr ColorsetRGB (uint32 _r, uint32 _g, uint32 _b) noexcept
 
constexpr Colorset (uint32 rgb, uint32 _a=255) noexcept
 
constexpr Colorset (uint32 _r, uint32 _g, uint32 _b, uint32 _a=255) noexcept
 
constexpr Colorset (Color color) noexcept
 
constexpr Color withAlpha (uint32 _a) const noexcept
 
constexpr uint8 grayscale0_255 () const noexcept
 
constexpr double grayscale () const noexcept
 
constexpr uint8 minRGBComponent () const noexcept
 
constexpr uint8 maxRGBComponent () const noexcept
 
constexpr uint8 minComponent () const noexcept
 
constexpr uint8 maxComponent () const noexcept
 
constexpr uint32 asUint32 () const noexcept
 
constexpr Color lerp (Color other, double f) const noexcept
 
Color gamma (double gamma) const noexcept
 
ColorF removeSRGBCurve () const noexcept
 
ColorF applySRGBCurve () const noexcept
 
String toHex () const
 
size_t hash () const noexcept
 

Static Public Member Functions

static constexpr Color Zero () noexcept
 
static constexpr uint8 ToUint8 (float x) noexcept
 
static constexpr uint8 ToUint8 (double x) noexcept
 
static constexpr Color FromRGBA (uint32 rgba) noexcept
 
static constexpr Color FromABGR (uint32 abgr) noexcept
 

Public Attributes

value_type r
 赤 | Red More...
 
value_type g
 緑 | Green More...
 
value_type b
 青 | Blue More...
 
value_type a
 アルファ | Alpha More...
 

Friends

constexpr friend bool operator== (Color lhs, Color rhs) noexcept
 2 つの色が等しいかを返します。 More...
 
constexpr friend bool operator!= (Color lhs, Color rhs) noexcept
 
template<class CharType >
std::basic_ostream< CharType > & operator<< (std::basic_ostream< CharType > &output, const Color &value)
 
template<class CharType >
std::basic_istream< CharType > & operator>> (std::basic_istream< CharType > &input, Color &value)
 
void Formatter (FormatData &formatData, const Color &value)
 

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ Color() [1/10]

SIV3D_NODISCARD_CXX20 s3d::Color::Color ( )
default

デフォルトコンストラクタ

◆ Color() [2/10]

SIV3D_NODISCARD_CXX20 s3d::Color::Color ( const Color )
default

コピーコンストラクタ

◆ Color() [3/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( value_type  _r,
value_type  _g,
value_type  _b,
value_type  _a = 255 
)
constexprnoexcept

◆ Color() [4/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( value_type  rgb,
value_type  _a = 255 
)
explicitconstexprnoexcept

◆ Color() [5/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( Color  rgb,
value_type  _a 
)
constexprnoexcept

◆ Color() [6/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( const ColorF color)
constexprnoexcept

◆ Color() [7/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( const ColorF color,
value_type  _a 
)
constexprnoexcept

◆ Color() [8/10]

SIV3D_NODISCARD_CXX20 s3d::Color::Color ( const HSV hsva)
noexcept

◆ Color() [9/10]

SIV3D_NODISCARD_CXX20 s3d::Color::Color ( const HSV hsv,
value_type  _a 
)
noexcept

◆ Color() [10/10]

constexpr SIV3D_NODISCARD_CXX20 s3d::Color::Color ( StringView  code)
explicitconstexprnoexcept

Member Function Documentation

◆ applySRGBCurve()

ColorF s3d::Color::applySRGBCurve ( ) const
noexcept

◆ asUint32()

constexpr uint32 s3d::Color::asUint32 ( ) const
constexprnoexcept

◆ FromABGR()

static constexpr Color s3d::Color::FromABGR ( uint32  abgr)
staticconstexprnoexcept

◆ FromRGBA()

static constexpr Color s3d::Color::FromRGBA ( uint32  rgba)
staticconstexprnoexcept

◆ gamma()

Color s3d::Color::gamma ( double  gamma) const
noexcept

◆ grayscale()

constexpr double s3d::Color::grayscale ( ) const
constexprnoexcept

◆ grayscale0_255()

constexpr uint8 s3d::Color::grayscale0_255 ( ) const
constexprnoexcept

◆ hash()

size_t s3d::Color::hash ( ) const
noexcept

◆ lerp()

constexpr Color s3d::Color::lerp ( Color  other,
double  f 
) const
constexprnoexcept

◆ maxComponent()

constexpr uint8 s3d::Color::maxComponent ( ) const
constexprnoexcept

◆ maxRGBComponent()

constexpr uint8 s3d::Color::maxRGBComponent ( ) const
constexprnoexcept

◆ minComponent()

constexpr uint8 s3d::Color::minComponent ( ) const
constexprnoexcept

◆ minRGBComponent()

constexpr uint8 s3d::Color::minRGBComponent ( ) const
constexprnoexcept

◆ operator=() [1/3]

constexpr Color& s3d::Color::operator= ( const Color )
constexprdefaultnoexcept

◆ operator=() [2/3]

constexpr Color& s3d::Color::operator= ( const ColorF color)
constexprnoexcept

◆ operator=() [3/3]

Color& s3d::Color::operator= ( const HSV hsva)
noexcept

◆ operator~()

constexpr Color s3d::Color::operator~ ( ) const
constexprnoexcept

◆ removeSRGBCurve()

ColorF s3d::Color::removeSRGBCurve ( ) const
noexcept

◆ set() [1/3]

constexpr Color& s3d::Color::set ( Color  color)
constexprnoexcept

◆ set() [2/3]

constexpr Color& s3d::Color::set ( uint32  _r,
uint32  _g,
uint32  _b,
uint32  _a = 255 
)
constexprnoexcept

◆ set() [3/3]

constexpr Color& s3d::Color::set ( uint32  rgb,
uint32  _a = 255 
)
constexprnoexcept

◆ setA()

constexpr Color& s3d::Color::setA ( uint32  _a)
constexprnoexcept

◆ setB()

constexpr Color& s3d::Color::setB ( uint32  _b)
constexprnoexcept

◆ setG()

constexpr Color& s3d::Color::setG ( uint32  _g)
constexprnoexcept

◆ setR()

constexpr Color& s3d::Color::setR ( uint32  _r)
constexprnoexcept

◆ setRGB() [1/2]

constexpr Color& s3d::Color::setRGB ( uint32  _r,
uint32  _g,
uint32  _b 
)
constexprnoexcept

◆ setRGB() [2/2]

constexpr Color& s3d::Color::setRGB ( uint32  rgb)
constexprnoexcept

◆ toHex()

String s3d::Color::toHex ( ) const

◆ ToUint8() [1/2]

static constexpr uint8 s3d::Color::ToUint8 ( double  x)
staticconstexprnoexcept

◆ ToUint8() [2/2]

static constexpr uint8 s3d::Color::ToUint8 ( float  x)
staticconstexprnoexcept

◆ withAlpha()

constexpr Color s3d::Color::withAlpha ( uint32  _a) const
constexprnoexcept

◆ Zero()

static constexpr Color s3d::Color::Zero ( )
staticconstexprnoexcept

Friends And Related Function Documentation

◆ Formatter

void Formatter ( FormatData formatData,
const Color value 
)
friend

◆ operator!=

constexpr friend bool operator!= ( Color  lhs,
Color  rhs 
)
friend

◆ operator<<

template<class CharType >
std::basic_ostream<CharType>& operator<< ( std::basic_ostream< CharType > &  output,
const Color value 
)
friend

◆ operator==

constexpr friend bool operator== ( Color  lhs,
Color  rhs 
)
friend

2 つの色が等しいかを返します。

Parameters
lhs比較する色
rhs比較する色
Returns
2 つの色が等しい場合 true, それ以外の場合は false

◆ operator>>

template<class CharType >
std::basic_istream<CharType>& operator>> ( std::basic_istream< CharType > &  input,
Color value 
)
friend

Member Data Documentation

◆ a

value_type s3d::Color::a

アルファ | Alpha

◆ b

value_type s3d::Color::b

青 | Blue

◆ g

value_type s3d::Color::g

緑 | Green

◆ r

value_type s3d::Color::r

赤 | Red


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