//! Images display raster graphics in different formats (PNG, JPG, etc.). //! //! # Example //! ```no_run //! # mod iced { pub mod widget { pub use iced_widget::*; } } //! # pub type State = (); //! # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>; //! use iced::widget::image; //! //! enum Message { //! // ... //! } //! //! fn view(state: &State) -> Element<'_, Message> { //! image("ferris.png").into() //! } //! ``` //! pub mod viewer; pub use viewer::Viewer; use crate::core::image; use crate::core::layout; use crate::core::mouse; use crate::core::renderer; use crate::core::widget::Tree; use crate::core::{ ContentFit, Element, Layout, Length, Point, Rectangle, Rotation, Size, Vector, Widget, }; pub use image::{FilterMethod, Handle}; /// Creates a new [`Viewer`] with the given image `Handle`. pub fn viewer(handle: Handle) -> Viewer { Viewer::new(handle) } /// A frame that displays an image while keeping aspect ratio. /// /// # Example /// ```no_run /// # mod iced { pub mod widget { pub use iced_widget::*; } } /// # pub type State = (); /// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>; /// use iced::widget::image; /// /// enum Message { /// // ... /// } /// /// fn view(state: &State) -> Element<'_, Message> { /// image("ferris.png").into() /// } /// ``` /// #[derive(Debug)] pub struct Image { handle: Handle, width: Length, height: Length, content_fit: ContentFit, filter_method: FilterMethod, rotation: Rotation, opacity: f32, scale: f32, } impl Image { /// Creates a new [`Image`] with the given path. pub fn new(handle: impl Into) -> Self { Image { handle: handle.into(), width: Length::Shrink, height: Length::Shrink, content_fit: ContentFit::default(), filter_method: FilterMethod::default(), rotation: Rotation::default(), opacity: 1.0, scale: 1.0, } } /// Sets the width of the [`Image`] boundaries. pub fn width(mut self, width: impl Into) -> Self { self.width = width.into(); self } /// Sets the height of the [`Image`] boundaries. pub fn height(mut self, height: impl Into) -> Self { self.height = height.into(); self } /// Sets the [`ContentFit`] of the [`Image`]. /// /// Defaults to [`ContentFit::Contain`] pub fn content_fit(mut self, content_fit: ContentFit) -> Self { self.content_fit = content_fit; self } /// Sets the [`FilterMethod`] of the [`Image`]. pub fn filter_method(mut self, filter_method: FilterMethod) -> Self { self.filter_method = filter_method; self } /// Applies the given [`Rotation`] to the [`Image`]. pub fn rotation(mut self, rotation: impl Into) -> Self { self.rotation = rotation.into(); self } /// Sets the opacity of the [`Image`]. /// /// It should be in the [0.0, 1.0] range—`0.0` meaning completely transparent, /// and `1.0` meaning completely opaque. pub fn opacity(mut self, opacity: impl Into) -> Self { self.opacity = opacity.into(); self } /// Sets the scale of the [`Image`]. /// /// The region of the [`Image`] drawn will be scaled from the center by the given scale factor. /// This can be useful to create certain effects and animations, like smooth zoom in / out. pub fn scale(mut self, scale: impl Into) -> Self { self.scale = scale.into(); self } } /// Computes the layout of an [`Image`]. pub fn layout( renderer: &Renderer, limits: &layout::Limits, handle: &Handle, width: Length, height: Length, content_fit: ContentFit, rotation: Rotation, ) -> layout::Node where Renderer: image::Renderer, { // The raw w/h of the underlying image let image_size = renderer.measure_image(handle); let image_size = Size::new(image_size.width as f32, image_size.height as f32); // The rotated size of the image let rotated_size = rotation.apply(image_size); // The size to be available to the widget prior to `Shrink`ing let raw_size = limits.resolve(width, height, rotated_size); // The uncropped size of the image when fit to the bounds above let full_size = content_fit.fit(rotated_size, raw_size); // Shrink the widget to fit the resized image, if requested let final_size = Size { width: match width { Length::Shrink => f32::min(raw_size.width, full_size.width), _ => raw_size.width, }, height: match height { Length::Shrink => f32::min(raw_size.height, full_size.height), _ => raw_size.height, }, }; layout::Node::new(final_size) } /// Draws an [`Image`] pub fn draw( renderer: &mut Renderer, layout: Layout<'_>, viewport: &Rectangle, handle: &Handle, content_fit: ContentFit, filter_method: FilterMethod, rotation: Rotation, opacity: f32, scale: f32, ) where Renderer: image::Renderer, Handle: Clone, { let Size { width, height } = renderer.measure_image(handle); let image_size = Size::new(width as f32, height as f32); let rotated_size = rotation.apply(image_size); let bounds = layout.bounds(); let adjusted_fit = content_fit.fit(rotated_size, bounds.size()); let fit_scale = Vector::new( adjusted_fit.width / rotated_size.width, adjusted_fit.height / rotated_size.height, ); let final_size = image_size * fit_scale * scale; let position = match content_fit { ContentFit::None => Point::new( bounds.x + (rotated_size.width - adjusted_fit.width) / 2.0, bounds.y + (rotated_size.height - adjusted_fit.height) / 2.0, ), _ => Point::new( bounds.center_x() - final_size.width / 2.0, bounds.center_y() - final_size.height / 2.0, ), }; let drawing_bounds = Rectangle::new(position, final_size); let render = |renderer: &mut Renderer| { renderer.draw_image( image::Image { handle: handle.clone(), filter_method, rotation: rotation.radians(), opacity, snap: true, }, drawing_bounds, ); }; if adjusted_fit.width > bounds.width || adjusted_fit.height > bounds.height { if let Some(bounds) = bounds.intersection(viewport) { renderer.with_layer(bounds, render); } } else { render(renderer); } } impl Widget for Image where Renderer: image::Renderer, Handle: Clone, { fn size(&self) -> Size { Size { width: self.width, height: self.height, } } fn layout( &self, _tree: &mut Tree, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { layout( renderer, limits, &self.handle, self.width, self.height, self.content_fit, self.rotation, ) } fn draw( &self, _state: &Tree, renderer: &mut Renderer, _theme: &Theme, _style: &renderer::Style, layout: Layout<'_>, _cursor: mouse::Cursor, viewport: &Rectangle, ) { draw( renderer, layout, viewport, &self.handle, self.content_fit, self.filter_method, self.rotation, self.opacity, self.scale, ); } } impl<'a, Message, Theme, Renderer, Handle> From> for Element<'a, Message, Theme, Renderer> where Renderer: image::Renderer, Handle: Clone + 'a, { fn from(image: Image) -> Element<'a, Message, Theme, Renderer> { Element::new(image) } }