Unigine.Palette Class

This structure represents a set of values for 12 major colors of the color spectre used to define saturation and hue adjustment.

The following code snippet shows a usage example:

Source code (C#)

Palette p = new Palette(0.5f);
Render.ColorCorrectionHueShift = p;

Methods:

Name	Description View: Sort by:
Palette	Constructor.
operator =	Performs structure assignment.
Equals	Check if two palettes are the same.
NotEquals	Check if two palettes are not the same.
Clear	Sets all color values to the given value.
Copy	Copies all values from the given palette.
SetColor	Sets the given color to the given value.
GetColor	Returns the color value.

Variables:

Name	Description
RED = 0	Red color.
ORANGE = 1	Orange color.
YELLOW = 2	Yellow color.
CHARTREUSE = 3	Chartreuse color.
GREEN = 4	Green color.
SPRINGGREEN = 5	Spring Green color.
CYAN = 6	Cyan color.
AZURE = 7	Azure color.
BLUE = 8	Blue color.
VIOLET = 9	Violet color.
MAGENTA = 10	Magenta color.
ROSE = 11	Rose color.
SIZE = 12	The number of colors.

Palette Class

Enums

Color#

Name	Description
RED = 0	Red color.
ORANGE = 1	Orange color.
YELLOW = 2	Yellow color.
CHARTREUSE = 3	Chartreuse color.
GREEN = 4	Green color.
SPRINGGREEN = 5	Spring Green color.
CYAN = 6	Cyan color.
AZURE = 7	Azure color.
BLUE = 8	Blue color.
VIOLET = 9	Violet color.
MAGENTA = 10	Magenta color.
ROSE = 11	Rose color.
SIZE = 12	The number of colors.

Members

Palette ( ) #

Constructor. Initializes the structure with zero values.

Palette ( Palette palette ) #

Constructor. Initializes the structure using the given Palette.

Arguments

Palette palette - Source Palette.

Palette ( float value ) #

Constructor. Initializes the structure using the given float for all values.

Arguments

float value - value to be set for all color values.

Palette operator= ( Palette palette ) #

Performs structure assignment. Destination palette = source palette.

Arguments

Palette palette - Source palette.

Return value

Result.

bool Equals ( Palette palette ) #

Check if two palettes are the same.

Arguments

Palette palette - The second palette.

Return value

Returns true if the palettes are the same; otherwise, false.

bool Equals ( float value ) #

Check if all values of the palette are equal to the given value.

Arguments

float value - The value to check.

Return value

Returns true if all values of the palette are equal to the given value; otherwise, false.

bool NotEquals ( Palette palette ) #

Check if two palettes are not the same.

Arguments

Palette palette - The second palette.

Return value

Returns true if the palettes are not the same; otherwise, false.

bool NotEquals ( float value ) #

Check if all values of the palette are not equal to the given value.

Arguments

float value - The value to check.

Return value

Returns true if any value of the palette is not equal to the given value; otherwise, false.

void Clear ( float value = 0.0f ) #

Sets all color values to the given value.

Arguments

float value - The new value.

void Copy ( Palette src ) #

Copies all values from the given palette.

Arguments

Palette src - The source palette.

void SetColor ( Palette.Color color, float value ) #

Sets the given color to the given value.

Arguments

Palette.Color color - One of Palette.Color values.
float value - The color value.

void GetColor ( Palette.Color src ) #

Returns the color value.

Arguments

Palette.Color src - One of Palette.Color values.

Last update: 2020-11-24

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)