Enum libnotcurses_sys::NcScale

#[non_exhaustive]
#[repr(u32)]
pub enum NcScale {
    None = 0,
    Scale = 1,
    NoneHiRes = 3,
    ScaleHiRes = 4,
    Stretch = 2,
}

Indicates how to scale an NcVisual during rendering.

Default

NcScale::None

Application

The scaling preferences are applied only for the context of NcVisual.render.

You can think of it as the following pipeline, where you still have the original frame:

NcVisual::from_file() → frame → NcVisual.render() → scaling → output_frame → blit

Whereas NcVisual.resize and NcVisual.resize_noninterpolative are changing that original frame.

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.

None = 0

Maintains the original size. Will Apply no scaling.

Scale = 1

Maintains the aspect ratio.

Scales an NcVisual to the NcPlane’s size without stretching.

NoneHiRes = 3

Like None, maintains the original size, while admitting high-resolution blitters that don’t preserve the aspect ratio.

ScaleHiRes = 4

Like Scale, maintains the aspect ratio, while admitting high-resolution blitters that don’t preserve the aspect ratio.

Stretch = 2

Throws away aspect ratio.

Stretches and scales the NcVisual in an attempt to fill the entirety of the NcPlane.

Trait Implementations

impl Clone for NcScale

fn clone(&self) -> NcScale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcScale

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

Formats the value using the given formatter.

impl Default for NcScale

fn default() -> Self

Returns the “default value” for a type.

impl Display for NcScale

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

Formats the value using the given formatter.

impl From<NcScale> for NcScale_u32

fn from(scale: NcScale) -> Self

Converts to this type from the input type.

impl From<u32> for NcScale

fn from(scale: NcScale_u32) -> Self

Converts to this type from the input type.

impl PartialEq for NcScale

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

impl Eq for NcScale

impl StructuralPartialEq for NcScale