Color Class Reference

#include <peak_icv/painting/peak_icv_color.hpp>

Public Member Functions
constexpr	Color ()=default
	Default Color is black.
constexpr	Color (uint64_t colorCodeRaw)
	The provided color code is one value containing rgb.
constexpr	Color (uint16_t red, uint16_t green, uint16_t blue)
	Creates a Color from red, green and blue.
constexpr	Color (ColorConstant colorCode)
	Creates a Color a color constant.
constexpr uint16_t	GetRed () const
	Returns the red value for the color, that was specified.
constexpr uint16_t	GetGreen () const
	Returns the green value for the color, that was specified.
constexpr uint16_t	GetBlue () const
	Returns the blue value for the color, that was specified.
constexpr std::tuple< red_t, green_t, blue_t >	GetRGB () const
	Returns the current colorCode as Red, Green, Blue The color as a tuple of red, green and blue values.
constexpr uint64_t	GetRaw () const
	Returns the current colorCode in its raw format.
constexpr bool	operator== (const Color &rhs) const
constexpr bool	operator!= (const Color &rhs) const
constexpr bool	operator== (const ColorConstant &rhs) const
constexpr bool	operator!= (const ColorConstant &rhs) const

Detailed Description

Color class holding the actual color codes.

Warning

This function is still in development and not released.

Definition at line 89 of file peak_icv_color.hpp.

Constructor & Destructor Documentation

Color() [1/4]

Color ( )

constexprdefault

Default Color is black.

Warning

This function is still in development and not released.

Color() [2/4]

Color ( uint64_t colorCodeRaw )

inlineexplicitconstexpr

The provided color code is one value containing rgb.

Parameters

colorCodeRaw

color code in its raw representation.

Warning

This function is still in development and not released.

Definition at line 105 of file peak_icv_color.hpp.

Color() [3/4]

Color ( uint16_t red, uint16_t green, uint16_t blue )

inlineconstexpr

Creates a Color from red, green and blue.

Parameters

red	red value
green	green value
blue	blue value

Warning

This function is still in development and not released.

Definition at line 118 of file peak_icv_color.hpp.

Color() [4/4]

Color ( ColorConstant colorCode )

inlineexplicitconstexpr

Creates a Color a color constant.

Parameters

colorCode

predefined color constant

Warning

This function is still in development and not released.

Definition at line 128 of file peak_icv_color.hpp.

Member Function Documentation

GetBlue()

uint16_t GetBlue ( ) const

inlineconstexpr

Returns the blue value for the color, that was specified.

Returns

Warning

This function is still in development and not released.

Definition at line 160 of file peak_icv_color.hpp.

GetGreen()

uint16_t GetGreen ( ) const

inlineconstexpr

Returns the green value for the color, that was specified.

Returns

Warning

This function is still in development and not released.

Definition at line 149 of file peak_icv_color.hpp.

GetRaw()

uint64_t GetRaw ( ) const

inlineconstexpr

Returns the current colorCode in its raw format.

Returns

Warning

This function is still in development and not released.

Definition at line 183 of file peak_icv_color.hpp.

GetRed()

uint16_t GetRed ( ) const

inlineconstexpr

Returns the red value for the color, that was specified.

Returns

Warning

This function is still in development and not released.

Definition at line 138 of file peak_icv_color.hpp.

GetRGB()

std::tuple< red_t, green_t, blue_t > GetRGB ( ) const

inlineconstexpr

Returns the current colorCode as Red, Green, Blue The color as a tuple of red, green and blue values.

Returns

Warning

This function is still in development and not released.

Definition at line 172 of file peak_icv_color.hpp.

operator!=() [1/2]

bool operator!= ( const Color & rhs ) const

inlineconstexpr

Warning

This function is still in development and not released.

Definition at line 203 of file peak_icv_color.hpp.

operator!=() [2/2]

bool operator!= ( const ColorConstant & rhs ) const

inlineconstexpr

Warning

This function is still in development and not released.

Definition at line 223 of file peak_icv_color.hpp.

operator==() [1/2]

bool operator== ( const Color & rhs ) const

inlineconstexpr

Warning

This function is still in development and not released.

Definition at line 193 of file peak_icv_color.hpp.

operator==() [2/2]

bool operator== ( const ColorConstant & rhs ) const

inlineconstexpr

Warning

This function is still in development and not released.

Definition at line 213 of file peak_icv_color.hpp.