Namespace BinaryCharm.SemanticColorPalette

Classes

SCP_Palette

Class representing a color palette suitable for usage in the system. A SCP_Palette is a named set of color definitions that can be created at runtime through code and exist only in memory, but in most cases it will be created through the Unity inspector and stored as a asset file by the Unity serialization system.

SCP_PaletteProvider

One of the core components of the system, acting as broker between palettes and colorers. Every colorer gets linked to a SCP_PaletteProvider, that handles a list of one or more SCP_Palette instances. Colorers monitor their provider for changes, and the provider themselves monitor their palettes. So, when a palette color changes, the change gets propagated to all the providers holding that palette, and then to all colorers linked to those providers.

For convenience, providers have an "active" palette that is the one that colorers use by default. Changing active palette also refreshes all the linked colorers.

Structs

SCP_ColorId

An identifier for a color defined in a SCP_Palette. Simple int wrapper (implicit conversions operators provided) with two static constants for the reserved 0 and -1 values, improving readability.

Interfaces

SCP_IPaletteCore

Interface defining the only methods that a colorer should use to apply palette colors to its target elements.

Enums

SCP_Palette.eType

Distinguishes main palettes from palette variants.