OpenSiv3D  v0.6.5
C++20 framework for creative coding
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
s3d::ColorF Struct Reference

RGBA カラーを、それぞれの要素について 0.0～1.0 の範囲で表現するクラスです。 More...

#include <ColorF.hpp>

Public Member Functions

SIV3D_NODISCARD_CXX20 ColorF ()=default
 
SIV3D_NODISCARD_CXX20 ColorF (const ColorF &)=default
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (double _r, double _g, double _b, double _a=1.0) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (double rgb, double _a=1.0) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (const ColorF &rgb, double _a) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (const Vec3 &rgb, double _a=1.0) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (const Vec4 &rgba) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (Color color) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (Color rgb, double _a) noexcept
 
SIV3D_NODISCARD_CXX20 ColorF (const HSV &hsva) noexcept
 
SIV3D_NODISCARD_CXX20 ColorF (const HSV &hsv, double _a) noexcept
 
constexpr SIV3D_NODISCARD_CXX20 ColorF (StringView code) noexcept
 
constexpr double elem (size_t index) const noexcept
 
double * getPointer () noexcept
 
const double * getPointer () const noexcept
 
constexpr ColorF & operator= (const ColorF &) noexcept=default
 
constexpr ColorF & operator= (Color color) noexcept
 
ColorF & operator= (const HSV &hsva) noexcept
 
constexpr ColorF operator+ (const ColorF &rgb) const noexcept
 
constexpr ColorF & operator+= (const ColorF &rgb) noexcept
 
constexpr ColorF operator- (const ColorF &rgb) const noexcept
 
constexpr ColorF & operator-= (const ColorF &rgb) noexcept
 
constexpr ColorF operator* (const double s) const noexcept
 
constexpr ColorF & operator*= (const double s) noexcept
 
constexpr ColorF operator* (const ColorF &rgba) const noexcept
 
constexpr ColorF & operator*= (const ColorF &rgba) noexcept
 
constexpr ColorF & setR (double _r) noexcept
 
constexpr ColorF & setG (double _g) noexcept
 
constexpr ColorF & setB (double _b) noexcept
 
constexpr ColorF & setA (double _a) noexcept
 
constexpr ColorF & setRGB (double rgb) noexcept
 
constexpr ColorF & setRGB (double _r, double _g, double _b) noexcept
 
constexpr ColorF & set (double rgb, double _a=1.0) noexcept
 
constexpr ColorF & set (double _r, double _g, double _b, double _a=1.0) noexcept
 
constexpr ColorF & set (const ColorF &ColorF) noexcept
 
constexpr ColorF withAlpha (double _a) const noexcept
 
constexpr double grayscale () const noexcept
 
constexpr double minRGBComponent () const noexcept
 
constexpr double maxRGBComponent () const noexcept
 
constexpr double minComponent () const noexcept
 
constexpr double maxComponent () const noexcept
 
constexpr ColorF lerp (const ColorF &other, double f) const noexcept
 
ColorF gamma (double gamma) const noexcept
 
ColorF removeSRGBCurve () const noexcept
 
ColorF applySRGBCurve () const noexcept
 
size_t hash () const noexcept
 
constexpr Color toColor () const noexcept
 
constexpr Float4 toFloat4 () const noexcept
 
constexpr Vec4 toVec4 () const noexcept
 
constexpr Vec2 rg () const noexcept
 
constexpr Vec2 gb () const noexcept
 
constexpr Vec2 ba () const noexcept
 
constexpr Vec3 rgb () const noexcept
 
constexpr Vec3 gba () const noexcept
 
constexpr Vec3 bgr () const noexcept
 
constexpr Vec4 rgba () const noexcept
 
constexpr Vec4 rgb0 () const noexcept
 
constexpr Vec4 rgb1 () const noexcept
 
constexpr Vec4 argb () const noexcept
 
constexpr Vec4 abgr () const noexcept
 

Static Public Member Functions

static constexpr ColorF Zero () noexcept
 
static constexpr ColorF One () noexcept
 

Public Attributes

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

Friends

constexpr friend ColorF operator* (const double s, const ColorF &color) noexcept
 
constexpr friend bool operator== (const ColorF &lhs, const ColorF &rhs) noexcept
 
constexpr friend bool operator!= (const ColorF &lhs, const ColorF &rhs) noexcept
 
template<class CharType >
std::basic_ostream< CharType > & operator<< (std::basic_ostream< CharType > &output, const ColorF &value)
 
template<class CharType >
std::basic_istream< CharType > & operator>> (std::basic_istream< CharType > &input, ColorF &value)
 
void Formatter (FormatData &formatData, const ColorF &value)
 

Detailed Description

RGBA カラーを、それぞれの要素について 0.0～1.0 の範囲で表現するクラスです。

Constructor & Destructor Documentation

◆ ColorF() [1/12]

SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( )
default

◆ ColorF() [2/12]

SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const ColorF &  )
default

◆ ColorF() [3/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( double  _r,
double  _g,
double  _b,
double  _a = 1.0 
)
constexprnoexcept

◆ ColorF() [4/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( double  rgb,
double  _a = 1.0 
)
explicitconstexprnoexcept

◆ ColorF() [5/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const ColorF &  rgb,
double  _a 
)
constexprnoexcept

◆ ColorF() [6/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const Vec3 &  rgb,
double  _a = 1.0 
)
explicitconstexprnoexcept

◆ ColorF() [7/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const Vec4 &  rgba)
explicitconstexprnoexcept

◆ ColorF() [8/12]

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

◆ ColorF() [9/12]

constexpr SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( Color  rgb,
double  _a 
)
constexprnoexcept

◆ ColorF() [10/12]

SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const HSV &  hsva)
noexcept

◆ ColorF() [11/12]

SIV3D_NODISCARD_CXX20 s3d::ColorF::ColorF ( const HSV &  hsv,
double  _a 
)
noexcept

◆ ColorF() [12/12]

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

Member Function Documentation

◆ abgr()

constexpr Vec4 s3d::ColorF::abgr ( ) const
constexprnoexcept

◆ applySRGBCurve()

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

◆ argb()

constexpr Vec4 s3d::ColorF::argb ( ) const
constexprnoexcept

◆ ba()

constexpr Vec2 s3d::ColorF::ba ( ) const
constexprnoexcept

◆ bgr()

constexpr Vec3 s3d::ColorF::bgr ( ) const
constexprnoexcept

◆ elem()

constexpr double s3d::ColorF::elem ( size_t  index) const
constexprnoexcept

◆ gamma()

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

◆ gb()

constexpr Vec2 s3d::ColorF::gb ( ) const
constexprnoexcept

◆ gba()

constexpr Vec3 s3d::ColorF::gba ( ) const
constexprnoexcept

◆ getPointer() [1/2]

const double* s3d::ColorF::getPointer ( ) const
noexcept

◆ getPointer() [2/2]

double* s3d::ColorF::getPointer ( )
noexcept

◆ grayscale()

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

◆ hash()

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

◆ lerp()

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

◆ maxComponent()

constexpr double s3d::ColorF::maxComponent ( ) const
constexprnoexcept

◆ maxRGBComponent()

constexpr double s3d::ColorF::maxRGBComponent ( ) const
constexprnoexcept

◆ minComponent()

constexpr double s3d::ColorF::minComponent ( ) const
constexprnoexcept

◆ minRGBComponent()

constexpr double s3d::ColorF::minRGBComponent ( ) const
constexprnoexcept

◆ One()

static constexpr ColorF s3d::ColorF::One ( )
staticconstexprnoexcept

◆ operator*() [1/2]

constexpr ColorF s3d::ColorF::operator* ( const ColorF &  rgba) const
constexprnoexcept

◆ operator*() [2/2]

constexpr ColorF s3d::ColorF::operator* ( const double  s) const
constexprnoexcept

◆ operator*=() [1/2]

constexpr ColorF& s3d::ColorF::operator*= ( const ColorF &  rgba)
constexprnoexcept

◆ operator*=() [2/2]

constexpr ColorF& s3d::ColorF::operator*= ( const double  s)
constexprnoexcept

◆ operator+()

constexpr ColorF s3d::ColorF::operator+ ( const ColorF &  rgb) const
constexprnoexcept

◆ operator+=()

constexpr ColorF& s3d::ColorF::operator+= ( const ColorF &  rgb)
constexprnoexcept

◆ operator-()

constexpr ColorF s3d::ColorF::operator- ( const ColorF &  rgb) const
constexprnoexcept

◆ operator-=()

constexpr ColorF& s3d::ColorF::operator-= ( const ColorF &  rgb)
constexprnoexcept

◆ operator=() [1/3]

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

◆ operator=() [2/3]

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

◆ operator=() [3/3]

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

◆ removeSRGBCurve()

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

◆ rg()

constexpr Vec2 s3d::ColorF::rg ( ) const
constexprnoexcept

◆ rgb()

constexpr Vec3 s3d::ColorF::rgb ( ) const
constexprnoexcept

◆ rgb0()

constexpr Vec4 s3d::ColorF::rgb0 ( ) const
constexprnoexcept

◆ rgb1()

constexpr Vec4 s3d::ColorF::rgb1 ( ) const
constexprnoexcept

◆ rgba()

constexpr Vec4 s3d::ColorF::rgba ( ) const
constexprnoexcept

◆ set() [1/3]

constexpr ColorF& s3d::ColorF::set ( const ColorF &  ColorF)
constexprnoexcept

◆ set() [2/3]

constexpr ColorF& s3d::ColorF::set ( double  _r,
double  _g,
double  _b,
double  _a = 1.0 
)
constexprnoexcept

◆ set() [3/3]

constexpr ColorF& s3d::ColorF::set ( double  rgb,
double  _a = 1.0 
)
constexprnoexcept

◆ setA()

constexpr ColorF& s3d::ColorF::setA ( double  _a)
constexprnoexcept

◆ setB()

constexpr ColorF& s3d::ColorF::setB ( double  _b)
constexprnoexcept

◆ setG()

constexpr ColorF& s3d::ColorF::setG ( double  _g)
constexprnoexcept

◆ setR()

constexpr ColorF& s3d::ColorF::setR ( double  _r)
constexprnoexcept

◆ setRGB() [1/2]

constexpr ColorF& s3d::ColorF::setRGB ( double  _r,
double  _g,
double  _b 
)
constexprnoexcept

◆ setRGB() [2/2]

constexpr ColorF& s3d::ColorF::setRGB ( double  rgb)
constexprnoexcept

◆ toColor()

constexpr Color s3d::ColorF::toColor ( ) const
constexprnoexcept

◆ toFloat4()

constexpr Float4 s3d::ColorF::toFloat4 ( ) const
constexprnoexcept

◆ toVec4()

constexpr Vec4 s3d::ColorF::toVec4 ( ) const
constexprnoexcept

◆ withAlpha()

constexpr ColorF s3d::ColorF::withAlpha ( double  _a) const
constexprnoexcept

◆ Zero()

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

Friends And Related Function Documentation

◆ Formatter

void Formatter ( FormatData &  formatData,
const ColorF &  value 
)
friend

◆ operator!=

constexpr friend bool operator!= ( const ColorF &  lhs,
const ColorF &  rhs 
)
friend

◆ operator*

constexpr friend ColorF operator* ( const double  s,
const ColorF &  color 
)
friend

◆ operator<<

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

◆ operator==

constexpr friend bool operator== ( const ColorF &  lhs,
const ColorF &  rhs 
)
friend

◆ operator>>

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

Member Data Documentation

◆ a

double s3d::ColorF::a

アルファ | Alpha

◆ b

double s3d::ColorF::b

青 | Blue

◆ g

double s3d::ColorF::g

緑 | Green

◆ r

double s3d::ColorF::r

赤 | Red

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