Mountain  1.0.0
Simple C++ 2D Game Framework
Mountain::ColorHsva Struct Reference

The ColorHsva struct represents a color in HSVA color space. More...

#include <color.hpp>

Public Member Functions

constexpr ColorHsva (const float_t h, const float_t s, const float_t v, const float_t a=1.f)
 Constructs a color with each specified component. More...
 
constexpr operator Color () const
 Converts the ColorHsva to a Color.
 
constexpr operator Vector3 () const
 Converts the ColorHsva to a Vector3.
 
constexpr operator Vector4 () const
 Converts the ColorHsva to a Vector4.
 

Static Public Member Functions

static constexpr ColorHsva White ()
 Constant for white. More...
 
static constexpr ColorHsva Gray ()
 Constant for gray. More...
 
static constexpr ColorHsva Black ()
 Constant for black. More...
 
static constexpr ColorHsva Red ()
 Constant for red. More...
 
static constexpr ColorHsva Green ()
 Constant for green. More...
 
static constexpr ColorHsva Blue ()
 Constant for blue. More...
 
static constexpr ColorHsva Yellow ()
 Constant for yellow. More...
 
static constexpr ColorHsva LightBlue ()
 Constant for cyan. More...
 
static constexpr ColorHsva Magenta ()
 Constant for magenta. More...
 

Public Attributes

float_t h = 0
 Hue component.
 
float_t s = 0
 Saturation component.
 
float_t v = 0
 Value component.
 
float_t a = 1.f
 Alpha component.
 

Detailed Description

The ColorHsva struct represents a color in HSVA color space.

It uses values from 0 to 1. The default alpha value is 1.

Definition at line 670 of file color.hpp.

Constructor & Destructor Documentation

◆ ColorHsva()

constexpr Mountain::ColorHsva::ColorHsva ( const float_t  h,
const float_t  s,
const float_t  v,
const float_t  a = 1.f 
)

Constructs a color with each specified component.

Parameters
hHue component
sSaturation component
vValue component
aAlpha component

Member Function Documentation

◆ Black()

static constexpr ColorHsva Mountain::ColorHsva::Black ( )
static

Constant for black.

Returns
Color

◆ Blue()

static constexpr ColorHsva Mountain::ColorHsva::Blue ( )
static

Constant for blue.

Returns
Color

◆ Gray()

static constexpr ColorHsva Mountain::ColorHsva::Gray ( )
static

Constant for gray.

Returns
Color

◆ Green()

static constexpr ColorHsva Mountain::ColorHsva::Green ( )
static

Constant for green.

Returns
Color

◆ LightBlue()

static constexpr ColorHsva Mountain::ColorHsva::LightBlue ( )
static

Constant for cyan.

Returns
Color

◆ Magenta()

static constexpr ColorHsva Mountain::ColorHsva::Magenta ( )
static

Constant for magenta.

Returns
Color

◆ Red()

static constexpr ColorHsva Mountain::ColorHsva::Red ( )
static

Constant for red.

Returns
Color

◆ White()

static constexpr ColorHsva Mountain::ColorHsva::White ( )
static

Constant for white.

Returns
Color

◆ Yellow()

static constexpr ColorHsva Mountain::ColorHsva::Yellow ( )
static

Constant for yellow.

Returns
Color

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