Struct Palette 

pub struct Palette { /* private fields */ }

An array of 256 Channels.

Implementations

impl Palette

constructors & desconstructors

pub fn new(terminal: &Notcurses) -> Palette

Creates a new palette, that’s initialized with our best knowledge of the currently configured palette.

pub fn into_ref(&self) -> &NcPalette

Returns a shared reference to the inner NcPalette.

pub fn into_ref_mut(&mut self) -> &mut NcPalette

Returns an exclusive reference to the inner NcPalette.

impl Palette

methods

pub fn use_in(&self, terminal: &Notcurses) -> Result<()>

Attempts to use this palette in the terminal.

pub fn get(&self, index: impl Into<u8>) -> Rgb

Returns the Rgb value at index.

pub fn set(&mut self, index: impl Into<u8>, rgb: impl Into<Rgb>)

Sets the Rgb value at index.

pub fn get_channel(&self, index: impl Into<u8>) -> Channel

Returns the channel at index.

pub fn set_channel(&mut self, index: impl Into<u8>, channel: impl Into<Channel>)

Sets the channel value at index.

Trait Implementations

impl Clone for Palette

fn clone(&self) -> Palette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Palette

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

Formats the value using the given formatter.

impl Drop for Palette

fn drop(&mut self)

Executes the destructor for this type.

impl From<&mut ncpalette> for Palette

fn from(ncplane: &mut NcPalette) -> Palette

Converts to this type from the input type.

impl PartialEq for Palette

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

impl StructuralPartialEq for Palette