Struct surf_n_term::image::Image

pub struct Image { /* private fields */ }

Arc wrapped RGBA surface with precomputed hash

Implementations

impl Image

pub fn new(surf: impl Surface<Item = impl Color>) -> Self

Create new image from the RGBA surface

pub fn from_parts(data: Arc<[RGBA]>, shape: Shape) -> Self

Create new image from parts

pub fn crop<RS, CS>(&self, rows: RS, cols: CS) -> Self

where RS: ViewBounds, CS: ViewBounds,

Crop image

pub fn resize(&self, size: Size) -> Self

Resize image using bi-linear interpolation

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

Size in cells

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

Quantize image

Perform palette extraction and Floyd–Steinberg dithering.

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

Write image as PNG

pub fn ascii_view(&self) -> ImageAsciiView

ASCII image view

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<'de> Deserialize<'de> for Image

Image deserializer encoding is { data: base64(deflate(image)), size: Size, channels: u8 }

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SurfaceOwned<RGBA>> for Image

fn from(value: SurfaceOwned<RGBA>) -> Self

Converts to this type from the input type.

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, Self: Sized,

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.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Image

fn eq(&self, other: &Self) -> 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 PartialOrd for Image

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

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

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

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

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

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

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

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

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 Serialize for Image

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Surface for Image

type Item = RGBA

fn shape(&self) -> Shape

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

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 size(&self) -> Size

Size of the surface

fn hash(&self) -> u64

where Self::Item: Hash,

fn get(&self, pos: Position) -> Option<&Self::Item>

Get immutable reference to the element 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(Position, &Self::Item) -> T, Self: Sized,

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

where Self::Item: Clone,

Create owned copy of the surface

impl View for Image

fn render( &self, ctx: &ViewContext, surf: TerminalSurface<'_>, layout: ViewLayout<'_> ) -> Result<(), Error>

Render view into a given surface with the provided layout

fn layout( &self, ctx: &ViewContext, ct: BoxConstraint, layout: ViewMutLayout<'_> ) -> Result<(), Error>

Compute layout of the view based on the constraints

fn layout_new<'a>( &self, ctx: &ViewContext, ct: BoxConstraint, store: &'a mut ViewLayoutStore ) -> Result<ViewMutLayout<'a>, Error>

fn boxed<'a>(self) -> BoxView<'a>

where Self: Sized + Send + Sync + 'a,

Convert into boxed view

fn debug(&self, size: Size) -> ViewDebug<&Self>

where Self: Sized,

Wrapper around view that implements std::fmt::Debug which renders view. Only supposed to be used for debugging.

fn trace_layout<T>(self, trace: T) -> TraceLayout<Self, T>

where T: Fn(&BoxConstraint, ViewLayout<'_>), Self: Sized,

Wrapper around view that calls trace function on every layout call

fn tag<T>(self, tag: T) -> Tag<T, Self>

where T: Any + Clone, Self: Sized,

Tag the view

impl Eq for Image