Struct egui::widgets::Image

source ·
pub struct Image<'a> {
    source: ImageSource<'a>,
    texture_options: TextureOptions,
    image_options: ImageOptions,
    sense: Sense,
    size: ImageSize,
    pub(crate) show_loading_spinner: Option<bool>,
}
Expand description

A widget which displays an image.

The task of actually loading the image is deferred to when the Image is added to the Ui, and how it is loaded depends on the provided ImageSource:

See crate::load for more information.

§Examples

// Using it in a layout:

ui.add(
    egui::Image::new(egui::include_image!("../../assets/ferris.png"))
        .rounding(5.0)
);

// Using it just to paint:

egui::Image::new(egui::include_image!("../../assets/ferris.png"))
    .rounding(5.0)
    .tint(egui::Color32::LIGHT_BLUE)
    .paint_at(ui, rect);

Fields§

§source: ImageSource<'a>§texture_options: TextureOptions§image_options: ImageOptions§sense: Sense§size: ImageSize§show_loading_spinner: Option<bool>

Implementations§

source§

impl<'a> Image<'a>

source

pub fn new(source: impl Into<ImageSource<'a>>) -> Self

Load the image from some source.

source

pub fn from_uri(uri: impl Into<Cow<'a, str>>) -> Self

Load the image from a URI.

See ImageSource::Uri.

source

pub fn from_texture(texture: impl Into<SizedTexture>) -> Self

Load the image from an existing texture.

See ImageSource::Texture.

source

pub fn from_bytes( uri: impl Into<Cow<'static, str>>, bytes: impl Into<Bytes>, ) -> Self

Load the image from some raw bytes.

For better error messages, use the bytes:// prefix for the URI.

See ImageSource::Bytes.

source

pub fn texture_options(self, texture_options: TextureOptions) -> Self

Texture options used when creating the texture.

source

pub fn max_width(self, width: f32) -> Self

Set the max width of the image.

No matter what the image is scaled to, it will never exceed this limit.

source

pub fn max_height(self, height: f32) -> Self

Set the max height of the image.

No matter what the image is scaled to, it will never exceed this limit.

source

pub fn max_size(self, size: Vec2) -> Self

Set the max size of the image.

No matter what the image is scaled to, it will never exceed this limit.

source

pub fn maintain_aspect_ratio(self, value: bool) -> Self

Whether or not the ImageFit should maintain the image’s original aspect ratio.

source

pub fn fit_to_original_size(self, scale: f32) -> Self

Fit the image to its original size with some scaling.

This will cause the image to overflow if it is larger than the available space.

If Image::max_size is set, this is guaranteed to never exceed that limit.

source

pub fn fit_to_exact_size(self, size: Vec2) -> Self

Fit the image to an exact size.

If Image::max_size is set, this is guaranteed to never exceed that limit.

source

pub fn fit_to_fraction(self, fraction: Vec2) -> Self

Fit the image to a fraction of the available space.

If Image::max_size is set, this is guaranteed to never exceed that limit.

source

pub fn shrink_to_fit(self) -> Self

Fit the image to 100% of its available size, shrinking it if necessary.

This is a shorthand for Image::fit_to_fraction with 1.0 for both width and height.

If Image::max_size is set, this is guaranteed to never exceed that limit.

source

pub fn sense(self, sense: Sense) -> Self

Make the image respond to clicks and/or drags.

source

pub fn uv(self, uv: impl Into<Rect>) -> Self

Select UV range. Default is (0,0) in top-left, (1,1) bottom right.

source

pub fn bg_fill(self, bg_fill: impl Into<Color32>) -> Self

A solid color to put behind the image. Useful for transparent images.

source

pub fn tint(self, tint: impl Into<Color32>) -> Self

Multiply image color with this. Default is WHITE (no tint).

source

pub fn rotate(self, angle: f32, origin: Vec2) -> Self

Rotate the image about an origin by some angle

Positive angle is clockwise. Origin is a vector in normalized UV space ((0,0) in top-left, (1,1) bottom right).

To rotate about the center you can pass Vec2::splat(0.5) as the origin.

Due to limitations in the current implementation, this will turn off rounding of the image.

source

pub fn rounding(self, rounding: impl Into<Rounding>) -> Self

Round the corners of the image.

The default is no rounding (Rounding::ZERO).

Due to limitations in the current implementation, this will turn off any rotation of the image.

source

pub fn show_loading_spinner(self, show: bool) -> Self

Show a spinner when the image is loading.

By default this uses the value of crate::Visuals::image_loading_spinners.

source§

impl<'a> Image<'a>

source

pub fn calc_size( &self, available_size: Vec2, original_image_size: Option<Vec2>, ) -> Vec2

Returns the size the image will occupy in the final UI.

source

pub fn load_and_calc_size(&self, ui: &Ui, available_size: Vec2) -> Option<Vec2>

source

pub fn size(&self) -> Option<Vec2>

source

pub fn uri(&self) -> Option<&str>

Returns the URI of the image.

For GIFs, returns the URI without the frame number.

source

pub fn image_options(&self) -> &ImageOptions

source

pub fn source(&'a self, ctx: &Context) -> ImageSource<'a>

source

pub fn load_for_size( &self, ctx: &Context, available_size: Vec2, ) -> TextureLoadResult

Load the image from its Image::source, returning the resulting SizedTexture.

The available_size is used as a hint when e.g. rendering an svg.

§Errors

May fail if they underlying Context::try_load_texture call fails.

source

pub fn paint_at(&self, ui: &Ui, rect: Rect)

Paint the image in the given rectangle.

egui::Image::new(egui::include_image!("../../assets/ferris.png"))
    .rounding(5.0)
    .tint(egui::Color32::LIGHT_BLUE)
    .paint_at(ui, rect);

Trait Implementations§

source§

impl<'a> Clone for Image<'a>

source§

fn clone(&self) -> Image<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for Image<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a, T: Into<ImageSource<'a>>> From<T> for Image<'a>

source§

fn from(value: T) -> Self

Converts to this type from the input type.
source§

impl<'a> Widget for Image<'a>

source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Image<'a>

§

impl<'a> RefUnwindSafe for Image<'a>

§

impl<'a> Send for Image<'a>

§

impl<'a> Sync for Image<'a>

§

impl<'a> Unpin for Image<'a>

§

impl<'a> UnwindSafe for Image<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,