[−][src]Struct pushrod::widgets::image_widget::ImageWidget
This is the storage object for the ImageWidget
. It stores the config, properties, callback registry,
the image name, and a scale flag.
Methods
impl ImageWidget
[src]
Creates a new ImageWidget
, which draws an image in a supported image format for SDL2 at a specific
location on the screen. Requires the name of the image (the full path to the file), the position
within the widget (defined as ImagePosition
), the xywh bounds, and whether or not the image is
scaled within the bounds of the Widget
.
pub fn new(image_name: String, points: Points, size: Size, scaled: bool) -> Self
[src]
Creates a new instance of the ImageWidget
object. Requires an image name (full path of the file),
image position (defined in ImagePosition
), the xywh
bounds of the Widget
, and a scale flag.
If scaled
is set to true
, the image will be scaled within the Widget
bounds, and the
ImagePosition
will be ignored. Likewise, if set to false
, the image will be displayed for
the size of the image, and will be placed in the bounds of the Widget
based on the position
specified in the ImagePosition
.
pub fn get_texture_size(&self) -> Size
[src]
Returns the size of the texture.
Trait Implementations
impl Widget for ImageWidget
[src]
This is the Widget
implementation of the ImageWidget
. Image is rendered onto a 3D texture, then
copied to the canvas after rendering.
fn draw(
&mut self,
c: &mut Canvas<Window>,
t: &mut TextureCache
) -> Option<&Texture>
[src]
&mut self,
c: &mut Canvas<Window>,
t: &mut TextureCache
) -> Option<&Texture>
fn on_config_changed(&mut self, _k: u8, _v: Config)
[src]
Responds to a screen redraw only if the CONFIG_IMAGE_POSITION
key was changed.
fn as_any(&mut self) -> &mut dyn Any
[src]
This function is a macro-created getter function that returns the Widget
as an Any
type. This allows the Widget
trait to be downcast into a struct
that implements
the Widget
trait.
fn get_config(&mut self) -> &mut WidgetConfig
[src]
This function is a macro-created getter function that returns the Widget
's configuration
object as a borrowed mutable reference. This code is auto-generated using the
default_widget_properties!()
macro.
fn get_system_properties(&mut self) -> &mut HashMap<i32, String>
[src]
This function is a macro-created getter function that returns the Widget
's system
properties as a borrowed mutable reference. This code is auto-generated using the
default_widget_properties!()
macro.
fn get_callbacks(&mut self) -> &mut CallbackRegistry
[src]
This function is a macro-created getter function that returns the Widget
's
CallbackRegistry
object as a borrowed mutable reference. This code is auto-generated
using the default_widget_properties!()
macro.
fn tick_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
This function is a macro-created tick callback override, created by the
default_widget_callbacks!()
macro.
fn mouse_entered_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
This function is a macro-created mouse entered callback override, created by the
default_widget_callbacks!()
macro.
fn mouse_exited_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
This function is a macro-created mouse exited callback override, created by the
default_widget_callbacks!()
macro.
fn mouse_moved_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
This function is a macro-created mouse moved callback override, created by the
default_widget_callbacks!()
macro.
fn mouse_scrolled_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
This function is a macro-created mouse scrolled callback override, created by the
default_widget_callbacks!()
macro.
fn button_clicked_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
This function is a macro-created mouse scrolled callback override, created by the
default_widget_callbacks!()
macro.
fn mouse_entered(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_exited(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_moved(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn mouse_scrolled(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn button_clicked(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
fn tick(&mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer])
[src]
fn other_event(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
fn set_point(&mut self, config: u8, x: i32, y: i32)
[src]
fn set_color(&mut self, config: u8, color: Color)
[src]
fn set_numeric(&mut self, config: u8, value: i32)
[src]
fn set_text(&mut self, config: u8, text: String)
[src]
fn set_toggle(&mut self, config: u8, flag: bool)
[src]
fn set_compass(&mut self, config: u8, value: CompassPosition)
[src]
fn get_point(&mut self, k: u8) -> Points
[src]
fn get_size(&mut self, k: u8) -> Size
[src]
fn get_color(&mut self, k: u8) -> Color
[src]
fn get_numeric(&mut self, k: u8) -> i32
[src]
fn get_text(&mut self, k: u8) -> String
[src]
fn get_toggle(&mut self, k: u8) -> bool
[src]
fn get_compass(&mut self, k: u8) -> CompassPosition
[src]
fn set_origin(&mut self, _origin: Points)
[src]
fn set_size(&mut self, _size: Vec<u32>)
[src]
fn get_drawing_area(&mut self) -> Rect
[src]
fn is_invalidated(&mut self) -> bool
[src]
fn set_invalidated(&mut self, flag: bool)
[src]
Auto Trait Implementations
impl !RefUnwindSafe for ImageWidget
impl !Send for ImageWidget
impl !Sync for ImageWidget
impl Unpin for ImageWidget
impl !UnwindSafe for ImageWidget
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,