Struct GradientKey

#[repr(C)]
pub struct GradientKey {
    pub color: Color128,
    pub position: f32,
}

A color/position pair for Gradient values! https://stereokit.net/Pages/StereoKit/GradientKey.html

see Gradient

Examples

use stereokit_rust::util::{GradientKey, Color128, named_colors};

let key0 = GradientKey::new(named_colors::GOLD, 0.75);
let key1 = GradientKey::new(   Color128::new(1.0, 0.84313726, 0.0, 1.0), 0.75);
let key2 = GradientKey{ color: Color128::new(1.0, 0.84313726, 0.0, 1.0), position: 0.75 };

assert_eq!(key0, key1);
assert_eq!(key1, key2);

Fields

color: Color128

The color for this item, preferably in some form of linear color space. Gamma corrected colors will definitely not math correctly.

position: f32

Typically a value between 0-1! This is the position of the color along the ‘x-axis’ of the gradient.

Implementations

impl GradientKey

pub fn new(color_linear: impl Into<Color128>, position: f32) -> Self

A basic copy constructor for GradientKey. https://stereokit.net/Pages/StereoKit/GradientKey/GradientKey.html

• color_linear - The color for this item, preferably in some form of linear color space. Gamma corrected colors will definitely not math correctly.
• position - Typically a value between 0-1! This is the position of the color along the ‘x-axis’ of the gradient.

Trait Implementations

impl Clone for GradientKey

fn clone(&self) -> GradientKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GradientKey

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

Formats the value using the given formatter.

impl PartialEq for GradientKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GradientKey

impl StructuralPartialEq for GradientKey