Struct egui::widgets::image::Image

source ·
pub struct Image {
    texture_id: TextureId,
    uv: Rect,
    size: Vec2,
    bg_fill: Color32,
    tint: Color32,
    sense: Sense,
    rotation: Option<(Rot2, Vec2)>,
}
Expand description

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.

Fields§

§texture_id: TextureId§uv: Rect§size: Vec2§bg_fill: Color32§tint: Color32§sense: Sense§rotation: Option<(Rot2, Vec2)>

Implementations§

source§

impl Image

source

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

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 sense(self, sense: Sense) -> Self

Make the image respond to clicks and/or drags.

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

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.

source§

impl Image

source

pub fn size(&self) -> Vec2

source

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

Trait Implementations§

source§

impl Clone for Image

source§

fn clone(&self) -> Image

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 Debug for Image

source§

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

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

impl Widget for Image

source§

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

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

impl Copy for Image

Auto Trait Implementations§

§

impl RefUnwindSafe for Image

§

impl Send for Image

§

impl Sync for Image

§

impl Unpin for Image

§

impl UnwindSafe for Image

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere T: 'static + Any + Clone + Send + Sync,