Struct Image

pub struct Image<Handle = Handle> { /* private fields */ }

Available on crate feature image only.

A frame that displays an image while keeping aspect ratio.

Example

use iced::widget::image;

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    image("ferris.png").into()
}

Implementations

impl<Handle> Image<Handle>

pub fn new(handle: impl Into<Handle>) -> Self

Creates a new Image with the given path.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the Image boundaries.

pub fn height(self, height: impl Into<Length>) -> Self

Sets the height of the Image boundaries.

pub fn content_fit(self, content_fit: ContentFit) -> Self

Sets the [ContentFit] of the Image.

Defaults to [ContentFit::Contain]

pub fn filter_method(self, filter_method: FilterMethod) -> Self

Sets the FilterMethod of the Image.

pub fn rotation(self, rotation: impl Into<Rotation>) -> Self

Applies the given [Rotation] to the Image.

pub fn opacity(self, opacity: impl Into<f32>) -> 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 scale(self, scale: impl Into<f32>) -> 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.

Trait Implementations

impl<'a, Message, Theme, Renderer, Handle> From<Image<Handle>> for Element<'a, Message, Theme, Renderer>

where Renderer: Renderer<Handle = Handle>, Handle: Clone + 'a,

fn from(image: Image<Handle>) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer, Handle> Widget<Message, Theme, Renderer> for Image<Handle>

where Renderer: Renderer<Handle = Handle>, Handle: Clone,

fn size(&self) -> Size<Length>

Returns the [Size] of the [Widget] in lengths.

fn layout(&self, _tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the [layout::Node] of the [Widget].

fn draw( &self, _state: &Tree, renderer: &mut Renderer, _theme: &Theme, _style: &Style, layout: Layout<'_>, _cursor: Cursor, viewport: &Rectangle, )

Draws the [Widget] using the associated Renderer.

fn size_hint(&self) -> Size<Length>

Returns a [Size] hint for laying out the [Widget].

fn tag(&self) -> Tag

Returns the Tag of the [Widget].

fn state(&self) -> State

Returns the State of the [Widget].

fn children(&self) -> Vec<Tree>

Returns the state [Tree] of the children of the [Widget].

fn diff(&self, tree: &mut Tree)

Reconciles the [Widget] with the provided [Tree].

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an [Operation] to the [Widget].

fn update( &mut self, _state: &mut Tree, _event: &Event, _layout: Layout<'_>, _cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, _shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget].

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the [Widget], if there is any.