Enum libnotcurses_sys::NcBlitter

#[repr(u32)]
#[non_exhaustive]
pub enum NcBlitter {
    Default,
    Ascii,
    Half,
    Quadrant,
    Sextant,
    Braille,
    Pixel,
    _4x1,
    _8x1,
}

The blitter mode to use for rasterizing an NcVisual.

We never blit full blocks, but instead spaces (more efficient) with the background set to the desired foreground.

Default

NcBlitter::Default

Degradation

There is a mechanism of graceful degradation, that works as follows:

• without braille support, Braille decays to Sextant.
• without bitmap support, Pixel decays to Sextant.
• without sextant support, Sextant decays to Quadrant.
• without quadrant support, Quadrant decays to Half.
• the only viable blitters in ASCII are Ascii and Pixel.

If you don’t want this behaviour you have to set the NcVisualFlag::NoDegrade on NcVisualOptions or call degrade(false) on NcVisualOptionsBuilder.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

Ascii

Blitter mode using only spaces, compatible with ASCII (1x1).

Half

Blitter mode using halves + Ascii (2x1). ▄▀

Quadrant

Blitter mode using quadrants + Half (2x2). ▗▐ ▖▀▟▌▙

Sextant

Blitter mode using sextants + Quadrant (3x2). 🬀🬁🬂🬃🬄🬅🬆🬇🬈🬉🬊🬋🬌🬍🬎🬏🬐🬑🬒🬓🬔🬕🬖🬗🬘🬙🬚🬛🬜🬝🬞🬟🬠🬡🬢🬣🬤🬥🬦🬧🬨🬩🬪🬫🬬🬭🬮🬯🬰🬱🬲🬳🬴🬵🬶🬷🬸🬹🬺🬻

Braille

Blitter mode using braille (4x2). ⡀⡄⡆⡇⢀⣀⣄⣆⣇⢠⣠⣤⣦⣧⢰⣰⣴⣶⣷⢸⣸⣼⣾⣿

Pixel

Blitter mode using Pixels/Sixels.

_4x1

NcBlitter mode using: four vertical levels (4x1). █▆▄▂

_8x1

NcBlitter mode using: eight vertical levels (8x1). █▇▆▅▄▃▂▁

Implementations

impl NcBlitter

pub const fn cell_height(&self) -> Option<u8>

The number of height subdivisions in a cell using the current blitter.

Default & Pixel returns None.

pub const fn cell_width(&self) -> Option<u8>

The number of width subdivisions in a cell using the current blitter.

Default & Pixel returns None.

pub const fn cell_size(&self) -> Option<(u8, u8)>

The inner Cell’s dimensions (height, width) using the current blitter.

Default & Pixel returns None.

impl NcBlitter

pub fn blit_rgba(
    data: &[u8],
    line_size: usize,
    vopts: &NcVisualOptions
) -> NcResult<usize>

Blits a flat array data of NcRgba values to the NcPlane that must be configured in vopts.

The blit begins at vopts.y and vopts.x relative to the plane.

Each source row ought occupy line_size bytes (this might be greater than vopts.lenx * 4 due to padding or partial blits).

A subregion of the input can be specified with the begy×begx and leny×lenx fields from vopts.

Returns the number of pixels blitted on success.

C style function: ncblit_rgba().

pub fn blit_bgrx(
    data: &[u8],
    line_size: usize,
    vopts: &NcVisualOptions
) -> NcResult<usize>

Like blit_rgba, but for BGRx.

C style function: ncblit_bgrx().

pub fn blit_rgb_packed(
    data: &[u8],
    line_size: usize,
    vopts: &NcVisualOptions,
    alpha: u8
) -> NcResult<usize>

Like blit_rgba, but for RGB.

line_size must be a multiple of 3 for this RGB data.

Supply an alpha value to be applied throughout.

C style function: ncblit_rgb_packed().

pub fn blit_rgb_loose(
    data: &[u8],
    line_size: usize,
    vopts: &NcVisualOptions,
    alpha: u8
) -> NcResult<usize>

Like blit_rgb_packed, but line_size must be a multiple of 4 for this RGBx data.

Supply an alpha value to be applied throughout.

C style function: ncblit_rgb_loose().

impl NcBlitter

Aliases

pub const _1x1: NcBlitter = NcBlitter::Ascii

pub const _2x1: NcBlitter = NcBlitter::Half

pub const _2x2: NcBlitter = NcBlitter::Quadrant

pub const _3x2: NcBlitter = NcBlitter::Sextant

Trait Implementations

impl Clone for NcBlitter

fn clone(&self) -> NcBlitter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcBlitter

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

Formats the value using the given formatter.

impl Default for NcBlitter

fn default() -> Self

Returns the “default value” for a type.

impl Display for NcBlitter

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

Formats the value using the given formatter.

impl From<NcBlitter> for NcBlitter_u32

fn from(blitter: NcBlitter) -> Self

Converts to this type from the input type.

impl From<u32> for NcBlitter

fn from(blitter: NcBlitter_u32) -> Self

Converts to this type from the input type.

impl PartialEq<NcBlitter> for NcBlitter

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

impl Eq for NcBlitter

impl StructuralEq for NcBlitter

impl StructuralPartialEq for NcBlitter