This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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;

Palette Class

Enums

Color#

NameDescription
RED = 0Red color.
ORANGE = 1Orange color.
YELLOW = 2Yellow color.
CHARTREUSE = 3Chartreuse color.
GREEN = 4Green color.
SPRINGGREEN = 5Spring Green color.
CYAN = 6Cyan color.
AZURE = 7Azure color.
BLUE = 8Blue color.
VIOLET = 9Violet color.
MAGENTA = 10Magenta color.
ROSE = 11Rose color.
SIZE = 12The 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

void GetColor ( Palette.Color src ) #

Returns the color value.

Arguments

Last update: 2022-12-14
Build: ()