Struct libnotcurses_sys::NcPixel

pub struct NcPixel(pub NcPixel_u32);

An ABGR pixel.

Diagram

AAAAAAAA BBBBBBBB GGGGGGGG RRRRRRRR

NcPixel has 8 bits of alpha, more or less linear, contributing directly to the usual alpha blending equation.

We map the 8 bits of alpha to 2 bits of alpha via a level function

The NcPixel API facilitates direct management of the pixels within an NcVisual (NcVisuals keep a backing store of 32-bit RGBA pixels, and render them down to terminal graphics in NcVisual.render).

Per libav, we “store as BGRA on little-endian, and ARGB on big-endian”. This is an RGBA byte-order scheme. libav emits bytes, not words. Those bytes are R-G-B-A. When read as words, on little endian this will be ABGR, and on big-endian this will be RGBA. force everything to LE ABGR, a no-op on (and thus favoring) little-endian, which is the dominant ordering for processor architectures (x86, most ARM implementations, base RISC-V implementations) and their associated memory.

Tuple Fields

0: NcPixel_u32

Implementations

impl NcPixel

pub fn new(value: NcPixel_u32) -> Self

Returns a new NcPixel.

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

Constructs a libav-compatible ABGR pixel from RGB components.

pub fn from_rgba(rgba: impl Into<NcRgba>) -> Self

Constructs a libav-compatible ABGR pixel from RGBA components.

pub fn to_rgb(&self) -> NcRgb

Converts to an RGB pixel.

pub fn to_rgba(&self) -> NcRgba

Converts to an RGBA pixel.

pub fn a(self) -> u8

Extracts the 8-bit alpha component from an ABGR pixel.

pub fn b(self) -> u8

Extracts the 8 bit blue component from an ABGR pixel.

pub fn g(self) -> u8

Extracts the 8 bit green component from an ABGR pixel.

pub fn r(self) -> u8

Extracts the 8 bit red component from an ABGR pixel.

pub fn set_a(&mut self, alpha: u8)

Sets the 8-bit alpha component of an ABGR pixel.

pub fn set_g(&mut self, green: u8)

Sets the 8-bit green component of an ABGR pixel.

pub fn set_b(&mut self, blue: u8)

Sets the 8-bit blue component of an ABGR pixel.

pub fn set_r(&mut self, red: u8)

Sets the 8-bit red component of an ABGR pixel.

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

Sets the RGB components of an ABGR pixel.

Trait Implementations

impl Binary for NcPixel

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

Formats the value using the given formatter.

impl Clone for NcPixel

fn clone(&self) -> NcPixel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcPixel

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

Formats the value using the given formatter.

impl Default for NcPixel

fn default() -> NcPixel

Returns the “default value” for a type.

impl Display for NcPixel

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

Formats the value using the given formatter.

impl<'a> From<&'a NcPixel> for &'a NcPixel_u32

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

Converts to this type from the input type.

impl From<&NcPixel> for *const NcPixel_u32

fn from(s: &NcPixel) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut NcPixel> for &'a mut NcPixel_u32

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

Converts to this type from the input type.

impl From<&mut NcPixel> for *mut NcPixel_u32

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<NcPixel> for NcRgb

fn from(bgra: NcPixel) -> Self

Converts to this type from the input type.

impl From<NcPixel> for NcRgba

fn from(bgra: NcPixel) -> Self

Converts to this type from the input type.

impl From<NcPixel> for NcPixel_u32

fn from(s: NcPixel) -> Self

Converts to this type from the input type.

impl From<NcRgb> for NcPixel

fn from(rgb: NcRgb) -> Self

Converts to this type from the input type.

impl From<NcRgba> for NcPixel

fn from(rgba: NcRgba) -> Self

Converts to this type from the input type.

impl From<u32> for NcPixel

fn from(p: NcPixel_u32) -> Self

Converts to this type from the input type.

impl LowerHex for NcPixel

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

Formats the value using the given formatter.

impl Octal for NcPixel

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

Formats the value using the given formatter.

impl PartialEq for NcPixel

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

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

Formats the value using the given formatter.

impl Copy for NcPixel

impl Eq for NcPixel

impl StructuralPartialEq for NcPixel