Skip to main content

Image

Struct Image 

Source
pub struct Image { /* private fields */ }
Expand description

Local image component. Layout uses logical pixels; raster resolution uses DPI and enclosing visual scale. The default preserves aspect.

Screen readers announce an image by its Image::alt text. One that only decorates is marked Image::decorative and skipped; an image with neither is reported as DiagnosticKind::MissingAccessibleName while assistive technology is connected.

use zaxis::{Image, ImageFit, ImageSource, TextureFilter, vec2};
ui.image("assets/photo.jpg");
ui.add(Image::new("assets/photo.jpg").alt("Harbour at dusk"));
ui.add(Image::new("assets/icon.svg").size(vec2(96.0, 96.0)).corner_radius(12.0).decorative());
let pixels = ImageSource::rgba([2, 2], vec![255; 16]);
ui.add(Image::new(&pixels).size(vec2(64.0,64.0)).filter(TextureFilter::Nearest).fit(ImageFit::Cover));

Implementations§

Source§

impl Image

Source

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

Source

pub fn alt(self, text: impl Into<String>) -> Self

What the image shows, in words: the name screen readers announce. An empty text marks the image Self::decorative.

Source

pub fn decorative(self) -> Self

The image adds nothing the text around it does not say: assistive technology skips it. An Self::interactive image is a control and stays in the tree, so it still needs Self::alt.

Source

pub fn id_source(self, id: impl Hash) -> Self

Source

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

Source

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

Source

pub fn aspect_ratio(self, ratio: f32) -> Self

Reserves space before intrinsic metadata arrives (width / height).

Source

pub fn fit(self, fit: ImageFit) -> Self

Source

pub fn tint(self, tint: Color) -> Self

Source

pub fn opacity(self, opacity: f32) -> Self

Source

pub fn corner_radius(self, radius: impl Into<CornerRadius>) -> Self

Source

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

Normalized source crop, clipped to [0, 1]. Cover applies a further centered crop.

Source

pub fn filter(self, filter: TextureFilter) -> Self

Source

pub fn interactive(self, interactive: bool) -> Self

Source

pub fn placeholder(self, placeholder: bool) -> Self

Suppress the default placeholder to paint application-specific loading/errors.

Source

pub fn show(self, ui: &mut Ui<'_>) -> ImageOutput

Trait Implementations§

Source§

impl Widget for Image

Source§

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

Source§

fn tooltip(self, text: impl Into<String>) -> TooltipWidget<Self>
where Self: Sized,

Show a tooltip while the widget is hovered, in the same expression: ui.add(Button::new("Save").tooltip("Write the file")).
Source§

fn context_menu(self, items: &[ContextMenuItem]) -> ContextMenuWidget<'_, Self>
where Self: Sized,

Open a context menu on secondary click. The chosen item is reported by Response::menu_selected on the pass it is picked.
Source§

fn accessible_label(self, label: impl Into<String>) -> Accessible<Self>
where Self: Sized,

The name a screen reader speaks for this widget, replacing the one it derives from its visible text. Required for controls without text: an icon button, a bare switch, a slider without a caption.
Source§

fn accessible_description( self, description: impl Into<String>, ) -> Accessible<Self>
where Self: Sized,

Extra detail a screen reader speaks after the name: a hint or the reason for an error.
Source§

fn accessible_role(self, role: AccessRole) -> Accessible<Self>
where Self: Sized,

Present this widget to assistive technology as role. A custom widget that does not describe itself becomes a node of this role with the response’s bounds.
Source§

fn accessibility_hidden(self) -> Accessible<Self>
where Self: Sized,

Leave this widget and everything in it out of the accessibility tree: decoration that says nothing a screen reader user needs.

Auto Trait Implementations§

§

impl Freeze for Image

§

impl RefUnwindSafe for Image

§

impl Send for Image

§

impl Sync for Image

§

impl Unpin for Image

§

impl UnsafeUnpin for Image

§

impl UnwindSafe for Image

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more