Struct ColorSchemeBuilder 

pub struct ColorSchemeBuilder { /* private fields */ }

A builder for creating custom color schemes with intensity-based color stops.

ColorSchemeBuilder provides a fluent API for defining color gradients where each color is associated with a specific intensity value (0.0 to 1.0). The builder handles sorting, validation, and construction of the final ColorScheme.

Builder Pattern

The builder follows a standard pattern:

1. Create with ColorSchemeBuilder::new
2. Add colors with add_color
3. Build with build

Examples

use dotmax::color::scheme_builder::ColorSchemeBuilder;
use dotmax::Color;

// Create a "sunset" gradient
let scheme = ColorSchemeBuilder::new("sunset")
    .add_color(0.0, Color::rgb(255, 100, 0))   // Orange
    .add_color(0.5, Color::rgb(255, 0, 100))   // Pink
    .add_color(1.0, Color::rgb(100, 0, 255))   // Purple
    .build()?;

// Use the scheme
let mid_color = scheme.sample(0.5);

Implementations

impl ColorSchemeBuilder

pub fn new(name: impl Into<String>) -> Self

Create a new color scheme builder with the given name.

The builder starts with no color stops. Use add_color to add color stops before calling build.

Arguments

• name - Human-readable name for the scheme (e.g., “fire”, “ocean”, “brand”)

Examples

use dotmax::color::scheme_builder::ColorSchemeBuilder;

let builder = ColorSchemeBuilder::new("my_gradient");

pub fn add_color(self, intensity: f32, color: Color) -> Self

Add a color stop at the specified intensity.

Color stops define the gradient by mapping intensity values to colors. Colors can be added in any order - they will be automatically sorted by intensity when build is called.

Arguments

• intensity - Intensity value from 0.0 (low) to 1.0 (high)
• color - The RGB color at this intensity

Returns

Returns self for method chaining.

Note

Intensity validation happens during build, not during add_color. This allows for flexible construction patterns.

Examples

use dotmax::color::scheme_builder::ColorSchemeBuilder;
use dotmax::Color;

let builder = ColorSchemeBuilder::new("gradient")
    .add_color(0.0, Color::black())
    .add_color(0.5, Color::rgb(128, 128, 128))
    .add_color(1.0, Color::white());

pub fn build(self) -> Result<ColorScheme, DotmaxError>

Build the color scheme, validating the configuration.

This method validates all color stops and constructs the final ColorScheme. Color stops are automatically sorted by intensity in ascending order.

Validation Rules

The following conditions result in errors:

• Less than 2 color stops: Returns DotmaxError::InvalidColorScheme
• Intensity out of range (< 0.0 or > 1.0): Returns DotmaxError::InvalidIntensity
• Duplicate intensity values: Returns DotmaxError::InvalidColorScheme

Returns

• Ok(ColorScheme) - A valid color scheme ready for use
• Err(DotmaxError) - If validation fails

Examples

use dotmax::color::scheme_builder::ColorSchemeBuilder;
use dotmax::Color;

// Successful build
let scheme = ColorSchemeBuilder::new("valid")
    .add_color(0.0, Color::black())
    .add_color(1.0, Color::white())
    .build()?;

// Failed build: not enough colors
let result = ColorSchemeBuilder::new("invalid")
    .add_color(0.5, Color::white())
    .build();
assert!(result.is_err());

Errors

Returns DotmaxError::InvalidColorScheme if:

• Fewer than 2 color stops are defined
• Two or more color stops have the same intensity value

Returns DotmaxError::InvalidIntensity if:

• Any intensity value is less than 0.0 or greater than 1.0

Trait Implementations

impl Clone for ColorSchemeBuilder

fn clone(&self) -> ColorSchemeBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColorSchemeBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.