Struct ColorMapItem

#[repr(C)]
pub struct ColorMapItem { /* private fields */ }

Represents a ColorMap entry item.

HLS mode:

• x: [0, 360] hue angle
• y: [0, 100] lightness percentage
• z: [0, 100] saturation percentage

RGB mode:

• x: [0, 100] red percentage
• y: [0, 100] green percentage
• z: [0, 100] blue percentage

Implementations

impl ColorMapItem

pub const fn new() -> Self

Creates a new ColorMapItem.

pub const fn create_hls( number: usize, degree: u16, lightness: u16, saturation: u16, ) -> Self

Creates a ColorMapItem in HLS mode.

pub const fn create_rgb(number: usize, red: u8, green: u8, blue: u8) -> Self

Creates a ColorMapItem in RGB mode.

Parameters:

red: red hue value in hex [0x00, 0xff] green: green hue value in hex [0x00, 0xff] blue: blue hue value in hex [0x00, 0xff]

pub const fn is_black(&self) -> bool

Gets whether the ColorMapItem is black.

pub const fn number(&self) -> usize

Gets the ColorMapItem index number.

pub fn set_number(&mut self, val: usize)

Sets the ColorMapItem index number parameter.

pub fn with_number(self, val: usize) -> Self

Builder function that sets the ColorMapItem index number parameter.

pub const fn color_mode(&self) -> ColorMode

Gets the ColorMode.

pub fn set_color_mode(&mut self, val: ColorMode)

Sets the ColorMode.

pub fn with_color_mode(self, val: ColorMode) -> Self

Builder function that sets the ColorMode.

pub const fn x(&self) -> u16

Gets the ColorMapItem x parameter.

Meaning:

• hls: hue degree ([0, 360])
• rgb: red hue percentage ([0, 100])

pub fn set_x(&mut self, val: u16)

Sets the ColorMapItem x parameter.

Meaning:

• hls: hue degree ([0, 360])
• rgb: red hue percentage ([0, 100])

pub fn with_x(self, val: u16) -> Self

Builder function that sets the ColorMapItem x parameter.

Meaning:

• hls: hue degree ([0, 360])
• rgb: red hue percentage ([0, 100])

pub const fn y(&self) -> u16

Gets the ColorMapItem y parameter.

Meaning:

• hls: lightness percentage ([0, 100])
• rgb: green hue percentage ([0, 100])

pub fn set_y(&mut self, val: u16)

Sets the ColorMapItem y parameter.

Meaning:

• hls: lightness percentage ([0, 100])
• rgb: green hue percentage ([0, 100])

pub fn with_y(self, val: u16) -> Self

Builder function that sets the ColorMapItem y parameter.

Meaning:

• hls: lightness percentage ([0, 100])
• rgb: green hue percentage ([0, 100])

pub const fn z(&self) -> u16

Gets the ColorMapItem z parameter.

Meaning:

• hls: saturation percentage ([0, 100])
• rgb: blue hue percentage ([0, 100])

pub fn set_z(&mut self, val: u16)

Sets the ColorMapItem z parameter.

Meaning:

• hls: saturation percentage ([0, 100])
• rgb: blue hue percentage ([0, 100])

pub fn with_z(self, val: u16) -> Self

Builder function that sets the ColorMapItem z parameter.

Meaning:

• hls: saturation percentage ([0, 100])
• rgb: blue hue percentage ([0, 100])

Trait Implementations

impl Clone for ColorMapItem

fn clone(&self) -> ColorMapItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorMapItem

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

Formats the value using the given formatter.

impl Default for ColorMapItem

fn default() -> ColorMapItem

Returns the “default value” for a type.

impl PartialEq for ColorMapItem

fn eq(&self, other: &ColorMapItem) -> 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 ColorMapItem

impl StructuralPartialEq for ColorMapItem