Struct blit::BlitOptions

source ·

pub struct BlitOptions {
    pub x: i32,
    pub y: i32,
    pub area: Option<Size>,
    pub sub_rect: Option<SubRect>,
    pub mask: Option<SubRect>,
    pub vertical_slice: Option<Slice>,
    pub horizontal_slice: Option<Slice>,
}

Expand description

How, where and which part of the image to render.

Slices can be used to control which part gets scaled using tiling scaling.

Fields§

§x: i32

Horizontal position on the destination buffer.

§y: i32

Vertical position on the destination buffer.

§area: Option<Size>

Size of the area (width, height) on the destination buffer.

When None is used, the size of the source buffer or of the subrectangle if set will be used.
When the area is smaller than the source buffer it effectively functions as the width and height parameters of BlitOptions::sub_rect.
When the area is bigger than the source buffer the default behaviour will be tiling.

assert_eq!(
    BlitOptions::default().with_area((10, 10)).sub_rect((100, 100)),
    BlitOptions::default().with_sub_rect((0, 0, 10, 10)).sub_rect((100, 100))
);

§sub_rect: Option<SubRect>

Which part of the source buffer to render.

When None is used, (0, 0, source_width, source_height) is set instead.
With Some(..), the values in the tuple are (x, y, width, height).

This is similar to UV coordinates but instead of relative positions in the range of 0..1 this takes absolute positions in the range 0..width for horizontal positions and 0..height for vertical positions.

§mask: Option<SubRect>

Which part of the target buffer to render.

When None is used, (0, 0, target_width, target_height) is set instead.
With Some(..), the values in the tuple are (x, y, width, height).

§vertical_slice: Option<Slice>

Divide the source buffer into multiple vertical sections and repeat the chosen section to fill the area.

This is only used when BlitOptions::area is set.

§horizontal_slice: Option<Slice>

Divide the source buffer into multiple horizontal sections and repeat the chosen section to fill the area.

This is only used when BlitOptions::area is set.

Implementations§

source §

impl BlitOptions

source

pub fn new() -> Self

Setup options for blitting at position (0, 0).

When no other fields are changed or methods are called this will render the full source.

source

pub fn new_position<X, Y>(x: X, y: Y) -> Self
where X: ToPrimitive, Y: ToPrimitive,

Setup options for blitting at position (x, y).

When no other fields are changed or methods are called this will render the full source.

§Sets field(s)

source

pub fn new_position_tuple<X, Y>((x, y): (X, Y)) -> Self
where X: ToPrimitive, Y: ToPrimitive,

Setup options for blitting at position (x, y).

When no other fields are changed or methods are called this will render the full source.

§Sets field(s)

source

pub fn with_area<S>(self, area: S) -> Self
where S: Into<Size>,

Set the size of the area (width, height) on the destination buffer.

When the area is smaller than the source buffer it effectively functions as the width and height parameters of BlitOptions::sub_rect.
When the area is bigger than the source buffer the default behaviour will be tiling.

§Sets field(s)

BlitOptions::area

source

pub fn with_mask<R>(self, mask: R) -> Self
where R: Into<SubRect>,

Set the size of the area (width, height) to only show on the destination buffer.

§Sets field(s)

BlitOptions::mask

source

pub fn with_sub_rect<R>(self, sub_rect: R) -> Self
where R: Into<SubRect>,

Set which part of the source buffer to render.

When None is used, (0, 0, source_width, source_height) is set instead.
With Some(..), the values in the tuple are (x, y, width, height).

This is similar to UV coordinates but instead of relative positions in the range of 0..1 this takes absolute positions in the range 0..width for horizontal positions and 0..height for vertical positions.

§Sets field(s)

BlitOptions::sub_rect
BlitOptions::area to (width, height) if it’s None

source

pub fn with_slice9<R>(self, center: R) -> Self
where R: Into<SubRect>,

Draw as a scalable 9-slice graphic.

The sub-rectangle of the center piece that will be scaled needs to be passed. Note that the rectangle has a width and a height instead of the absolute coordinates the other slice functions accept.

§Sets field(s)

source

pub fn with_horizontal_slice(self, slice: Slice) -> Self

Scale a single horizontal piece of the buffer while keeping the other parts the same height.

See crate::slice::Slice for more information.

§Sets field(s)

BlitOptions::horizontal_slice

source

pub fn with_vertical_slice(self, slice: Slice) -> Self

Scale a single vertical piece of the buffer while keeping the other parts the same height.

§Sets field(s)

BlitOptions::vertical_slice

source

pub fn with_position<X, Y>(self, x: X, y: Y) -> Self
where X: ToPrimitive, Y: ToPrimitive,

Set the render position on the target (x, y).

§Sets field(s)

source

pub fn set_position(&mut self, position: P)
where P: Into<(i32, i32)>,

Set the position (x, y).

§Sets field(s)

source

pub fn position(&self) -> (i32, i32)

Get the position (x, y).

source

pub fn area<S>(&self, source_size: S) -> Size
where S: Into<Size>,

Get the destination area (width, height).

If BlitOptions::area is None the size of the source will be returned.

source

pub fn set_sub_rect<R>(&mut self, sub_rect: R)
where R: Into<SubRect>,

Set which part of the source buffer to render.

When None is used, (0, 0, source_width, source_height) is set instead.
With Some(..), the values in the tuple are (x, y, width, height).

This is similar to UV coordinates but instead of relative positions in the range of 0..1 this takes absolute positions in the range 0..width for horizontal positions and 0..height for vertical positions.

§Sets field(s)

BlitOptions::sub_rect
BlitOptions::area to (width, height) if it’s None

source

pub fn sub_rect<S>(&self, source_size: S) -> SubRect
where S: Into<Size>,

Get the source area sub rectangle (x, y, width, height).

If BlitOptions::sub_rect is None the size of the source will be returned with (0, 0) as the position.
If BlitOptions::sub_rect and BlitOptions::area are set it, the width and height will be shrunk to match those of the area.

source

pub fn set_area<S>(&mut self, area: S)
where S: Into<Size>,

Set the size of the area (width, height) on the destination buffer.

When the area is smaller than the source buffer it effectively functions as the width and height parameters of BlitOptions::sub_rect.
When the area is bigger than the source buffer the default behaviour will be tiling.

§Sets field(s)

BlitOptions::area

source

pub fn set_slice9<R>(&mut self, center: R)
where R: Into<SubRect>,

Draw as a scalable 9-slice graphic.

The sub-rectangle of the center piece that will be scaled needs to be passed. Note that the rectangle has a width and a height instead of the absolute coordinates the other slice functions accept.