Struct surf_n_term::image::Image

pub struct Image { /* fields omitted */ }

Arc wrapped RGBA surface with precomputed hash

Implementations

impl Image

pub fn new(surf: impl Surface<Item = RGBA> + Send + Sync + 'static) -> Self

Create new image from the RGBA surface

pub fn size(&self) -> usize

Image size in bytes

pub fn size_cells(&self, term_size: TerminalSize) -> Size

Size in cells

pub fn quantize(
    &self,
    palette_size: usize,
    dither: bool,
    bg: Option<RGBA>
) -> Option<(ColorPalette, SurfaceOwned<usize>)>

Qunatize image

Perform palette extraction and Floyd–Steinberg dithering.

pub fn write_png(&self, w: impl Write) -> Result<(), EncodingError>

Write image as PNG

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Hash for Image

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Image

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Image> for Image

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Image> for Image

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Surface for Image

type Item = RGBA

fn shape(&self) -> Shape

Shape describes data layout inside Self::data() slice.

fn hash(&self) -> u64

fn data(&self) -> &[Self::Item]

Slice containing all the items

fn is_empty(&self) -> bool

Check if surface is empty

fn height(&self) -> usize

Height of the surface

fn width(&self) -> usize

Width of the surface

fn get(&self, row: usize, col: usize) -> Option<&Self::Item>

Get immutable reference to the elemetn specified by row and column

fn iter(&self) -> SurfaceIter<'_, Self::Item>

Iterator over immutable references to the items of the view in the row-major order

fn view<RS, CS>(&self, rows: RS, cols: CS) -> SurfaceView<'_, Self::Item> where
    RS: ViewBounds,
    CS: ViewBounds,
    Self: Sized, 

Create an immutable sub-surface restricted by rows and cols bounds.

fn as_ref(&self) -> SurfaceView<'_, Self::Item>

fn view_owned<RS, CS>(self, rows: RS, cols: CS) -> SurfaceOwnedView<Self> where
    RS: ViewBounds,
    CS: ViewBounds,
    Self: Sized, 

Create owned sub-surface restricted by rows and cols bounds.

fn transpose(self) -> SurfaceOwnedView<Self> where
    Self: Sized, 

fn map<F, T>(&self, f: F) -> SurfaceOwned<T> where
    F: FnMut(usize, usize, &Self::Item) -> T,
    Self: Sized, 

fn to_owned_surf(&self) -> SurfaceOwned<Self::Item> where
    Self::Item: Clone, 

Create owned copy of the surface

impl Eq for Image