NDEVR
API Documentation
RandomColorOptions

Options for configuring random color generation with custom hue and brightness constraints. More...

Public Types

enum  HueStyle {
  e_unset , e_monochrome , e_red , e_orange ,
  e_yellow , e_green , e_blue , e_purple ,
  e_pink
}
 Constrains the hue family for generated colors. More...
enum  LuminosityStyle { e_random , e_bright , e_light , e_dark }
 Controls the brightness level of generated colors. More...

Public Member Functions

 RandomColorOptions ()
 Constructs default random color options.
 RandomColorOptions (HueStyle hue, LuminosityStyle style)
 Constructs random color options with the given hue and luminosity style.

Public Attributes

int hue
 Numeric hue value override, or Constant<int>::Invalid if unset.
HueStyle hue_name
 The named hue family constraint.
LuminosityStyle luminosity
 The desired luminosity style.
size_t seed
 Seed for the random number generator.

Detailed Description

Options for configuring random color generation with custom hue and brightness constraints.


Definition at line 13 of file RandomColorGenerator.h.

Member Enumeration Documentation

◆ HueStyle

Constrains the hue family for generated colors.

Enumerator
e_unset 

No hue constraint; any hue may be chosen.

e_monochrome 

Grayscale with no chromatic hue.

e_red 

Red hue family.

e_orange 

Orange hue family.

e_yellow 

Yellow hue family.

e_green 

Green hue family.

e_blue 

Blue hue family.

e_purple 

Purple hue family.

e_pink 

Pink hue family.

Definition at line 24 of file RandomColorGenerator.h.

◆ LuminosityStyle

Controls the brightness level of generated colors.

Enumerator
e_random 

Randomly selected brightness.

e_bright 

Bright, vivid colors.

e_light 

Light, pastel-like colors.

e_dark 

Dark, muted colors.

Definition at line 16 of file RandomColorGenerator.h.

Constructor & Destructor Documentation

◆ RandomColorOptions()

RandomColorOptions::RandomColorOptions ( HueStyle hue,
LuminosityStyle style )

Constructs random color options with the given hue and luminosity style.

Parameters
[in]hueThe hue family to constrain generated colors to.
[in]styleThe luminosity style for generated colors.

References hue.


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