Struct conrod_core::widget::primitive::image::Image

pub struct Image {
    pub common: CommonBuilder,
    pub image_id: Id,
    pub src_rect: Option<Rect>,
    pub style: Style,
}

A primitive and basic widget for drawing an Image.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

image_id: Id

The unique identifier for the image that will be drawn.

src_rect: Option<Rect>

The rectangle area of the original source image that should be used.

style: Style

Unique styling.

Implementations

impl Image

pub fn new(image_id: Id) -> Self

Construct a new Image.

Note that the Image widget does not require borrowing or owning any image data directly. Instead, image data is stored within a conrod::image::Map where image::Ids are mapped to their associated data.

This is done for a few reasons:

• To avoid requiring that the widget graph owns an instance of each image
• To avoid requiring that the user passes the image data to the Image every update unnecessarily
• To make it easier for users to borrow and mutate their images without needing to index into the Ui's widget graph (which also requires casting types).

During rendering, conrod will take the image::Map, retrieve the data associated with each image and yield it via the render::Primitive::Image variant.

Note: this implies that the type must be the same for all Image widgets instantiated via the same Ui. In the case that you require multiple different types of images, we recommend that you either:

1. use an enum with a variant for each type
2. use a trait object, where the trait is implemented for each of your image types or
3. use an index type which may be mapped to your various image types.

pub fn source_rectangle(self, rect: Rect) -> Self

The rectangular area of the image that we wish to display.

If this method is not called, the entire image will be used.

pub fn color(self, color: Option<Color>) -> Self

Build the type's self.$($assignee).+ with the given $Type.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Common for Image

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

fn common_mut(&mut self) -> &mut CommonBuilder

Mutably borrows the CommonBuilder field.

impl Copy for Image

impl Widget for Image

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

type Event = ()

The type of event yielded by the widget, returned via the Widget::set function.

fn init_state(&self, _: Generator<'_>) -> Self::State

Return the initial State of the Widget.

fn style(&self) -> Self::Style

Return the styling of the widget.

fn default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

fn default_y_dimension(&self, ui: &Ui) -> Dimension

The default height of the widget.

fn update(self, args: UpdateArgs<'_, '_, '_, '_, Self>) -> Self::Event

Update our Widget's unique Widget::State via the State wrapper type (the state field within the UpdateArgs).

fn default_x_position(&self, ui: &Ui) -> Position

The default Position for the widget along the x axis.

fn default_y_position(&self, ui: &Ui) -> Position

The default Position for the widget along the y axis.

fn drag_area(
    &self,
    _dim: Dimensions,
    _style: &Self::Style,
    _theme: &Theme
) -> Option<Rect>

If the widget is draggable, implement this method and return the position and dimensions of the draggable space. The position should be relative to the center of the widget.

fn kid_area(&self, args: KidAreaArgs<'_, Self>) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

fn is_over(&self) -> IsOverFn

Returns either of the following:

fn parent(self, parent_id: Id) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

fn graphics_for(self, id: Id) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

fn floating(self, is_floating: bool) -> Self

Set whether or not the widget is floating (the default is false). A typical example of a floating widget would be a pop-up or alert window.

fn crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

fn scroll_kids(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_vertically(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false).

fn and<F>(self, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A builder method that "lifts" the Widget through the given build function.

fn and_mut<F>(self, mutate: F) -> Self where
    F: FnOnce(&mut Self), 

A builder method that mutates the Widget with the given mutate function.

fn and_if<F>(self, cond: bool, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A method that conditionally builds the Widget with the given build function.

fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
    F: FnOnce(Self, T) -> Self, 

A method that optionally builds the Widget with the given build function.

fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event

Note: There should be no need to override this method.