Struct suzy::platform::opengl::SlicedImage

pub struct SlicedImage { /* fields omitted */ }

A common graphic used for user interfaces, a sliced image is defined by fixed-sized corners and an inner area which stretches to fill the graphic area.

See the Wikipedia article on 9-slice scaling for more information.

Implementations

impl SlicedImage

pub fn new() -> Self

Create a new SlicedImage.

pub fn set_image<P>(&mut self, texture: Texture, padding: &P) where
    P: Padding2d, 

Set the texture used by this graphic. The given padding describes the sliced area.

Trait Implementations

impl Default for SlicedImage

fn default() -> Self

Returns the “default value” for a type.

impl Graphic<OpenGlRenderPlatform> for SlicedImage

fn draw(&mut self, ctx: &mut DrawContext<'_, OpenGlRenderPlatform>)

Draw this graphic.

impl Rect for SlicedImage

fn x(&self) -> Dim

Get the x dimension of the rectangle.

fn y(&self) -> Dim

Get the y dimension of the rectangle.

fn x_mut<F, R>(&mut self, f: F) -> R where
    F: FnOnce(&mut Dim) -> R, 

Apply a transfomation to the x dimension of the rectangle.

fn y_mut<F, R>(&mut self, f: F) -> R where
    F: FnOnce(&mut Dim) -> R, 

Apply a transfomation to the y dimension of the rectangle.

fn left(&self) -> f32

Get the left edge of the rectangle

fn set_left(&mut self, value: f32)

Set the left edge of the rect and for it to grow to the right

fn right(&self) -> f32

Get the right edge of the rectangle

fn set_right(&mut self, value: f32)

Set the right edge of the rect and for it to grow to the left

fn bottom(&self) -> f32

Get the bottom edge of the rectangle

fn set_bottom(&mut self, value: f32)

Set the bottom edge of the rect and for it to grow upwards

fn top(&self) -> f32

Get the top edge of the rectangle

fn set_top(&mut self, value: f32)

Set the top edge of the rect and for it to grow downwards

fn center_x(&self) -> f32

Get the horizontal center of the rect

fn set_center_x(&mut self, value: f32)

Set the horizontal center of the rect and for it to grow evenly wider

fn center_y(&self) -> f32

Get the vertical center of the rect

fn set_center_y(&mut self, value: f32)

Set the vertical center of the rect and for it to grow evenly taller

fn center(&self) -> (f32, f32)

Get the center of the rect

fn set_center(&mut self, value: (f32, f32))

Set the center of the rect and for it to grow evenly outwards

fn width(&self) -> f32

Get the width of the rectangle

fn set_width(&mut self, value: f32)

Set the width of the rectangle

fn height(&self) -> f32

Get the height of the rectangle

fn set_height(&mut self, value: f32)

Set the height of the rectangle

fn pivot(&self) -> (f32, f32)

Set the pivot. A pivot of (0.5, 0.5) indicates that a rect will grow from it’s center, whereas a pivot of (0, 0) indicates that a rect will grow from it’s bottom left corner.

fn set_pivot(&mut self, value: (f32, f32))

Set the pivot. A pivot of (0.5, 0.5) indicates that a rect will grow from it’s center, whereas a pivot of (0, 0) indicates that a rect will grow from it’s bottom left corner.

fn pivot_pos(&self) -> (f32, f32)

Get the global position of the pivot of the rectangle

fn set_pivot_pos(&mut self, value: (f32, f32))

Set the global position of the pivot of the rectangle

fn area(&self) -> f32

Get the area of the rectangle

fn aspect(&self) -> f32

Get the aspect ratio of this rectangle (width / height) Note: this may be a non-normal number

fn contains(&self, point: (f32, f32)) -> bool

Check if a point is inside the rectangle

fn set_fill_width<R: ?Sized>(&mut self, other: &R, padding: Padding) where
    R: Rect, 

Calculate the width and horizontal position of this rect based on another rect and some padding

fn set_fill_height<R: ?Sized>(&mut self, other: &R, padding: Padding) where
    R: Rect, 

Calculate the height and vertical position of this rect based on another rect and some padding

fn set_fill<R: ?Sized, P: ?Sized>(&mut self, other: &R, padding: &P) where
    R: Rect,
    P: Padding2d, 

Calculate the size and position of this rect based on another rect and some padding

fn shrink_to_aspect(&mut self, aspect: f32)

Shink one of the lengths of this rect so that the rect’s aspect ratio becomes the one provided

fn grow_to_aspect(&mut self, aspect: f32)

Expand one of the lengths of this rect so that the rect’s aspect ratio becomes the one provided

fn surrounds<R: Rect + ?Sized>(&self, other: &R) -> bool

Check if another rect is completely contained within this one

fn overlaps<R: Rect + ?Sized>(&self, other: &R) -> bool

Check if this rect overlaps at all with another