Struct GradientStops 

pub struct GradientStops {
    pub stops: Vec<GradientStop>,
}

An ordered collection of GradientStops describing a color ramp.

Examples

use martensite_render::{GradientStop, GradientStops};

// Build a black-to-white ramp.
let mut stops = GradientStops::new();
assert!(stops.is_empty());
stops.push(GradientStop::new(0.0, [0, 0, 0, 255]));
stops.push(GradientStop::new(1.0, [255, 255, 255, 255]));
assert_eq!(stops.len(), 2);
assert!(!stops.is_empty());

// `from_slice` is convenient for static ramps.
let ramp = GradientStops::from_slice(&[
    GradientStop::new(0.0, [255, 0, 0, 255]),
    GradientStop::new(1.0, [0, 0, 255, 255]),
]);
assert_eq!(ramp.len(), 2);

Fields

stops: Vec<GradientStop>

The ordered stop list.

Implementations

impl GradientStops

pub fn new() -> Self

Creates an empty stop list.

Examples

use martensite_render::GradientStops;

let stops = GradientStops::new();
assert!(stops.is_empty());
assert_eq!(stops.len(), 0);

pub fn from_slice(stops: &[GradientStop]) -> Self

Creates a stop list from the given slice.

Examples

use martensite_render::{GradientStop, GradientStops};

let stops = GradientStops::from_slice(&[
    GradientStop::new(0.0, [0, 0, 0, 255]),
    GradientStop::new(1.0, [255, 255, 255, 255]),
]);
assert_eq!(stops.len(), 2);

pub fn push(&mut self, stop: GradientStop)

Appends a single stop.

Examples

use martensite_render::{GradientStop, GradientStops};

let mut stops = GradientStops::new();
stops.push(GradientStop::new(0.0, [255, 0, 0, 255]));
stops.push(GradientStop::new(1.0, [0, 0, 255, 255]));
assert_eq!(stops.len(), 2);

pub fn is_empty(&self) -> bool

Returns true when the stop list contains no entries.

Examples

use martensite_render::{GradientStop, GradientStops};

let mut stops = GradientStops::new();
assert!(stops.is_empty());
stops.push(GradientStop::new(0.0, [0, 0, 0, 255]));
assert!(!stops.is_empty());

pub fn len(&self) -> usize

Returns the number of stops.

Examples

use martensite_render::{GradientStop, GradientStops};

let stops = GradientStops::from_slice(&[
    GradientStop::new(0.0, [0, 0, 0, 255]),
    GradientStop::new(1.0, [255, 255, 255, 255]),
]);
assert_eq!(stops.len(), 2);

Trait Implementations

impl Clone for GradientStops

fn clone(&self) -> GradientStops

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GradientStops

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

Formats the value using the given formatter.

impl Default for GradientStops

fn default() -> GradientStops

Returns the “default value” for a type.