Type Definition libnotcurses_sys::NcChannel

pub type NcChannel = u32;

32 bits of context-dependent info containing NcRgb + NcAlpha + extra (alias of u32).

It is:

• 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

Trait Implementations

impl NcChannelApi for NcChannel

NcChannel Methods

const DEFAULT_MASK: u32

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

Note: this is equivalent to NcChannels::BG_DEFAULT_MASK

const ALPHA_MASK: u32

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

Note: this is equivalent to NcChannels::BG_ALPHA_MASK

const PALETTE_MASK: u32

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

const RGB_MASK: u32

Extract these bits to get the background NcRgb value.

Note: this is equivalent to NcChannels::BG_RGB_MASK

fn new() -> Self

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

fn with_default() -> Self

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

fn from_rgb(rgb: NcRgb) -> Self

New NcChannel, expects NcRgb.

fn from_rgb_alpha(rgb: NcRgb, alpha: NcAlpha) -> Self

New NcChannel, expects NcRgb & NcAlpha.

fn from_rgb8(r: NcComponent, g: NcComponent, b: NcComponent) -> Self

New NcChannel, expects three RGB NcComponent components.

fn from_rgb8_alpha(
    r: NcComponent,
    g: NcComponent,
    b: NcComponent,
    alpha: NcAlpha
) -> Self

New NcChannel, expects three RGB NcComponent components & NcAlpha.

fn fcombine(&self, bchannel: NcChannel) -> NcChannels

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

C style function: channels_combine().

fn bcombine(&self, fchannel: NcChannel) -> NcChannels

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

C style function: channels_combine().

fn alpha(&self) -> NcAlpha

Gets the NcAlpha.

C style function: ncchannel_alpha().

fn set_alpha(&mut self, alpha: NcAlpha) -> Self

Sets the NcAlpha.

C style function: ncchannel_set_alpha().

fn rgb_p(&self) -> bool

Returns true if the channel is set to RGB color.

C style function: ncchannel_rgb_p().

fn rgb(&self) -> NcRgb

Gets the NcRgb.

C style function: ncchannel_rgb().

fn set(&mut self, rgb: 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().

fn rgb8(&self) -> (NcComponent, NcComponent, NcComponent)

Gets the three NcComponents.

C style function: ncchannel_rgb8().

fn set_rgb8(&mut self, r: NcComponent, g: NcComponent, b: NcComponent) -> Self

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

C style function: ncchannel_set_rgb8().

fn r(&self) -> NcComponent

Gets the red NcComponent.

C style function: ncchannel_r().

fn g(&self) -> NcComponent

Gets the green NcComponent.

C style function: ncchannel_g().

fn b(&self) -> NcComponent

Gets the blue NcComponent.

C style function: ncchannel_b().

fn set_r(&mut self, r: NcComponent) -> Self

Sets the red NcComponent, and returns the new NcChannel.

C style function: ncchannel_set_r().

fn set_g(&mut self, g: NcComponent) -> Self

Sets the green NcComponent, and returns the new NcChannel.

C style function: ncchannel_set_g().

fn set_b(&mut self, b: NcComponent) -> Self

Sets the blue NcComponent, and returns the new NcChannel.

C style function: ncchannel_set_b().

fn default_p(&self) -> bool

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

C style function: ncchannel_default_p().

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().

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_rgb8

C style function: ncchannel_set_not_default().

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().

fn palindex_p(&self) -> bool

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

C style function: ncchannel_palindex_p().

fn set_palindex(&mut self, index: NcPaletteIndex) -> Self

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

C style function: ncchannel_set_palindex().