Struct libnotcurses_sys::c_api::ncpalette

#[repr(C)]
pub struct ncpalette {
    pub chans: [u32; 256],
}

Palette API. Some terminals only support 256 colors, but allow the full palette to be specified with arbitrary RGB colors. In all cases, it’s more performant to use indexed colors, since it’s much less data to write to the terminal. If you can limit yourself to 256 colors, that’s probably best.

Fields

chans: [u32; 256]

RGB values as regular ol’ channels

Implementations

impl ncpalette

pub fn new<'a>(nc: &mut Nc) -> &'a mut Self

Returns a new NcPalette.

C style function: ncpalette_new().

pub fn free(&mut self)

Frees this NcPalette.

C style function: ncpalette_free().

pub fn use(&self, nc: &mut Nc) -> NcResult<()>

Attempts to configure the terminal with this NcPalette.

C style function: ncpalette_use().

pub fn get(&self, index: impl Into<NcPaletteIndex>) -> NcRgb

Returns the NcRgb value from an NcChannel entry inside this NcPalette.

C style function: ncpalette_get().

pub fn get_rgb(&self, index: impl Into<NcPaletteIndex>) -> NcRgb

Returns the individual RGB color components from an NcChannel entry inside this NcPalette.

C style function: ncpalette_get_rgb8().

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

Sets the NcRgb value of the NcChannel entry inside this NcPalette.

C style function: ncpalette_set().

pub fn set_rgb(
    palette: &mut NcPalette,
    index: impl Into<NcPaletteIndex>,
    rgb: impl Into<NcRgb>
)

Sets the individual RGB components of an NcChannel entry inside an NcPalette.

C style function: ncpalette_set_rgb8().

impl ncpalette

pub const SIZE: u32

The supported palette-indexed colors number is up to 8 bits.

Trait Implementations

impl Clone for ncpalette

fn clone(&self) -> ncpalette

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ncpalette

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

Formats the value using the given formatter.

impl Default for ncpalette

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ncpalette

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ncpalette

fn cmp(&self, other: &ncpalette) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ncpalette> for ncpalette

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ncpalette> for ncpalette

fn partial_cmp(&self, other: &ncpalette) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ncpalette

impl Eq for ncpalette

impl StructuralEq for ncpalette

impl StructuralPartialEq for ncpalette