xtd::drawing::color_converter Class Reference

Inheritance diagram for xtd::drawing::color_converter:

Definition

Converts colors to and from xtd::drawing::color class. This class cannot be inherited.

class drawing_export_ color_converter final static_

Inheritance

xtd::static_object → xtd::drawing::image_converter

Namespace

xtd::drawing

Library

xtd.drawing

Public Static Methods
static xtd::drawing::color	alpha_blend (const xtd::drawing::color &fore_core, const xtd::drawing::color &back_color, double alpha) noexcept
	Returns the weighted average color between the two given colors.
static xtd::drawing::color	average (const xtd::drawing::color &color1, const xtd::drawing::color &color2, double weight) noexcept
	Returns the weighted average color between the two given colors.
static xtd::drawing::color	average (const xtd::drawing::color &color1, const xtd::drawing::color &color2, double weight, bool average_alpha) noexcept
	Returns the weighted average color between the two given colors.
static xtd::drawing::color	bitonal (const drawing::color &color, int32 threshold, const drawing::color &upper_color, const drawing::color &lower_color) noexcept
	Creates a new lower or upper color of the specified color with specified threshold, upper color, and lower color.
static xtd::drawing::color	sepia (const xtd::drawing::color &color, double percent) noexcept
	Creates a new color with brightness changed of the specified color with specified percent.
static xtd::drawing::color	threshold (const xtd::drawing::color &color, int32 threshold) noexcept
	Creates a new black or white color of the specified color with specified threshold.

Member Function Documentation

alpha_blend()

static xtd::drawing::color xtd::drawing::color_converter::alpha_blend ( const xtd::drawing::color & fore_core, const xtd::drawing::color & back_color, double alpha )

staticnoexcept

Returns the weighted average color between the two given colors.

Parameters

fore_core	The foreground color.
back_color	The background color.
alpha	The alpha factor

Returns

The combined color.

Remarks

The alpha of color1 is conserved.

The red, green and blue values are averages using the following formula:

color = fore_core * (1 - weight) + back_color * weight;

Thus, a weight value of 1.0 will return the background color, while a value of 0.0 will return the foreground color.

average() [1/2]

static xtd::drawing::color xtd::drawing::color_converter::average ( const xtd::drawing::color & color1, const xtd::drawing::color & color2, double weight )

staticnoexcept

Returns the weighted average color between the two given colors.

Parameters

color1	The first color.
color2	The second color.
weight	The weighting factor

Returns

The average color.

Remarks

The alpha of color1 is conserved.

The red, green and blue values are averages using the following formula:

color = color1 * (1 - weight) + color2 * weight;

Thus, a weight value of 1.0 will return the second color, while a value of 0.0 will return the first color.

average() [2/2]

static xtd::drawing::color xtd::drawing::color_converter::average ( const xtd::drawing::color & color1, const xtd::drawing::color & color2, double weight, bool average_alpha )

staticnoexcept

Returns the weighted average color between the two given colors.

Parameters

color1	The first color.
color2	The second color.
weight	The weighting factor
average_alpha	if true alpha was compute to; otherwise the alpha result is the alpha of color1

Returns

The average color.

Remarks

The alpha, red, green and blue values are averages using the following formula:

color = color1 * (1 - weight) + color2 * weight;

Thus, a weight value of 1.0 will return the first color, while a value of 0.0 will return the second color.

bitonal()

static xtd::drawing::color xtd::drawing::color_converter::bitonal ( const drawing::color & color, int32 threshold, const drawing::color & upper_color, const drawing::color & lower_color )

staticnoexcept

Creates a new lower or upper color of the specified color with specified threshold, upper color, and lower color.

Parameters

color	The color to threshold.
threshold	The threshold value (from 0 to 765).
upper_color	The color used when RGB color is upper the threshold value.
lower_color	The color used when RGB color is under or equal the threshold value.

Returns

The new color.

sepia()

static xtd::drawing::color xtd::drawing::color_converter::sepia ( const xtd::drawing::color & color, double percent )

staticnoexcept

Creates a new color with brightness changed of the specified color with specified percent.

Parameters

color	The color to brightness.
percent	The percent factor in % (from 0.0 to 2.0).

Returns

The new color.

Remarks

0.0will make the color completely black.1.0is default and represents the original color. Values over1.0` will provide brighter results. static xtd::drawing::color brightness(const xtd::drawing::color& color, double percent) noexcept;

/ Create a new color with specified value that will be added/removed from the specified color with specified percent. /

Parameters

color	The color to update. /
value	The value to add / remove /
percent	The percent factor in % (from 0.0 to 2.0). /

Returns

The new color. static xtd::drawing::color color(const xtd::drawing::color& color, const xtd::drawing::color& value, double percent) noexcept;

/ Creates a new filtered color from specified color and replaces other color with other specified color. /

Parameters

color	The color to filter. /
threshold	The threshold value (from 0 to 765). /
extraction_color	The color to extract. /
other_color	The other color. /

Returns

The new color. static xtd::drawing::color color_extraction(const xtd::drawing::color& color, int32 threshold, const drawing::color& extraction_color, const xtd::drawing::color& other_color) noexcept;

/ Creates a new color where the specified source color is replaced by the new color. /

Parameters

color	The color to filter. /
threshold	The threshold value (from 0 to 765). /
source_color	The source color. /
new_color	The new color. /

Returns

The new color. static xtd::drawing::color color_substitution(const xtd::drawing::color& color, int32 threshold, const drawing::color& source_color, const xtd::drawing::color& new_color) noexcept;

/ Creates a new contrasting color of the specified color with specified percent factor. /

Parameters

color	The color to change contrast. /
percent	The percent factor in % (from 0.0 to 1.0). /

Returns

The new color. /

Remarks

Thus, 1.0 returns the original color, while the other values give a contrasting color. static xtd::drawing::color contrast(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new darker color of the specified color with 33% factor. /

Parameters

color

The color to dark. /

Returns

The new color. static xtd::drawing::color dark(const xtd::drawing::color& color) noexcept; / Creates a new darker color of the specified color with specified percent factor. /

Parameters

color	The color to dark. /
percent	The darker factor in % (from 0.0 to 1.0). /

Returns

The new color. /

Remarks

Thus, a percent value of 1.0 will return the xtd::drawing::color::black, while a value of 0.0 will return the color. static xtd::drawing::color dark(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new disabled color of the specified color with specified reference background color. /

Parameters

fore_color	The fore color to disabled. /
back_color	The reference background color. /

Returns

The new color. static xtd::drawing::color disabled(const xtd::drawing::color& fore_color, const xtd::drawing::color& back_color) noexcept; / Creates a new disabled color of the specified color with specified brightness. /

Parameters

fore_color	The fore color to disabled. /
brightness	The brightness of the reference backgroung color. /

Returns

The new color. static xtd::drawing::color disabled(const xtd::drawing::color& fore_color, float brightness) noexcept; / Creates a new gamma corrected color of the specified color with specified r, g, b corrections. /

Parameters

color	The color to grayscale. /
r	The red correction from 0.1 to 5. /
g	The green correction from 0.1 to 5. /
b	The blue correction from 0.1 to 5. /

Returns

The new color. static xtd::drawing::color gamma_correction(const xtd::drawing::color& color, double r, double g, double b) noexcept;

/ Creates a new gray color of the specified color. /

Parameters

color

The color to grayscale. /

Returns

The new color. static xtd::drawing::color grayscale(const xtd::drawing::color& color) noexcept; / Creates a new gray color of the specified color with specified percent factor. /

Parameters

color	The color to grayscale. /
percent	The percent factor. /

Returns

The new color. /

Remarks

Thus, 1.0 will make the color completely gray, while 0.0 return the original color. static xtd::drawing::color grayscale(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new color with rotated hue of the specified color with specified angle. /

Parameters

color	The color to rotate hue. /
angle	The angle in degrees (form 0 to 360). /

Returns

The new color. static xtd::drawing::color hue_rotate(const xtd::drawing::color& color, int angle) noexcept;

/ Creates a new inverted color of the specified color. /

Parameters

color

The color to invert. /

Returns

The new color. static xtd::drawing::color invert(const xtd::drawing::color& color) noexcept; / Creates a new inverted color of the specified color with specified percent factor. /

Parameters

color

The color to invert. /

Returns

The new color. /

Remarks

0.0 will represents the original color. 1.0 will provide inverted color. static xtd::drawing::color invert(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new lighter color of the specified color with 33% factor. /

Parameters

color

The color to light. /

Returns

The new color. static xtd::drawing::color light(const xtd::drawing::color& color) noexcept; / Creates a new lighter color of the specified color with specified percent factor. /

Parameters

color	The color to light. /
percent	The lighter factor in % (from 0.0 to 1.0). /

Returns

The new color. /

Remarks

Thus, a percent value of 1.0 will return the xtd::drawing::color::black, while a value of 0.0 will return the color. static xtd::drawing::color light(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new color with saturation changed of the specified color. /

Parameters

color	The color to saturate. /
percent	The saturatiob factor in % /

Returns

The new result. /

Remarks

Thus, 1.0 return the original color. while other will make a saturate color. static xtd::drawing::color saturate(const xtd::drawing::color& color, double percent) noexcept;

/ Creates a new sepia color of the specified color. /

Parameters

color

The color to sepia. /

Returns

The new color. static xtd::drawing::color sepia(const xtd::drawing::color& color) noexcept; / Creates a new sepia color of the specified color with specified percent factor. /

Parameters

color	The color to sepia. /
percent	The percent factor in % (from 0.0 to 1.0). /

Returns

The new color. /

Remarks

Thus, 1.0 will make the color completely sepia, while 0.0 return the original color.

threshold()

static xtd::drawing::color xtd::drawing::color_converter::threshold ( const xtd::drawing::color & color, int32 threshold )

staticnoexcept

Creates a new black or white color of the specified color with specified threshold.

Parameters

color	The color to threshold.
threshold	The threshold value (from 0 to 765).

Returns

The new color.

---

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

• xtd.drawing/include/xtd/drawing/color_converter.hpp