Struct libnotcurses_sys::NcChannel

#[repr(transparent)]
pub struct NcChannel(pub NcChannel_u32);

32 bits of context-dependent info containing NcRgb + NcAlpha + extra

It is composed of:

• a 24-bit NcRgb value
• plus 8 bits divided in:
  • 2 bits of NcAlpha
  • 6 bits of context-dependent info

The context details are documented in NcChannels

Diagram

~~AA~~~~ RRRRRRRR GGGGGGGG BBBBBBBB

type in C: channel (uint32_t)

See also

• NcRgb
• NcRgba

Tuple Fields

0: NcChannel_u32

Implementations

impl NcChannel

Constants

pub const DEFAULT_MASK: u32 = 1_073_741_824u32

If this bit is set, we are not using the default color.

Note: this is equivalent to NcChannels::BG_DEFAULT_MASK

pub const ALPHA_MASK: u32 = 805_306_368u32

Extract these bits to get the (background) NcAlpha mask.

Note: this is equivalent to NcChannels::BG_ALPHA_MASK

pub const PALETTE_MASK: u32 = 134_217_728u32

If this bit and DEFAULT_MASK are set, we’re using a palette-indexed background color

Note: this is equivalent to NcChannels::BG_PALETTE_MASK

pub const RGB_MASK: u32 = 16_777_215u32

Extract these bits to get the background NcRgb value.

Note: this is equivalent to NcChannels::BG_RGB_MASK

impl NcChannel

Constructors

pub fn new() -> Self

New NcChannel, set to black and NOT using the “default color”.

pub fn with_default() -> Self

New NcChannel, set to black and using the “default color”.

pub fn from_rgb(rgb: impl Into<NcRgb>) -> Self

New NcChannel, expects NcRgb.

pub fn from_rgb_alpha(rgb: impl Into<NcRgb>, alpha: NcAlpha) -> Self

New NcChannel, expects NcRgb & NcAlpha.

impl NcChannel

Methods

pub fn fcombine(&self, bchannel: impl Into<NcChannel>) -> NcChannels

Combines this NcChannel as foreground, with another as background into an NcChannels.

C style function: channels_combine().

pub fn bcombine(&self, fchannel: impl Into<NcChannel>) -> NcChannels

Combines this NcChannel as background, with another as foreground into an NcChannels.

C style function: channels_combine().

pub fn alpha(&self) -> NcAlpha

Gets the NcAlpha.

C style function: ncchannel_alpha().

pub fn set_alpha(&mut self, alpha: impl Into<NcAlpha>) -> Self

Sets the NcAlpha.

C style function: ncchannel_set_alpha().

pub fn rgb_p(&self) -> bool

Returns true if the channel is set to RGB color.

C style function: ncchannel_rgb_p().

pub fn rgb(&self) -> NcRgb

Gets the NcRgb.

C style function: ncchannel_rgb().

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

Sets the NcRgb, and marks the NcChannel as NOT using the “default color”, retaining the other bits unchanged.

C style function: ncchannel_set().

pub fn rgb8(&self) -> (u8, u8, u8)

Gets the three components.

C style function: ncchannel_rgb8().

pub fn set_rgb(&mut self, rgb: impl Into<NcRgb>) -> Self

Sets the three components, and marks the NcChannel as NOT using the “default color”.

C style function: ncchannel_set_rgb8().

pub fn r(&self) -> u8

Gets the red component.

C style function: ncchannel_r().

pub fn g(&self) -> u8

Gets the green component.

C style function: ncchannel_g().

pub fn b(&self) -> u8

Gets the blue component.

C style function: ncchannel_b().

pub fn set_r(&mut self, r: impl Into<u8>) -> Self

Sets the red component, and returns the new NcChannel.

C style function: ncchannel_set_r().

pub fn set_g(&mut self, g: impl Into<u8>) -> Self

Sets the green component, and returns the new NcChannel.

C style function: ncchannel_set_g().

pub fn set_b(&mut self, b: impl Into<u8>) -> Self

Sets the blue component, and returns the new NcChannel.

C style function: ncchannel_set_b().

pub fn default_p(&self) -> bool

Is this NcChannel using the “default color” rather than RGB/palette-indexed?

C style function: ncchannel_default_p().

pub fn set_default(&mut self) -> Self

Marks this NcChannel as using its “default color”, which also marks it opaque.

C style function: ncchannel_set_default().

pub fn set_not_default(&mut self) -> Self

Marks this NcChannel as not using its “default color”.

The following methods also marks the channel as NOT using the “default color”:

• new
• set
• set_rgb

C style function: ncchannel_set_not_default().

pub fn palindex(&self) -> NcPaletteIndex

Extracts the NcPaletteIndex from the NcChannel.

The channel must be palette-indexed, or the return value is meaningless. Verify palette indexing with palindex_p.

C style function: ncchannel_palindex().

pub fn palindex_p(&self) -> bool

Is this NcChannel using palette-indexed color rather a than RGB?

C style function: ncchannel_palindex_p().

pub fn set_palindex(&mut self, index: impl Into<NcPaletteIndex>) -> Self

Sets the NcPaletteIndex of the NcChannel, and the channel into palette-indexed mode.

C style function: ncchannel_set_palindex().

Trait Implementations

impl Binary for NcChannel

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

Formats the value using the given formatter.

impl Clone for NcChannel

fn clone(&self) -> NcChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcChannel

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

Formats the value using the given formatter.

impl Default for NcChannel

fn default() -> Self

Returns the “default value” for a type.

impl Display for NcChannel

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

Formats the value using the given formatter.

impl<'a> From<&'a NcChannel> for &'a NcChannel_u32

fn from(s: &'a NcChannel) -> Self

Converts to this type from the input type.

impl From<&NcChannel> for *const NcChannel_u32

fn from(s: &NcChannel) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut NcChannel> for &'a mut NcChannel_u32

fn from(s: &'a mut NcChannel) -> Self

Converts to this type from the input type.

impl From<&mut NcChannel> for *mut NcChannel_u32

fn from(s: &mut NcChannel) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut u32> for NcChannel

fn from(p: &'a mut NcChannel_u32) -> Self

Converts to this type from the input type.

impl<'a> From<&'a u32> for NcChannel

fn from(p: &'a NcChannel_u32) -> Self

Converts to this type from the input type.

impl From<[u8; 3]> for NcChannel

fn from(array: [u8; 3]) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8)> for NcChannel

fn from(tuple: (u8, u8, u8)) -> Self

Converts to this type from the input type.

impl From<NcChannel> for [u8; 3]

fn from(rgb: NcChannel) -> Self

Converts to this type from the input type.

impl From<NcChannel> for (u8, u8, u8)

fn from(rgb: NcChannel) -> Self

Converts to this type from the input type.

impl From<NcChannel> for NcChannel_u32

fn from(s: NcChannel) -> Self

Converts to this type from the input type.

impl From<u32> for NcChannel

fn from(p: NcChannel_u32) -> Self

Converts to this type from the input type.

impl LowerHex for NcChannel

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

Formats the value using the given formatter.

impl Octal for NcChannel

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

Formats the value using the given formatter.

impl PartialEq for NcChannel

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

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

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

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

impl UpperHex for NcChannel

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

Formats the value using the given formatter.

impl Copy for NcChannel

impl Eq for NcChannel

impl StructuralPartialEq for NcChannel