Struct egui::widgets::Image

pub struct Image { /* private fields */ }

An widget to show an image of a given size.

In order to display an image you must first acquire a TextureHandle. This is best done with egui_extras::RetainedImage or Context::load_texture.

struct MyImage {
    texture: Option<egui::TextureHandle>,
}

impl MyImage {
    fn ui(&mut self, ui: &mut egui::Ui) {
        let texture: &egui::TextureHandle = self.texture.get_or_insert_with(|| {
            // Load the texture only once.
            ui.ctx().load_texture(
                "my-image",
                egui::ColorImage::example(),
                Default::default()
            )
        });

        // Show the image:
        ui.add(egui::Image::new(texture, texture.size_vec2()));

        // Shorter version:
        ui.image(texture, texture.size_vec2());
    }
}

Se also crate::Ui::image and crate::ImageButton.

Implementations

impl Image

pub fn new(texture_id: impl Into<TextureId>, size: impl Into<Vec2>) -> Self

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

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

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

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

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

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

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

Make the image respond to clicks and/or drags.

Consider using ImageButton instead, for an on-hover effect.

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.

impl Image

pub fn size(&self) -> Vec2

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

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Widget for Image

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

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

impl Copy for Image