pub struct Image { /* private fields */ }
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())
});
// 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
sourceimpl Image
impl Image
pub fn new(texture_id: impl Into<TextureId>, size: impl Into<Vec2>) -> Self
sourcepub fn uv(self, uv: impl Into<Rect>) -> Self
pub fn uv(self, uv: impl Into<Rect>) -> Self
Select UV range. Default is (0,0) in top-left, (1,1) bottom right.
sourcepub fn bg_fill(self, bg_fill: impl Into<Color32>) -> Self
pub fn bg_fill(self, bg_fill: impl Into<Color32>) -> Self
A solid color to put behind the image. Useful for transparent images.
sourcepub fn tint(self, tint: impl Into<Color32>) -> Self
pub fn tint(self, tint: impl Into<Color32>) -> Self
Multiply image color with this. Default is WHITE (no tint).
sourcepub fn sense(self, sense: Sense) -> Self
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.
Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more