Struct Sprite 

pub struct Sprite { /* private fields */ }

A raster image widget, loaded from a handle

Size is inferred from the loaded image. By default, scaling is limited to integer multiples of the source image size.

May be default constructed (result is empty).

Implementations

impl Sprite

pub fn new() -> Self

Construct an empty (unallocated) image

pub fn set(&mut self, cx: &mut EventCx<'_>, handle: ImageHandle) -> bool

Assign a pre-allocated image

Returns true on success. On error, self is unchanged.

pub fn handle(&self) -> Option<&ImageHandle>

Access the current ImageHandle, if any

This handle may be used with DrawShared methods.

pub fn image_size(&self) -> Size

Get the image buffer size

This is the size of the image last assigned using Sprite::set. Initially it is Size::ZERO.

pub fn clear(&mut self, cx: &mut EventCx<'_>)

Remove image (set empty)

pub fn set_logical_size(&mut self, size: impl Into<LogicalSize>)

Set size in logical pixels

This enables fractional scaling of the image with a fixed aspect ratio.

pub fn with_logical_size(self, size: impl Into<LogicalSize>) -> Self

Set size in logical pixels (inline)

This enables fractional scaling of the image with a fixed aspect ratio.

pub fn with_margin_style(self, style: MarginStyle) -> Self

Set the margin style (inline)

By default, this is MarginStyle::Large.

pub fn with_fixed_aspect_ratio(self, fixed: bool) -> Self

Control whether the aspect ratio is fixed (inline)

This is only applicable when using fractional scaling (see Self::set_logical_size) since integer scaling always uses a fixed aspect ratio. By default this is enabled.

pub fn with_stretch(self, stretch: Stretch) -> Self

Set the stretch factor (inline)

By default this is Stretch::None. Particular to this widget, Stretch::None will avoid stretching of content, aligning instead.

Trait Implementations

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Default for Sprite

fn default() -> Sprite

Returns the “default value” for a type.

impl Events for Sprite

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: Event<'_>, ) -> IsUsed

Handle an Event

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse pointer icon to use on mouse over

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn post_configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self (post-child-configuration actions)

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn recurse_indices(&self) -> ChildIndices

Recursion control

fn handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn child_nav_focus(&mut self, cx: &mut EventCx<'_>, id: Id)

Notification that a child received navigation focus

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)

Handler for messages from children/descendants

fn handle_resize( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, ) -> Option<ActionResize>

Handler for resize requests

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl Layout for Sprite

fn size_rules(&mut self, cx: &mut SizeCx<'_>, axis: AxisInfo) -> SizeRules

Calculate size requirements for an axis

fn set_rect(&mut self, cx: &mut SizeCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

fn rect(&self) -> Rect

Get the widget’s region

impl Tile for Sprite

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

fn get_child(&self, index: usize) -> Option<&dyn Tile>

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl Widget for Sprite

type Data = ()

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available