Struct Image 

pub struct Image {
    pub source: ImageSource,
    pub format: ImageFormat,
    pub size: Vec2,
    /* private fields */
}

Image.

Fields

source: ImageSource

Source.

format: ImageFormat

Format.

size: Vec2

Size (in pixels).

Implementations

impl Image

pub fn new_owned_from_gif_file<PathT>( path: PathT, compress: bool, ) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature gif only.

Constructor.

The implementation only supports RGBA.

pub fn new_stream_from_gif_file<PathT>(path: PathT) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature gif only.

Constructor.

The implementation only supports RGBA.

Examples found in repository

examples/gif.rs (line 13)

fn main() {
    let mut cursive = default();

    cursive.add_layer(Panel::new(ImageView::default().with_image(
        // GIFs will always be RGBA
        Image::new_stream_from_gif_file(FILE).expect("new_stream_from_gif_file"),
    )));

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

impl Image

pub fn new_owned_from_jpeg_file<PathT>( path: PathT, format: ImageFormat, compress: bool, ) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature jpeg only.

Constructor.

The implementation supports both RGB and RGBA.

pub fn new_stream_from_jpeg_file<PathT>( path: PathT, format: ImageFormat, ) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature jpeg only.

Constructor.

The implementation supports both RGB and RGBA.

Examples found in repository

examples/scrollable.rs (line 20)

fn main() {
    let mut cursive = default();

    cursive.add_layer(
        Panel::new(
            ImageView::default()
                .with_image(
                    // Note that RGBA is supported, too, if you need transparency
                    Image::new_stream_from_jpeg_file(FILE, ImageFormat::RGB).expect("new_stream_from_jpeg_file"),
                    // If you prefer to keep the image data in memory:
                    // Image::new_owned_from_jpeg_file(FILE, ImageFormat::RGB, true).expect("new_owned_from_jpeg_file"),
                )
                .with_sizing(Sizing::original())
                .scrollable()
                .scroll_x(true),
        )
        .fixed_size((50, 20)),
    );

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

impl Image

pub fn new_owned_from_pdf_file<PathT>( path: PathT, format: ImageFormat, scale: f64, compress: bool, ) -> Result<Vec<Self>>

where PathT: AsRef<Path>,

Available on crate feature pdf only.

Constructor.

Creates an image for every page in the PDF.

The implementation supports both PNG and RGBA.

Examples found in repository

examples/pdf.rs (line 16)

fn main() {
    let mut cursive = default();

    // The constructor returns a vector of images, one for each page in the PDF
    // PDF pages can be either PNG or RGBA (PNG is usually more efficient)
    // Note that we can apply scaling during rendering
    let images = Image::new_owned_from_pdf_file(FILE, ImageFormat::PNG, 1.5, false).expect("new_owned_from_pdf_file");

    cursive.set_user_data(Pages::new(images));

    cursive.add_layer(
        Dialog::around(
            Panel::new(
                ImageView::default().with_sizing(Sizing::original()).with_name(NAME).scrollable().scroll_x(true),
            )
            .fixed_size((50, 30)),
        )
        .button("Previous", |cursive| flip_page(cursive, -1))
        .button("Next", |cursive| flip_page(cursive, 1)),
    );

    select_page(&mut cursive, 0);

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

pub fn new_stream_from_pdf_file<PathT>( path: PathT, format: ImageFormat, scale: f64, ) -> Result<Vec<Self>>

where PathT: AsRef<Path>,

Available on crate feature pdf only.

Constructor.

Creates an image for every page in the PDF.

The implementation supports both PNG and RGBA.

impl Image

pub fn new_png_file<PathT>(path: PathT) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature png only.

Constructor.

Gets the image size by decoding the PNG header.

Examples found in repository

examples/positioning.rs (line 22)

fn main() {
    let mut cursive = default();

    cursive.add_layer(Panel::new(
        ImageView::default()
            // We're also showing the use of new_png_file(), which discovers the image size for us
            // (requires the "png" feature)
            .with_image(Image::new_png_file(FILE).expect("new_png_file"))
            .with_name(NAME)
            .fixed_size((50, 20)),
    ));

    cursive.add_global_callback('s', |cursive| {
        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
            image_view.set_sizing(match image_view.sizing() {
                Sizing::Shrink => Sizing::Fit,
                Sizing::Fit => Sizing::Scale(3.),
                Sizing::Scale(_) => Sizing::Shrink,
            })
        });
    });

    cursive.add_global_callback('h', |cursive| {
        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
            image_view.set_align(match image_view.align() {
                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
            })
        });
    });

    cursive.add_global_callback('v', |cursive| {
        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
            image_view.set_align(match image_view.align() {
                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
            })
        });
    });

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

impl Image

pub fn new_owned_from_svg_file<PathT>( path: PathT, format: ImageFormat, scale: f64, compress: bool, ) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature svg only.

Constructor.

The implementation supports both PNG and RGBA.

pub fn new_stream_from_svg_file<PathT>( path: PathT, format: ImageFormat, scale: f64, ) -> Result<Self>

where PathT: AsRef<Path>,

Available on crate feature svg only.

Constructor.

The implementation supports both PNG and RGBA.

Examples found in repository

examples/svg.rs (line 15)

fn main() {
    let mut cursive = default();

    cursive.add_layer(Panel::new(ImageView::default().with_image(
        // SVG can be either PNG or RGBA (PNG is usually more efficient)
        // Note that we can apply scaling during rendering
        Image::new_stream_from_svg_file(FILE, ImageFormat::PNG, 2.5).expect("new_stream_from_svg_file"),
    )));

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

impl Image

pub fn new_owned<SizeT>( data: Vec<u8>, compressed: bool, format: ImageFormat, size: SizeT, ) -> Self

where SizeT: Into<Vec2>,

Constructor.

pub fn new_file<PathT, SizeT>( path: PathT, compressed: bool, format: ImageFormat, size: SizeT, ) -> Self

where PathT: Into<PathBuf>, SizeT: Into<Vec2>,

Constructor.

Examples found in repository

examples/simple.rs (lines 14-19)

fn main() {
    let mut cursive = default();

    // By default the image view uses "shrink" sizing

    cursive.add_layer(Panel::new(ImageView::default().with_image(Image::new_file(
        FILE,
        false,
        ImageFormat::PNG,
        (96, 96),
    ))));

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

pub fn new_stream<ImageStreamT, SizeT>( stream: ImageStreamT, format: ImageFormat, size: SizeT, ) -> Self

where ImageStreamT: 'static + ImageStream + Send + Sync, SizeT: Into<Vec2>,

Constructor.

pub fn into_owned(&mut self) -> Result<()>

Into owned.

Trait Implementations

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl KittyImage for Image

fn register(&self) -> Result<usize>

Register with terminal (if not already registered).

fn release(&self) -> Result<()>

Release from terminal (if registered).

fn show<PositionT, SizeT>( &self, position: PositionT, size: Option<SizeT>, window: Option<Rect>, ) -> Result<()>

where PositionT: Into<Vec2>, SizeT: Into<Vec2>,

Add a placement. Will also remove the existing placement (if there is one).

fn hide(&self) -> Result<()>

Remove placement (if there is one).