Struct RetainedEguiImage

pub struct RetainedEguiImage {
    pub debug_name: String,
    pub size: [usize; 2],
    pub image: Mutex<ColorImage>,
    pub texture: Mutex<Option<TextureHandle>>,
}

An image to be shown in egui.

Load once, and save somewhere in your app state.

Use the svg and image features to enable more constructors.

Fields

debug_name: String

size: [usize; 2]

image: Mutex<ColorImage>

Cleared once Self::texture has been loaded.

texture: Mutex<Option<TextureHandle>>

Lazily loaded when we have an egui context.

Implementations

impl RetainedEguiImage

pub fn from_color_image( debug_name: impl Into<String>, image: ColorImage, ) -> Self

pub fn from_fltk_image<I: ImageExt>( debug_name: impl Into<String>, image: I, ) -> Result<RetainedEguiImage, FltkError>

pub fn from_fltk_image_as_ref<I: ImageExt>( debug_name: impl Into<String>, image: &I, ) -> Result<RetainedEguiImage, FltkError>

pub fn from_fltk_svg_image( debug_name: impl Into<String>, svg_image: SvgImage, ) -> Result<RetainedEguiImage, FltkError>

pub fn size(&self) -> [usize; 2]

The size of the image data (number of pixels wide/high).

pub fn size_vec2(&self) -> Vec2

The size of the image data (number of pixels wide/high).

pub fn debug_name(&self) -> &str

The debug name of the image, e.g. the file name.

pub fn texture_id(&self, ctx: &Context) -> TextureId

The texture id for this image.

pub fn show_max_size(&self, ui: &mut Ui, max_size: Vec2) -> Response

Show the image with the given maximum size.

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

Show the image with the original size (one image pixel = one gui point).

pub fn show_scaled(&self, ui: &mut Ui, scale: f32) -> Response

Show the image with the given scale factor (1.0 = original size).

pub fn show_size(&self, ui: &mut Ui, desired_size: Vec2) -> Response

Show the image with the given size.