Struct tetra::graphics::ui::NineSlice

pub struct NineSlice { /* fields omitted */ }

A panel made up of nine slices of an image. Useful for panels with borders.

Note that NineSlice does not currently support the clip DrawParam.

Examples

The nineslice example demonstrates how to draw a NineSlice panel.

Implementations

impl NineSlice

pub fn new(
    texture: Texture,
    width: f32,
    height: f32,
    fill_rect: Rectangle
) -> NineSlice

Creates a new panel from the given texture.

The fill_rect is used to determine how to slice the texture - it should be set to the region of the texture that represents the center of the panel.

pub fn texture(&self) -> &Texture

Returns a reference to the underlying texture for the panel.

pub fn set_texture(&mut self, texture: Texture)

Sets the underlying texture for the panel.

This will not adjust the way that the texture is sliced, so you may need to also call set_fill_rect.

pub fn width(&self) -> f32

Gets the width of the panel.

pub fn set_width(&mut self, width: f32)

Sets the width of the panel.

pub fn height(&self) -> f32

Gets the height of the panel.

pub fn set_height(&mut self, height: f32)

Sets the height of the panel.

pub fn size(&self) -> (f32, f32)

Gets the size of the panel.

pub fn set_size(&mut self, width: f32, height: f32)

Sets the size of the panel.

pub fn fill_rect(&self) -> &Rectangle

Gets the section of the texture that is being used to fill the center of the panel.

pub fn set_fill_rect(&mut self, fill_rect: Rectangle)

Sets the section of the texture that should fill the center of the panel.

Trait Implementations

impl Clone for NineSlice

fn clone(&self) -> NineSlice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NineSlice

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

Formats the value using the given formatter.

impl Drawable for NineSlice

fn draw<P>(&self, ctx: &mut Context, params: P) where
    P: Into<DrawParams>, 

Draws self to the screen (or a canvas, if one is enabled), using the specified parameters.