Color Class Reference

#include <peak_icv/painting/peak_icv_color.hpp>

Public Member Functions
constexpr	Color ()=default
	Constructs a default Color initialized to black.
constexpr	Color (uint64_t colorCodeRaw)
	Constructs a Color from a raw 64-bit color code containing RGB values.
constexpr	Color (uint16_t red, uint16_t green, uint16_t blue)
	Constructs a Color from separate red, green, and blue values.
constexpr	Color (uint8_t red, uint8_t green, uint8_t blue, uint8_t numBitsPerPixels)
	Constructs a Color from separate red, green, and blue values.
constexpr	Color (ColorConstant colorCode)
	Constructs a Color from a predefined ColorConstant.
constexpr uint16_t	GetRed () const
constexpr uint16_t	GetGreen () const
constexpr uint16_t	GetBlue () const
constexpr std::tuple< red_t, green_t, blue_t >	GetRGB () const
constexpr uint64_t	GetRaw () const
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

Holds a color code composed of red, green, and blue components.

Since

ids_peak_icv 1.1

Constructor & Destructor Documentation

Color() [1/5]

Color ( )

constexprdefault

Constructs a default Color initialized to black.

Since

ids_peak_icv 1.1

Color() [2/5]

Color ( uint64_t colorCodeRaw )

inlineexplicitconstexpr

Constructs a Color from a raw 64-bit color code containing RGB values.

The raw code uses the following layout:

• red in bits 32 to 47,
• green in bits 16 to 31,
• blue in bits 0 to 15.

Parameters

colorCodeRaw

Raw color code encoding red, green, and blue components.

Since

ids_peak_icv 1.1

Color() [3/5]

Color ( uint16_t red, uint16_t green, uint16_t blue )

inlineconstexpr

Constructs a Color from separate red, green, and blue values.

Parameters

red	Red component value.
green	Green component value.
blue	Blue component value.

Since

ids_peak_icv 1.1

Color() [4/5]

Color ( uint8_t red, uint8_t green, uint8_t blue, uint8_t numBitsPerPixels )

inlineconstexpr

Constructs a Color from separate red, green, and blue values.

Parameters

red	Red component value.
green	Green component value.
blue	Blue component value.
numBitsPerPixels	Number of bits per pixel.

Since

ids_peak_icv 1.1

Color() [5/5]

Color ( ColorConstant colorCode )

inlineexplicitconstexpr

Constructs a Color from a predefined ColorConstant.

Parameters

colorCode

Predefined color constant.

Since

ids_peak_icv 1.1

Member Function Documentation

GetBlue()

uint16_t GetBlue ( ) const

inlineconstexpr

Returns

The blue component value of the color.

Since

ids_peak_icv 1.1

GetGreen()

uint16_t GetGreen ( ) const

inlineconstexpr

Returns

The green component value of the color.

Since

ids_peak_icv 1.1

GetRaw()

uint64_t GetRaw ( ) const

inlineconstexpr

Returns

The raw 64-bit color code representing the color.

Since

ids_peak_icv 1.1

GetRed()

uint16_t GetRed ( ) const

inlineconstexpr

Returns

The red component value of the color.

Since

ids_peak_icv 1.1

GetRGB()

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

inlineconstexpr

Returns

A tuple containing the red, green, and blue components.

Since

ids_peak_icv 1.1

operator!=() [1/2]

bool operator!= ( const Color & rhs ) const

inlineconstexpr

Since

ids_peak_icv 1.1

operator!=() [2/2]

bool operator!= ( const ColorConstant & rhs ) const

inlineconstexpr

Since

ids_peak_icv 1.1

operator==() [1/2]

bool operator== ( const Color & rhs ) const

inlineconstexpr

Since

ids_peak_icv 1.1

operator==() [2/2]

bool operator== ( const ColorConstant & rhs ) const

inlineconstexpr

Since

ids_peak_icv 1.1