Skip to main content

ColorRamp

Struct ColorRamp 

Source
pub struct ColorRamp {
    pub stops: Vec<ColorStop>,
}
Expand description

An interpolated colour transfer function defined by ordered stops.

Evaluates a scalar t to a linear RGBA colour by linearly interpolating between the two nearest stops. Values outside the stop range are clamped to the first / last stop colour.

Fields§

§stops: Vec<ColorStop>

Ordered colour stops. Must contain at least one entry.

Implementations§

Source§

impl ColorRamp

Source

pub fn new(stops: Vec<ColorStop>) -> Self

Create a new ramp from the given stops.

Stops are sorted by value on construction.

§Panics

Panics if stops is empty.

Source

pub fn evaluate(&self, t: f32) -> [f32; 4]

Evaluate the ramp at t, returning a linearly interpolated RGBA colour. Clamps to the boundary stops outside the range.

Source

pub fn as_texture_data(&self, width: u32) -> Vec<u8>

Generate a 1D RGBA8 lookup-table texture of width texels.

Useful for GPU-side colour ramp evaluation via texture sampling.

Source

pub fn len(&self) -> usize

Number of stops.

Source

pub fn is_empty(&self) -> bool

Whether the ramp has no stops (never true after construction).

Trait Implementations§

Source§

impl Clone for ColorRamp

Source§

fn clone(&self) -> ColorRamp

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColorRamp

Source§

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

Formats the value using the given formatter. Read more

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.