libnotcurses-sys 3.3.0

Low-level Rust bindings for the notcurses C library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! `NcPalette` methods and associated functions.

use crate::{c_api, error, Nc, NcPalette, NcPaletteIndex, NcResult, NcRgb};

impl NcPalette {
    /// Returns a new `NcPalette`.
    ///
    /// *C style function: [ncpalette_new()][c_api::ncpalette_new].*
    pub fn new<'a>(nc: &mut Nc) -> &'a mut Self {
        unsafe { &mut *c_api::ncpalette_new(nc) }
    }

    /// Frees this `NcPalette`.
    ///
    /// *C style function: [ncpalette_free()][c_api::ncpalette_free].*
    pub fn free(&mut self) {
        unsafe {
            c_api::ncpalette_free(self);
        }
    }

    /// Attempts to configure the terminal with this `NcPalette`.
    ///
    /// *C style function: [ncpalette_use()][c_api::ncpalette_use].*
    pub fn r#use(&self, nc: &mut Nc) -> NcResult<()> {
        error![unsafe { c_api::ncpalette_use(nc, self) }]
    }

    /// Returns the [`NcRgb`] value from an [`NcChannel`][crate::NcChannel]
    /// entry inside this `NcPalette`.
    ///
    /// *C style function: [ncpalette_get()][c_api::ncpalette_get].*
    pub fn get(&self, index: impl Into<NcPaletteIndex>) -> NcRgb {
        c_api::ncpalette_get(self, index.into()).into()
    }

    /// Returns the individual RGB color components from an
    /// [`NcChannel`][crate::NcChannel] entry inside this `NcPalette`.
    ///
    /// *C style function: [ncpalette_get_rgb8()][c_api::ncpalette_get_rgb8].*
    pub fn get_rgb(&self, index: impl Into<NcPaletteIndex>) -> NcRgb {
        let (mut r, mut g, mut b) = (0, 0, 0);
        c_api::ncpalette_get_rgb8(self, index.into(), &mut r, &mut g, &mut b);
        (r, g, b).into()
    }

    /// Sets the [`NcRgb`] value of the [`NcChannel`][crate::NcChannel] entry
    /// inside this NcPalette.
    ///
    /// *C style function: [ncpalette_set()][c_api::ncpalette_set].*
    pub fn set(&mut self, index: impl Into<NcPaletteIndex>, rgb: impl Into<NcRgb>) {
        c_api::ncpalette_set(self, index.into(), rgb.into().into())
    }

    /// Sets the individual RGB components of an [`NcChannel`][crate::NcChannel]
    /// entry inside an [`NcPalette`].
    ///
    /// *C style function: [ncpalette_set_rgb8()][c_api::ncpalette_set_rgb8].*
    #[inline]
    pub fn set_rgb(
        palette: &mut NcPalette,
        index: impl Into<NcPaletteIndex>,
        rgb: impl Into<NcRgb>,
    ) {
        let (r, g, b) = rgb.into().into();
        c_api::ncpalette_set_rgb8(palette, index.into(), r, g, b)
    }
}