NcBlitter

Enum NcBlitter 

Source
#[non_exhaustive]
#[repr(u32)]
pub enum NcBlitter { Default = 0, Ascii = 1, Half = 2, Quadrant = 3, Sextant = 4, Braille = 5, Pixel = 6, _4x1 = 7, _8x1 = 8, }
Expand description

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:

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)§

This enum is marked as 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 = 0

§

Ascii = 1

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

§

Half = 2

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

§

Quadrant = 3

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

§

Sextant = 4

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

§

Braille = 5

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

§

Pixel = 6

Blitter mode using Pixels/Sixels.

§

_4x1 = 7

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

§

_8x1 = 8

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

Implementations§

Source§

impl NcBlitter

Source

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

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

Default & Pixel returns None.

Source

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

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

Default & Pixel returns None.

Source

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

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

Default & Pixel returns None.

Source§

impl NcBlitter

Source

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

Source

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

Like blit_rgba, but for BGRx.

C style function: ncblit_bgrx().

Source

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

Source

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

Source§

impl NcBlitter

§Aliases

Source

pub const _1x1: NcBlitter = NcBlitter::Ascii

Source

pub const _2x1: NcBlitter = NcBlitter::Half

Source

pub const _2x2: NcBlitter = NcBlitter::Quadrant

Source

pub const _3x2: NcBlitter = NcBlitter::Sextant

Trait Implementations§

Source§

impl Clone for NcBlitter

Source§

fn clone(&self) -> NcBlitter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NcBlitter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NcBlitter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for NcBlitter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<NcBlitter> for NcBlitter_u32

Source§

fn from(blitter: NcBlitter) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for NcBlitter

Source§

fn from(blitter: NcBlitter_u32) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for NcBlitter

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for NcBlitter

Source§

impl Eq for NcBlitter

Source§

impl StructuralPartialEq for NcBlitter

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.