Struct conrod::widget::primitive::image::Image[][src]

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

Data necessary and common for all widget builder types.

The unique identifier for the image that will be drawn.

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

Unique styling.

Methods

impl Image
[src]

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.

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

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

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

Trait Implementations

impl Copy for Image
[src]

impl Clone for Image
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Widget for Image
[src]

State to be stored within the Uis widget cache. Read more

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. Read more

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

Return the initial State of the Widget. Read more

Return the styling of the widget. Read more

The default width for the Widget. Read more

The default height of the widget. Read more

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

The default Position for the widget along the x axis. Read more

The default Position for the widget along the y axis. Read more

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. Read more

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

Returns either of the following: Read more

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

Specify that this widget has no parent widgets.

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

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

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. Read more

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

Makes the widget's KidArea scrollable. Read more

Makes the widget's KidArea scrollable. Read more

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

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

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

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

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

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

Auto Trait Implementations

impl Send for Image

impl Sync for Image