Struct Image

pub struct Image {
    pub contents: Value<AnyTexture>,
    pub scaling: Value<ImageScaling>,
    pub opacity: Value<ZeroToOne>,
}

A widget that displays an image/texture.

Fields

contents: Value<AnyTexture>

The texture to render.

scaling: Value<ImageScaling>

The scaling strategy to apply.

opacity: Value<ZeroToOne>

The opacity to render the image with.

Implementations

impl Image

pub fn new(contents: impl IntoValue<AnyTexture>) -> Self

Returns a new image widget that renders contents, using the default ImageScaling strategy.

pub fn scaling(self, scaling: impl IntoValue<ImageScaling>) -> Self

Applies the scaling strategies and returns self.

pub fn opacity(self, opacity: impl IntoValue<ZeroToOne>) -> Self

Applies opacity when drawing the image, returns self.

pub fn aspect_fit(self) -> Self

Applies the aspect-fit scaling strategy and returns self.

The aspect-fit scaling strategy scales the image to be the largest size it can be without clipping. Any remaining whitespace will be at the right or bottom edge.

To apply a different orientation for the whitespace, use Self::aspect_fit_around.

pub fn aspect_fit_around(self, orientation: Size<ZeroToOne>) -> Self

Applies the aspect-fit scaling strategy and returns self.

The aspect-fit scaling strategy scales the image to be the largest size it can be without clipping. Any remaining whitespace will be divided using the ratio orientation.

pub fn aspect_fill(self) -> Self

Applies the aspect-fill scaling strategy and returns self.

The aspect-fill scaling strategy scales the image to be the smallest size it can be to cover the entire surface. The bottom or right sides of the image will be clipped.

To apply a different orientation for the clipping, use Self::aspect_fill_around.

pub fn aspect_fill_around(self, orientation: Size<ZeroToOne>) -> Self

Applies the aspect-fill scaling strategy and returns self.

The aspect-fill scaling strategy scales the image to be the smallest size it can be to cover the entire surface. The side that is cropped will be positioned using orientation.

pub fn stretch(self) -> Self

Applies the stretch scaling strategy and returns self.

The stretch scaling strategy stretches the image to fill the surface, ignoring the aspect ratio.

pub fn scaled(self, amount: impl IntoValue<f32>) -> Self

Applies a scaling factor strategy and returns self.

The image will be displayed at a scaling factor of amount. In this mode, the widget will request that its size be the size of the contained image.

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.

impl Widget for Image

fn redraw(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Redraw the contents of this widget.

fn layout( &mut self, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> Size<UPx>

Layout this widget and returns the ideal size based on its contents and the available_space.

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

Writes a summary of this widget into fmt.

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply.

fn mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent widget.

fn unmounted(&mut self, context: &mut EventContext<'_>)

The widget has been removed from its parent widget.

fn hit_test( &mut self, location: Point<Px>, context: &mut EventContext<'_>, ) -> bool

Returns true if this widget should respond to mouse input at location.

fn hover( &mut self, location: Point<Px>, context: &mut EventContext<'_>, ) -> Option<CursorIcon>

The widget is currently has a cursor hovering it at location.

fn unhover(&mut self, context: &mut EventContext<'_>)

The widget is no longer being hovered.

fn accept_focus(&mut self, context: &mut EventContext<'_>) -> bool

This widget has been targeted to be focused. If this function returns true, the widget will be focused. If false, Cushy will continue searching for another focus target.

fn focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

fn advance_focus( &mut self, direction: VisualOrder, context: &mut EventContext<'_>, ) -> EventHandling

The widget should switch to the next focusable area within this widget, honoring direction in a consistent manner. Returning HANDLED will cause the search for the next focus widget stop.

fn allow_blur(&mut self, context: &mut EventContext<'_>) -> bool

The widget is about to lose focus. Returning true allows the focus to switch away from this widget.

fn blur(&mut self, context: &mut EventContext<'_>)

The widget is no longer focused for user input.

fn activate(&mut self, context: &mut EventContext<'_>)

The widget has become the active widget.

fn deactivate(&mut self, context: &mut EventContext<'_>)

The widget is no longer active.

fn mouse_down( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, ) -> EventHandling

A mouse button event has occurred at location. Returns whether the event has been handled or not.

fn mouse_drag( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is being held down as the cursor is moved across the widget.

fn mouse_up( &mut self, location: Option<Point<Px>>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is no longer being pressed.

fn keyboard_input( &mut self, device_id: DeviceId, input: KeyEvent, is_synthetic: bool, context: &mut EventContext<'_>, ) -> EventHandling

A keyboard event has been sent to this widget. Returns whether the event has been handled or not.

fn ime(&mut self, ime: Ime, context: &mut EventContext<'_>) -> EventHandling

An input manager event has been sent to this widget. Returns whether the event has been handled or not.

fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, context: &mut EventContext<'_>, ) -> EventHandling

A mouse wheel event has been sent to this widget. Returns whether the event has been handled or not.

fn root_behavior( &mut self, context: &mut EventContext<'_>, ) -> Option<(RootBehavior, WidgetInstance)>

Returns a reference to a single child widget if this widget is a widget that primarily wraps a single other widget to customize its behavior.