Enum DisplayMode 

pub enum DisplayMode {
    HalfColor,
    FullColor,
    FullNoColor,
    Ascii,
    WezTerm,
    WezTermNoColor,
    Kitty,
    KittyNoColor,
    Iterm2,
    Iterm2NoColor,
    SixelHalf,
    SixelFull,
}

The protocol of display

Variants

HalfColor

FullColor

FullNoColor

Ascii

WezTerm

WezTermNoColor

Kitty

KittyNoColor

Iterm2

Iterm2NoColor

SixelHalf

SixelFull

Implementations

impl DisplayMode

pub fn is_full(&self) -> bool

Check if the display mode is a full block mode

Returns true for modes that use full blocks to display pixels, which includes:

• DisplayMode::FullColor
• DisplayMode::FullNoColor
• DisplayMode::WezTerm
• DisplayMode::WezTermNoColor
• DisplayMode::Kitty
• DisplayMode::KittyNoColor
• DisplayMode::Iterm2
• DisplayMode::Iterm2NoColor
• DisplayMode::SixelFull

Returns false for modes that use half blocks or ASCII characters:

• DisplayMode::HalfColor
• DisplayMode::Ascii
• DisplayMode::SixelHalf

pub fn is_color(&self) -> bool

Check if the display mode supports color output

Returns true for modes that can display colors:

• DisplayMode::FullColor
• DisplayMode::HalfColor
• DisplayMode::WezTerm
• DisplayMode::Kitty
• DisplayMode::Iterm2
• DisplayMode::SixelHalf
• DisplayMode::SixelFull

Returns false for modes that only support grayscale/luminance output:

• DisplayMode::FullNoColor
• DisplayMode::Ascii
• DisplayMode::WezTermNoColor
• DisplayMode::KittyNoColor
• DisplayMode::Iterm2NoColor

pub fn is_luma(&self) -> bool

Check if the display mode supports only luminance/grayscale output

This is the inverse of is_color(). Returns true for modes that only display grayscale images and false for color-capable modes.

pub fn is_normal(&self) -> bool

Check if the display mode uses standard terminal capabilities

Returns true for basic terminal display modes that don’t require special terminal features:

• DisplayMode::HalfColor
• DisplayMode::FullColor
• DisplayMode::Ascii
• DisplayMode::FullNoColor

Returns false for modes that require special terminal protocols:

• WezTerm-specific modes
• Kitty-specific modes
• iTerm2-specific modes
• Sixel modes (when sixel feature is enabled)

pub fn is_wezterm(&self) -> bool

Check if the display mode is WezTerm-specific

Returns true for both color and non-color WezTerm modes:

• DisplayMode::WezTerm
• DisplayMode::WezTermNoColor

pub fn is_iterm2(&self) -> bool

Check if the display mode is iTerm2-specific

Returns true for both color and non-color iTerm2 modes:

• DisplayMode::Iterm2
• DisplayMode::Iterm2NoColor

pub fn is_sixel(&self) -> bool

Check if the display mode uses Sixel graphics protocol

Available only when the sixel feature is enabled.

Returns true for Sixel modes:

• DisplayMode::SixelHalf
• DisplayMode::SixelFull

pub fn mode(&self) -> &'static str

Get the name of the display mode as a static string slice

This method returns a human-readable name for each display mode variant, which can be useful for debugging, logging, or user interface purposes.

Returns

A static string slice representing the name of the display mode:

• “HalfColor” - For half-block color mode
• “FullColor” - For full-block color mode
• “FullNoColor” - For full-block grayscale mode
• “Ascii” - For ASCII character-based rendering
• “WezTerm” - For WezTerm terminal protocol (color)
• “WezTermNoColor” - For WezTerm terminal protocol (grayscale)
• “Kitty” - For Kitty terminal protocol (color)
• “KittyNoColor” - For Kitty terminal protocol (grayscale)
• “Iterm2” - For iTerm2 terminal protocol (color)
• “Iterm2NoColor” - For iTerm2 terminal protocol (grayscale)
• “SixelHalf” - For Sixel graphics protocol (half-block, when sixel feature is enabled)
• “SixelFull” - For Sixel graphics protocol (full-block, when sixel feature is enabled)

Examples

use image_to_console_core::DisplayMode;

assert_eq!(DisplayMode::HalfColor.mode(), "HalfColor");
assert_eq!(DisplayMode::Ascii.mode(), "Ascii");

pub fn check_image_type(&self, img_type: &ProcessedImage) -> bool

Check if the given processed image type is compatible with this display mode

This method verifies whether a ProcessedImage has been processed in a format that is suitable for display with the current DisplayMode. Different display modes require different image formats - some need color information, others work with grayscale, and some need both.

Arguments

• img_type - A reference to the ProcessedImage to check for compatibility

Returns

• true - If the image type is compatible with this display mode
• false - If the image type is not compatible with this display mode

Compatibility Rules

• FullColor mode requires images with both color and grayscale data (ProcessedImage::Both)
• SixelHalf and SixelFull modes require RGB image data (ProcessedImage::Color2)
• HalfColor, Kitty, Iterm2, and WezTerm modes require color image data (ProcessedImage::Color)
• Ascii, FullNoColor, KittyNoColor, Iterm2NoColor, and WezTermNoColor modes require grayscale data (ProcessedImage::NoColor)

Examples

use image_to_console_core::{DisplayMode, ProcessedImage};
use image::DynamicImage;

let img = DynamicImage::new_rgba8(10, 10);
let color_image = ProcessedImage::new(DisplayMode::HalfColor, &img);
let ascii_image = ProcessedImage::new(DisplayMode::Ascii, &img);

assert!(DisplayMode::HalfColor.check_image_type(&color_image));
assert!(!DisplayMode::HalfColor.check_image_type(&ascii_image));
assert!(DisplayMode::Ascii.check_image_type(&ascii_image));

pub fn expect_image_type(&self) -> &'static str

Get the expected image type name for this display mode

This method returns a human-readable string indicating what type of processed image data is required for this display mode. This can be useful for debugging, validation, or user interface purposes.

Returns

A static string slice representing the expected image type:

• “Both” - For modes requiring both color and grayscale data (FullColor)
• “Color2” - For modes requiring RGB data (SixelHalf, SixelFull)
• “Color” - For modes requiring RGBA color data (HalfColor, Kitty, Iterm2, WezTerm)
• “NoColor” - For modes requiring grayscale data (Ascii, FullNoColor, KittyNoColor, Iterm2NoColor, WezTermNoColor)

Examples

use image_to_console_core::DisplayMode;

assert_eq!(DisplayMode::HalfColor.expect_image_type(), "Color");
assert_eq!(DisplayMode::Ascii.expect_image_type(), "NoColor");
#[cfg(feature = "sixel")]
assert_eq!(DisplayMode::SixelHalf.expect_image_type(), "Color2");

Trait Implementations

impl Clone for DisplayMode

fn clone(&self) -> DisplayMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayMode

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

Formats the value using the given formatter.

impl Default for DisplayMode

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for DisplayMode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for DisplayMode

impl Eq for DisplayMode

impl StructuralPartialEq for DisplayMode