Skip to main content

ColorMap

Enum ColorMap 

Source
pub enum ColorMap {
    Viridis,
    Magma,
    Turbo,
    GrayScale,
    RdBu,
    Custom {
        stops: Vec<Color>,
    },
}
Expand description

A continuous colour ramp.

The named ramps are fieldless so a host UI can list them in a dropdown and they cross the wasm boundary as plain integers, following crate::preset::ColorCycle. Custom carries its own stops for hosts that need a ramp figgy does not ship.

Variants§

§

Viridis

Perceptually uniform blue→green→yellow. The safe default for unsigned magnitudes.

§

Magma

Perceptually uniform black→purple→orange→white.

§

Turbo

High-contrast rainbow. Reads well for fine structure, poor for judging magnitude — and unreadable in greyscale print.

§

GrayScale

Black→white. For print, and for overlaying contour lines on top.

§

RdBu

Diverging red→white→blue. For signed data around a meaningful zero; set axis.min = -axis.max or the white midpoint lands off zero and the ramp lies about the sign.

§

Custom

Host-supplied stops, sampled in order at evenly spaced positions.

Fewer than two stops cannot define a ramp: sample and lut fall back to fully transparent rather than inventing an endpoint, so a malformed custom map draws nothing instead of drawing a lie.

Fields

§stops: Vec<Color>

Implementations§

Source§

impl ColorMap

Source

pub fn stops(&self) -> &[Color]

The ramp’s control points, in ramp order.

Source

pub fn sample(&self, t: f32) -> Color

Colour at normalized position t.

t is clamped to [0, 1], so a caller that has not normalized its z range gets the endpoint colour rather than an out-of-range index. NaN clamps to the low end — but a NaN z should be drawn with the colourbar’s nan_color instead of being pushed through here, because “missing” and “smallest” are different facts.

Source

pub fn lut(&self) -> [Color; 256]

The ramp baked to LUT_LEN entries.

A convenience for callers that want the ramp as a table — a legend image, a texture upload of their own. figgy’s own paths do not use it: the colourbar strip and field_columnar.wgsl both evaluate Self::sample over the same stops, which is what makes their colours agree exactly instead of within a quantization step.

Trait Implementations§

Source§

impl Clone for ColorMap

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColorMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColorMap

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ColorMap

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ColorMap

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ColorMap

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ColorMap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.