RGBA color. More...

#include <color.h>

Public Member Functions
constexpr	color (float fRed, float fGreen, float fBlue, float fAlpha=1.f) noexcept
	color object constructor More...

constexpr	color (int nRed, int nGreen, int nBlue, int nAlpha=255) noexcept
	color object constructor More...

constexpr	color (u64 nHexValue) noexcept
	color object constructor More...

constexpr	color (const glm::ivec3 &vec3) noexcept
	color object constructor More...

constexpr	color (const glm::ivec4 &vec4) noexcept
	color object constructor More...

constexpr float	r () const noexcept
	Get red component. More...

constexpr float	g () const noexcept
	Get green component. More...

constexpr float	b () const noexcept
	Get blue component. More...

constexpr float	a () const noexcept
	Get alpha component. More...

constexpr float &	operator[] (size_t i) noexcept
	Get color component. More...

constexpr const float &	operator[] (size_t i) const noexcept
	Get color component. More...

constexpr int	r_dec () const noexcept
	Get red component as decimal. More...

constexpr int	g_dec () const noexcept
	Get green component as decimal. More...

constexpr int	b_dec () const noexcept
	Get blue component as decimal. More...

constexpr int	a_dec () const noexcept
	Get alpha component as decimal. More...

constexpr const float *	data () const noexcept
	Get pointer to the first component. More...

constexpr unsigned int	hex_rgb () const noexcept
	Get color as hex. More...

constexpr unsigned int	hex_rgba () const noexcept
	Get color as hex. More...

constexpr unsigned int	hex_argb () const noexcept
	Get color as hex. More...

constexpr void	update_r (float fDeltaValue) noexcept
	Add value to red component. More...

constexpr void	update_g (float fDeltaValue) noexcept
	Add value to green component. More...

constexpr void	update_b (float fDeltaValue) noexcept
	Add value to blue component. More...

constexpr void	update_a (float fDeltaValue) noexcept
	Add value to alpha component. More...

constexpr void	update_r_dec (int nDeltaValue) noexcept
	Add value to red component. More...

constexpr void	update_g_dec (int nDeltaValue) noexcept
	Add value to green component. More...

constexpr void	update_b_dec (int nDeltaValue) noexcept
	Add value to blue component. More...

constexpr void	update_a_dec (int nDeltaValue) noexcept
	Add value to alpha component. More...

constexpr void	set_r (float fValue) noexcept
	Set new value of red component. More...

constexpr void	set_g (float fValue) noexcept
	Set new value of green component. More...

constexpr void	set_b (float fValue) noexcept
	Set new value of blue component. More...

constexpr void	set_a (float fValue) noexcept
	Set new value of alpha component. More...

constexpr void	set_r_dec (int nValue) noexcept
	Set new value of red component. More...

constexpr void	set_g_dec (int nValue) noexcept
	Set new value of green component. More...

constexpr void	set_b_dec (int nValue) noexcept
	Set new value of blue component. More...

constexpr void	set_a_dec (int nValue) noexcept
	Set new value of alpha component. More...

constexpr void	darken (float fPercent) noexcept
	Make color darker. More...

constexpr void	brighten (float fPercent) noexcept
	Make color brighter. More...

	_QX_COLORS (_QX_COLOR_METHOD)
	Color functions.

Static Public Member Functions
constexpr static color	darken (const color &other, float fPercent) noexcept
	Make darker color. More...

constexpr static color	brighten (const color &other, float fPercent) noexcept
	Make brighter color. More...

static std::optional< color >	from_string (string_view svColorName) noexcept
	Try to create color from string. More...

static constexpr color	empty () noexcept
	Get empty color (0, 0, 0, 0) More...

static constexpr size_t	size () noexcept
	Get number of float components. More...

Detailed Description

RGBA color.

Author: Khrapov

Date: 10.04.2021

Definition at line 192 of file color.h.

Constructor & Destructor Documentation

◆ color() [1/5]

constexpr qx::color::color	(	float	fRed,
		float	fGreen,
		float	fBlue,
		float	fAlpha = `1.f`
	)

constexprnoexcept

color object constructor

out of bound values will be clamped

Parameters

fRed	- red component [0.f, 1.f]
fGreen	- green component [0.f, 1.f]
fBlue	- blue component [0.f, 1.f]
fAlpha	- alpha component [0.f, 1.f]

Definition at line 113 of file color.inl.

◆ color() [2/5]

constexpr qx::color::color	(	int	nRed,
		int	nGreen,
		int	nBlue,
		int	nAlpha = `255`
	)

constexprnoexcept

color object constructor

out of bound values will be clamped

Parameters

nRed	- red component [0, 255]
nGreen	- green component [0, 255]
nBlue	- blue component [0, 255]
nAlpha	- alpha component [0, 255]

Definition at line 118 of file color.inl.

◆ color() [3/5]

constexpr qx::color::color ( u64 nHexValue )

explicitconstexprnoexcept

color object constructor

Parameters

nHexValue - hex color value in 0xRRGGBBAA format

Definition at line 123 of file color.inl.

◆ color() [4/5]

constexpr qx::color::color ( const glm::ivec3 & vec3 )

explicitconstexprnoexcept

color object constructor

Parameters

vec3	- int vector

Definition at line 132 of file color.inl.

◆ color() [5/5]

constexpr qx::color::color ( const glm::ivec4 & vec4 )

explicitconstexprnoexcept

color object constructor

Parameters

vec4	- int vector

Definition at line 137 of file color.inl.

Member Function Documentation

◆ a()

constexpr float qx::color::a ( ) const

constexprnoexcept

Get alpha component.

Return values

-	alpha component

Definition at line 157 of file color.inl.

◆ a_dec()

constexpr int qx::color::a_dec ( ) const

constexprnoexcept

Get alpha component as decimal.

Return values

-	alpha component as decimal

Definition at line 187 of file color.inl.

◆ b()

constexpr float qx::color::b ( ) const

constexprnoexcept

Get blue component.

Return values

-	blue component

Definition at line 152 of file color.inl.

◆ b_dec()

constexpr int qx::color::b_dec ( ) const

constexprnoexcept

Get blue component as decimal.

Return values

-	blue component as decimal

Definition at line 182 of file color.inl.

◆ brighten() [1/2]

constexpr color qx::color::brighten	(	const color &	other,
		float	fPercent
	)

staticconstexprnoexcept

Make brighter color.

Parameters

other	- original color
fPercent	- brighter factor

Return values

-	brighter color

Definition at line 340 of file color.inl.

◆ brighten() [2/2]

constexpr void qx::color::brighten ( float fPercent )

constexprnoexcept

Make color brighter.

Parameters

fPercent - brighter factor

Definition at line 326 of file color.inl.

◆ darken() [1/2]

constexpr color qx::color::darken	(	const color &	other,
		float	fPercent
	)

staticconstexprnoexcept

Make darker color.

Parameters

other	- original color
fPercent	- dark factor

Return values

-	darker color

Definition at line 333 of file color.inl.

◆ darken() [2/2]

constexpr void qx::color::darken ( float fPercent )

constexprnoexcept

Make color darker.

Parameters

fPercent - dark factor

Definition at line 321 of file color.inl.

◆ data()

constexpr const float * qx::color::data ( ) const

constexprnoexcept

Get pointer to the first component.

Return values

-	pointer to the first component

Definition at line 192 of file color.inl.

◆ empty()

constexpr color qx::color::empty ( )

staticconstexprnoexcept

Get empty color (0, 0, 0, 0)

empty color can be useful for out of border values as they won't affect calc result
Return values

- empty color

Definition at line 387 of file color.inl.

◆ from_string()

std::optional< color > qx::color::from_string ( string_view svColorName )

inlinestaticnoexcept

Try to create color from string.

Parameters

svColorName - color name: css style (alice_blue, AliceBlue, aliceblue) or #F0F8FF or 0xF0F8FFFF(0xRRGGBBAA) or 0xF0F8FF(0xRRGGBB)

Return values

-	found color or nullopt

Definition at line 347 of file color.inl.

◆ g()

constexpr float qx::color::g ( ) const

constexprnoexcept

Get green component.

Return values

-	green component

Definition at line 147 of file color.inl.

◆ g_dec()

constexpr int qx::color::g_dec ( ) const

constexprnoexcept

Get green component as decimal.

Return values

-	green component as decimal

Definition at line 177 of file color.inl.

◆ hex_argb()

constexpr unsigned int qx::color::hex_argb ( ) const

constexprnoexcept

Get color as hex.

Return values

-	hex color value in 0xAARRGGBB format

Definition at line 216 of file color.inl.

◆ hex_rgb()

constexpr unsigned int qx::color::hex_rgb ( ) const

constexprnoexcept

Get color as hex.

Return values

-	hex color value in 0xRRGGBB format

Definition at line 197 of file color.inl.

◆ hex_rgba()

constexpr unsigned int qx::color::hex_rgba ( ) const

constexprnoexcept

Get color as hex.

Return values

-	hex color value in 0xRRGGBBAA format

Definition at line 206 of file color.inl.

◆ operator[]() [1/2]

constexpr const float & qx::color::operator[] ( size_t i ) const

constexprnoexcept

Get color component.

Parameters

i	- component number [0, 3]

Return values

-	component value

Definition at line 167 of file color.inl.

◆ operator[]() [2/2]

constexpr float & qx::color::operator[] ( size_t i )

constexprnoexcept

Get color component.

Parameters

i	- component number [0, 3]

Return values

-	component value

Definition at line 162 of file color.inl.

◆ r()

constexpr float qx::color::r ( ) const

constexprnoexcept

Get red component.

Return values

-	red component

Definition at line 142 of file color.inl.

◆ r_dec()

constexpr int qx::color::r_dec ( ) const

constexprnoexcept

Get red component as decimal.

Return values

-	red component as decimal

Definition at line 172 of file color.inl.

◆ set_a()

constexpr void qx::color::set_a ( float fValue )

constexprnoexcept

Set new value of alpha component.

if the new value goes out of range, it will be clamped

Parameters

fValue - new value of component

Definition at line 296 of file color.inl.

◆ set_a_dec()

constexpr void qx::color::set_a_dec ( int nValue )

constexprnoexcept

Set new value of alpha component.

if the new value goes out of range, it will be clamped

Parameters

nValue - new value of component

Definition at line 316 of file color.inl.

◆ set_b()

constexpr void qx::color::set_b ( float fValue )

constexprnoexcept

Set new value of blue component.

if the new value goes out of range, it will be clamped

Parameters

fValue - new value of component

Definition at line 291 of file color.inl.

◆ set_b_dec()

constexpr void qx::color::set_b_dec ( int nValue )

constexprnoexcept

Set new value of blue component.

if the new value goes out of range, it will be clamped

Parameters

nValue - new value of component

Definition at line 311 of file color.inl.

◆ set_g()

constexpr void qx::color::set_g ( float fValue )

constexprnoexcept

Set new value of green component.

if the new value goes out of range, it will be clamped

Parameters

fValue - new value of component

Definition at line 286 of file color.inl.

◆ set_g_dec()

constexpr void qx::color::set_g_dec ( int nValue )

constexprnoexcept

Set new value of green component.

if the new value goes out of range, it will be clamped

Parameters

nValue - new value of component

Definition at line 306 of file color.inl.

◆ set_r()

constexpr void qx::color::set_r ( float fValue )

constexprnoexcept

Set new value of red component.

if the new value goes out of range, it will be clamped

Parameters

fValue - new value of component

Definition at line 281 of file color.inl.

◆ set_r_dec()

constexpr void qx::color::set_r_dec ( int nValue )

constexprnoexcept

Set new value of red component.

if the new value goes out of range, it will be clamped

Parameters

nValue - new value of component

Definition at line 301 of file color.inl.

◆ size()

constexpr size_t qx::color::size ( )

staticconstexprnoexcept

Get number of float components.

Return values

-	number of float components

Definition at line 392 of file color.inl.

◆ update_a()

constexpr void qx::color::update_a ( float fDeltaValue )

constexprnoexcept

Add value to alpha component.

if the new value goes out of range, it will be clamped

Parameters

fDeltaValue - delta value

Definition at line 256 of file color.inl.

◆ update_a_dec()

constexpr void qx::color::update_a_dec ( int nDeltaValue )

constexprnoexcept

Add value to alpha component.

if the new value goes out of range, it will be clamped

Parameters

nDeltaValue - delta value

Definition at line 276 of file color.inl.

◆ update_b()

constexpr void qx::color::update_b ( float fDeltaValue )

constexprnoexcept

Add value to blue component.

if the new value goes out of range, it will be clamped

Parameters

fDeltaValue - delta value

Definition at line 251 of file color.inl.

◆ update_b_dec()

constexpr void qx::color::update_b_dec ( int nDeltaValue )

constexprnoexcept

Add value to blue component.

if the new value goes out of range, it will be clamped

Parameters

nDeltaValue - delta value

Definition at line 271 of file color.inl.

◆ update_g()

constexpr void qx::color::update_g ( float fDeltaValue )

constexprnoexcept

Add value to green component.

if the new value goes out of range, it will be clamped

Parameters

fDeltaValue - delta value

Definition at line 246 of file color.inl.

◆ update_g_dec()

constexpr void qx::color::update_g_dec ( int nDeltaValue )

constexprnoexcept

Add value to green component.

if the new value goes out of range, it will be clamped

Parameters

nDeltaValue - delta value

Definition at line 266 of file color.inl.

◆ update_r()

constexpr void qx::color::update_r ( float fDeltaValue )

constexprnoexcept

Add value to red component.

if the new value goes out of range, it will be clamped

Parameters

fDeltaValue - delta value

Definition at line 241 of file color.inl.

◆ update_r_dec()

constexpr void qx::color::update_r_dec ( int nDeltaValue )

constexprnoexcept

Add value to red component.

if the new value goes out of range, it will be clamped

Parameters

nDeltaValue - delta value

Definition at line 261 of file color.inl.

The documentation for this class was generated from the following files:

include/qx/render/color.h
include/qx/render/color.inl

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ color() [1/5]

◆ color() [2/5]

◆ color() [3/5]

◆ color() [4/5]

◆ color() [5/5]

Member Function Documentation

◆ a()

◆ a_dec()

◆ b()

◆ b_dec()

◆ brighten() [1/2]

◆ brighten() [2/2]

◆ darken() [1/2]

◆ darken() [2/2]

◆ data()

◆ empty()

◆ from_string()

◆ g()

◆ g_dec()

◆ hex_argb()

◆ hex_rgb()

◆ hex_rgba()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ r()

◆ r_dec()

◆ set_a()

◆ set_a_dec()

◆ set_b()

◆ set_b_dec()

◆ set_g()

◆ set_g_dec()

◆ set_r()

◆ set_r_dec()

◆ size()

◆ update_a()

◆ update_a_dec()

◆ update_b()

◆ update_b_dec()

◆ update_g()

◆ update_g_dec()

◆ update_r()

◆ update_r_dec()