1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
//! Draw sprites quickly using a masking color or an alpha treshold.
//!
//! # [Interactive Demo](https://tversteeg.nl/blit/showcase)
//!
//! This crate works with RGBA `u32` buffers.
//! The alpha channel can only be read with a singular treshold, converting it to a binary transparent or opaque color.
//! The reason this limitation is in place is that it allows efficient rendering optimizations.
//!
//! For ergonomic use of this crate without needing to type convert everything most functions accepting numbers are generic with the number types being [`num_traits::ToPrimitive`], this might seem confusing but any number can be passed to these functions immediately.
//!
//! When using this crate the most important function to know about is [`Blit::blit`], which is implemented for [`BlitBuffer`].
//!
//! # Example
//!
//! ```
//! # #[cfg(feature = "image")] mod test {
//! use blit::{Blit, ToBlitBuffer, BlitOptions, geom::Size};
//!
//! const CANVAS_SIZE: Size = Size { width: 180, height: 180 };
//! const MASK_COLOR: u32 = 0xFF_00_FF;
//! # fn main() {
//! // Create a buffer in which we'll draw our image
//! let mut canvas: Vec<u32> = vec![0xFF_FF_FF_FF; CANVAS_SIZE.pixels()];
//!
//! // Load the image from disk using the `image` crate
//! let img = image::open("examples/smiley_rgb.png").unwrap().into_rgb8();
//!
//! // Blit by creating a special blitting buffer first where the MASK_COLOR will be the color that will be made transparent
//! let blit_buffer = img.to_blit_buffer_with_mask_color(MASK_COLOR);
//!
//! // Draw the image 2 times to the buffer
//! blit_buffer.blit(&mut canvas, CANVAS_SIZE, &BlitOptions::new_position(10, 10));
//! blit_buffer.blit(&mut canvas, CANVAS_SIZE, &BlitOptions::new_position(20, 20));
//! # }}
//! ```
pub mod geom;
#[cfg(feature = "image")]
mod image;
pub mod slice;
mod view;
/// Commonly used imports.
///
/// ```rust
/// use blit::prelude::*;
/// ```
pub mod prelude {
#[cfg(feature = "image")]
pub use crate::ToBlitBuffer;
pub use crate::{
geom::{Size, SubRect},
slice::Slice,
Blit, BlitBuffer,
};
}
use geom::{Size, SubRect};
use std::ops::Range;
use num_traits::ToPrimitive;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use slice::{Slice, SliceProjection};
use view::ImageView;
/// Internal representation of a color.
type Color = u32;
/// Blit functions that can be called from multiple places.
pub trait Blit {
/// Draw the source input on the destination image.
///
/// See [`BlitOptions`] for multiple ways of drawing the image.
///
/// The pixels will be drawn to the destination buffer in RGBA format.
fn blit(&self, dst: &mut [u32], dst_size: Size, options: &BlitOptions);
}
/// Convert external image types to a specialized buffer optimized for blitting.
///
/// Can be used to create a custom implementation if you want different image or other formats.
pub trait ToBlitBuffer {
/// Convert the image to a custom `BlitBuffer` type which is optimized for applying the blitting operations.
///
/// It's assumed that the alpha channel in the resulting pixel is properly set.
/// The alpha treshold is the offset point at which an alpha value will be used as either a transparent pixel or a colored one.
fn to_blit_buffer_with_alpha(&self, alpha_treshold: u8) -> BlitBuffer;
/// Convert the image to a custom `BlitBuffer` type which is optimized for applying the blitting operations.
///
/// Ignore the alpha channel if set and use only a single color for transparency.
fn to_blit_buffer_with_mask_color(&self, mask_color: u32) -> BlitBuffer;
}
/// How, where and which part of the image to render.
///
/// Slices can be used to control which part gets scaled using tiling scaling.
#[derive(Debug, Default, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct BlitOptions {
/// Horizontal position on the destination buffer.
pub x: i32,
/// Vertical position on the destination buffer.
pub y: i32,
/// 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.
///
/// ```rust
/// # use blit::BlitOptions;
/// 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))
/// );
/// ```
pub area: Option<Size>,
/// 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.
pub sub_rect: 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)`.
pub mask: Option<SubRect>,
/// 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.
pub vertical_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.
pub horizontal_slice: Option<Slice>,
}
impl BlitOptions {
/// Setup options for blitting at position `(0, 0)`.
///
/// When no other fields are changed or methods are called this will render the full source.
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// 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)
///
/// - [`BlitOptions::x`]
/// - [`BlitOptions::y`]
#[must_use]
pub fn new_position<X, Y>(x: X, y: Y) -> Self
where
X: ToPrimitive,
Y: ToPrimitive,
{
let (x, y) = (x.to_i32().unwrap_or(0), y.to_i32().unwrap_or(0));
Self {
x,
y,
..Default::default()
}
}
/// 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)
///
/// - [`BlitOptions::x`]
/// - [`BlitOptions::y`]
#[must_use]
pub fn new_position_tuple<X, Y>((x, y): (X, Y)) -> Self
where
X: ToPrimitive,
Y: ToPrimitive,
{
let (x, y) = (x.to_i32().unwrap_or(0), y.to_i32().unwrap_or(0));
Self {
x,
y,
..Default::default()
}
}
/// 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`]
#[must_use]
pub fn with_area<S>(mut self, area: S) -> Self
where
S: Into<Size>,
{
self.set_area(area.into());
self
}
/// Set the size of the area `(width, height)` to only show on the destination buffer.
///
/// # Sets field(s)
///
/// - [`BlitOptions::mask`]
#[must_use]
pub fn with_mask<R>(mut self, mask: R) -> Self
where
R: Into<SubRect>,
{
self.set_mask(mask.into());
self
}
/// 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`
#[must_use]
pub fn with_sub_rect<R>(mut self, sub_rect: R) -> Self
where
R: Into<SubRect>,
{
self.set_sub_rect(sub_rect.into());
self
}
/// Draw as a scalable [9-slice graphic](https://en.wikipedia.org/wiki/9-slice_scaling).
///
/// 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)
///
/// - [`BlitOptions::vertical_slice`]
/// - [`BlitOptions::horizontal_slice`]
#[must_use]
pub fn with_slice9<R>(mut self, center: R) -> Self
where
R: Into<SubRect>,
{
self.set_slice9(center);
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`]
pub fn with_horizontal_slice(mut self, slice: Slice) -> Self {
self.horizontal_slice = Some(slice);
self
}
/// Scale a single vertical piece of the buffer while keeping the other parts the same height.
///
/// # Sets field(s)
///
/// - [`BlitOptions::vertical_slice`]
pub fn with_vertical_slice(mut self, slice: Slice) -> Self {
self.vertical_slice = Some(slice);
self
}
/// Set the render position on the target `(x, y)`.
///
/// # Sets field(s)
///
/// - [`BlitOptions::x`]
/// - [`BlitOptions::y`]
#[must_use]
pub fn with_position<X, Y>(mut self, x: X, y: Y) -> Self
where
X: ToPrimitive,
Y: ToPrimitive,
{
self.x = x.to_i32().unwrap_or_default();
self.y = y.to_i32().unwrap_or_default();
self
}
/// Set the position `(x, y)`.
///
/// # Sets field(s)
///
/// - [`BlitOptions::x`]
/// - [`BlitOptions::y`]
pub fn set_position<P>(&mut self, position: P)
where
P: Into<(i32, i32)>,
{
let (x, y) = position.into();
self.x = x;
self.y = y;
}
/// Get the position `(x, y)`.
pub fn position(&self) -> (i32, i32) {
(self.x, self.y)
}
/// Get the destination area `(width, height)`.
///
/// If [`BlitOptions::area`] is `None` the size of the source will be returned.
pub fn area<S>(&self, source_size: S) -> Size
where
S: Into<Size>,
{
self.area.unwrap_or(source_size.into())
}
/// 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`
pub fn set_sub_rect<R>(&mut self, sub_rect: R)
where
R: Into<SubRect>,
{
let sub_rect = sub_rect.into();
self.sub_rect = Some(sub_rect);
// Don't tile the image when only the subrectangle is set
if self.area.is_none() {
self.area = Some(sub_rect.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.
pub fn sub_rect<S>(&self, source_size: S) -> SubRect
where
S: Into<Size>,
{
// Get the sub rectangle defined or from the source
let mut sub_rect = self
.sub_rect
.unwrap_or_else(|| SubRect::from_size(source_size));
// The sub rectangle is never allowed to be bigger than the area
sub_rect.size = match self.area {
Some(area) => sub_rect.size.min(area),
None => sub_rect.size,
};
sub_rect
}
/// 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`]
pub fn set_area<S>(&mut self, area: S)
where
S: Into<Size>,
{
self.area = Some(area.into());
}
/// Draw as a scalable [9-slice graphic](https://en.wikipedia.org/wiki/9-slice_scaling).
///
/// 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)
///
/// - [`BlitOptions::vertical_slice`]
/// - [`BlitOptions::horizontal_slice`]
pub fn set_slice9<R>(&mut self, center: R)
where
R: Into<SubRect>,
{
let center = center.into();
self.vertical_slice = Some(Slice::ternary(center.x, center.right()));
self.horizontal_slice = Some(Slice::ternary(center.y, center.bottom()));
}
/// Set the size of the area `(width, height)` to only show on the destination buffer.
///
/// # Sets field(s)
///
/// - [`BlitOptions::mask`]
pub fn set_mask<R>(&mut self, mask: R)
where
R: Into<SubRect>,
{
self.mask = Some(mask.into());
}
/// 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`]
pub fn set_horizontal_slice(&mut self, slice: Slice) {
self.horizontal_slice = Some(slice);
}
/// Scale a single vertical piece of the buffer while keeping the other parts the same height.
///
/// # Sets field(s)
///
/// - [`BlitOptions::vertical_slice`]
pub fn set_vertical_slice(&mut self, slice: Slice) {
self.vertical_slice = Some(slice);
}
}
/// A data structure holding a color and a mask buffer to make blitting on a buffer real fast.
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Clone)]
pub struct BlitBuffer {
/// Image size in pixels.
size: Size,
/// Vector of colors, the highest 8 bits are alpha and the remaining 24 bits the RGB color channels.
data: Vec<Color>,
}
impl BlitBuffer {
/// Create a instance from a buffer of RGBA data packed in a single `u32`.
///
/// It's assumed that the alpha channel in the resulting pixel is properly set.
/// The alpha treshold is the offset point at which an alpha value will be used as either a transparent pixel or a colored one.
#[must_use]
pub fn from_buffer<S>(src: &[Color], width: S, alpha_treshold: u8) -> Self
where
S: ToPrimitive,
{
Self::from_iter(src.iter().copied(), width, alpha_treshold)
}
/// Create a instance from a iterator of RGBA data packed in a single `u32`.
///
/// It's assumed that the alpha channel in the resulting pixel is properly set.
/// The alpha treshold is the offset point at which an alpha value will be used as either a transparent pixel or a colored one.
#[must_use]
pub fn from_iter<I, S>(iter: I, width: S, alpha_treshold: u8) -> Self
where
I: Iterator<Item = Color>,
S: ToPrimitive,
{
// Shift the alpha to the highest bits so we can do a direct comparison without needing to shift every pixel again
let alpha_treshold = (alpha_treshold as Color) << 24;
// Create the data buffer filled with transparent pixels
let data = iter
.map(|pixel| {
if pixel < alpha_treshold {
0x00_00_00_00
} else {
pixel | 0xFF_00_00_00
}
})
.collect::<Vec<_>>();
// We can calculate the height from the total buffer
let size = Size::from_len(data.len(), width.to_usize().unwrap_or_default());
Self { size, data }
}
/// Width of the buffer in pixels.
pub fn width(&self) -> u32 {
self.size.width
}
/// Height of the buffer in pixels.
pub fn height(&self) -> u32 {
self.size.height
}
/// Size of the blitbuffer in pixels.
pub fn size(&self) -> Size {
self.size
}
/// Get a reference to the pixel data.
pub fn pixels(&self) -> &[Color] {
&self.data
}
/// Get a mutable reference to the pixel data.
pub fn pixels_mut(&mut self) -> &mut [Color] {
&mut self.data
}
/// Divide the target area into given slices of rectangles to draw.
///
/// A `(source, target)` rectangle tuple is returned.
fn slice_projections(
&self,
options: &BlitOptions,
target_area: Size,
) -> Vec<(SubRect, SubRect)> {
match (options.vertical_slice, options.horizontal_slice) {
// No slices, so no need to split it
(None, None) => Vec::new(),
// Only a horizontal slice
(None, Some(horizontal)) => horizontal
.divide_area_iter(self.height(), target_area.height)
.map(|horizontal| horizontal.into_sub_rects_static_x(self.width()))
.collect(),
// Only a vertical slice
(Some(vertical), None) => vertical
.divide_area_iter(self.width(), target_area.width)
.map(|vertical| vertical.into_sub_rects_static_y(self.height()))
.collect(),
// The buffer is split both horizontally and vertically
(Some(vertical), Some(horizontal)) => {
let horizontal_ranges = vertical
.divide_area_iter(self.width(), target_area.width)
.collect::<Vec<_>>();
let vertical_ranges =
horizontal.divide_area_iter(self.height(), target_area.height);
// Return a cartesian product of all ranges
vertical_ranges
.flat_map(|vertical| {
horizontal_ranges.iter().map(move |horizontal| {
SliceProjection::combine_into_sub_rects(horizontal, &vertical)
})
})
.collect()
}
}
}
/// Blit a sliced section.
fn blit_slice(&self, dst: &mut [u32], dst_size: Size, options: &BlitOptions) {
// If the size of the image is the same as our buffer and the location is zero we can completely blit all bytes
if options.x == 0 && options.y == 0 && dst_size == self.size {
let pixels = dst_size.pixels();
self.blit_horizontal(dst, 0..pixels, 0..pixels);
return;
}
// Convert the destination to view so we can calculate with it
let dst_view = ImageView::full(dst_size);
// Convert our source to a view
let src_view = ImageView::full(self.size);
// Find a view on the dst based on the area
let area = options.area(self.size);
let mut dst_area = match dst_view.sub_i32(options.x, options.y, area) {
Some(dst_area) => dst_area,
None => return,
};
// Another view based on the subrectangle
let mut sub_rect_view = match src_view.sub(options.sub_rect(self.size)) {
Some(sub_rect_view) => sub_rect_view,
None => return,
};
// We can draw the image exactly
if sub_rect_view.size() == area {
if let Some(mask) = options.mask {
let (prev_x, prev_y) = dst_area.coord();
// Clip the dst view on the mask area first
dst_area = dst_area.clip(mask);
// When it's fully clipped do nothing
if dst_area.width() == 0 || dst_area.height() == 0 {
return;
}
// How much coordinates got offset changed
let (new_x, new_y) = dst_area.coord();
// Shift the UV coords of the sub rect view
sub_rect_view.0.x = (sub_rect_view.0.x + new_x - prev_x).max(0);
sub_rect_view.0.y = (sub_rect_view.0.y + new_y - prev_y).max(0);
sub_rect_view.0.size.width = dst_area.width();
sub_rect_view.0.size.height = dst_area.height();
}
// Pixel range of the source
sub_rect_view
.parent_ranges_iter(self.size)
// Zipped with pixel range of the destination
.zip(dst_area.parent_ranges_iter(dst_size))
.for_each(|(src_range, dst_range)| self.blit_horizontal(dst, dst_range, src_range));
} else {
// Recursively call this function with a new area defined by the sub rectangle to tile
// Amount of tiles we need to fully render
let tiles = area / sub_rect_view.size();
let remainder = area % sub_rect_view.size();
for tile_x in 0..tiles.width {
// Fully render the filled tiles
for tile_y in 0..tiles.height {
let mut new_options = BlitOptions::new_position(
options.x + (tile_x * sub_rect_view.width()) as i32,
options.y + (tile_y * sub_rect_view.height()) as i32,
)
.with_sub_rect(sub_rect_view.as_sub_rect());
new_options.mask = options.mask;
self.blit_slice(dst, dst_size, &new_options);
}
if remainder.height > 0 {
// Render the horizontal remainder
let mut new_options = BlitOptions::new_position(
options.x + (tile_x * sub_rect_view.width()) as i32,
options.y + (tiles.height * sub_rect_view.height()) as i32,
)
.with_sub_rect(sub_rect_view.as_sub_rect())
.with_area((sub_rect_view.width(), remainder.height));
new_options.mask = options.mask;
self.blit_slice(dst, dst_size, &new_options);
}
}
if remainder.width > 0 {
// Render the vertical remainder
for tile_y in 0..tiles.height {
let mut new_options = BlitOptions::new_position(
options.x + (tiles.width * sub_rect_view.width()) as i32,
options.y + (tile_y * sub_rect_view.height()) as i32,
)
.with_sub_rect(sub_rect_view.as_sub_rect())
.with_area((remainder.width, sub_rect_view.height()));
new_options.mask = options.mask;
self.blit_slice(dst, dst_size, &new_options);
}
if remainder.height > 0 {
// Render the single leftover remainder
let mut new_options = BlitOptions::new_position(
options.x + (tiles.width * sub_rect_view.width()) as i32,
options.y + (tiles.height * sub_rect_view.height()) as i32,
)
.with_sub_rect(sub_rect_view.as_sub_rect())
.with_area(remainder);
new_options.mask = options.mask;
self.blit_slice(dst, dst_size, &new_options);
}
}
}
}
/// Blit a horizontal strip.
fn blit_horizontal(&self, dst: &mut [u32], dst_index: Range<usize>, blit_index: Range<usize>) {
// Same size iterators over both our buffer and the output buffer
let blit_iter = self.data[blit_index].iter();
let dst_iter = dst[dst_index].iter_mut();
// Blit each pixel
dst_iter.zip(blit_iter).for_each(|(dst_pixel, blit_pixel)| {
*dst_pixel = Self::blit_pixel(*dst_pixel, *blit_pixel);
});
}
/// Blit a single pixel.
///
/// The main logic of calculating the resulting color that needs to be drawn.
#[inline(always)]
fn blit_pixel(dst_pixel: Color, blit_pixel: Color) -> Color {
// Set the pixel from the blit image if the mask value is set
if (blit_pixel >> 24) > 0 {
// Pixel from the blit buffer is not masked, use it
blit_pixel
} else {
// Pixel from the blit buffer is masked, use the original color
dst_pixel
}
}
}
impl Blit for BlitBuffer {
fn blit(&self, dst: &mut [u32], dst_size: Size, options: &BlitOptions) {
// TODO: remove this clone
let mut options = options.clone();
// Clip if any of the dimensions are negative
if options.x.is_negative() || options.y.is_negative() {
// Get the position with the negative dimensions clipped
let (new_x, new_y) = (options.x.max(0), options.y.max(0));
// Value is not 0 when any of the dimensions is clipped
let (diff_x, diff_y) = ((new_x - options.x) as u32, (new_y - options.y) as u32);
// Use the existing sub rectangle or create one
let mut sub_rect = options
.sub_rect
.unwrap_or_else(|| SubRect::from_size(self.size()));
if diff_x > sub_rect.size.width || diff_y > sub_rect.size.height {
// Nothing to render, image is fully clipped
return;
}
// Offset the sub rectangle with the clipped area
sub_rect.x += diff_x as i32;
sub_rect.y += diff_y as i32;
sub_rect.size.width -= diff_x;
sub_rect.size.height -= diff_y;
options.set_sub_rect(sub_rect);
options.x = new_x;
options.y = new_y;
}
// Get the total area we need to draw the slices in
let area = options.area(self.size);
// Which slices do we need to draw if any
let slice_projections = self.slice_projections(&options, area);
if slice_projections.is_empty() {
// Render without projections
self.blit_slice(dst, dst_size, &options);
} else {
// Loop over each slice
slice_projections.into_iter().for_each(|(source, target)| {
let mut slice_options = options
.clone()
// Move the position to which part of the slice we need to draw
.with_position(options.x + target.x, options.y + target.y)
.with_area(target.size);
// Move the already existing subrectangle if applicable
slice_options.set_sub_rect(if let Some(sub_rect) = options.sub_rect {
sub_rect.shift(source.x, source.y)
} else {
source
});
self.blit_slice(dst, dst_size, &slice_options)
});
}
}
}
impl std::fmt::Debug for BlitBuffer {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("BlitBuffer")
.field("width", &self.size.width)
.field("height", &self.size.height)
.finish()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn exact_fit() {
let mut buffer = [0xFF, 0xFF_00, 0xFF_00_00, 0xFF, 0xFF_00, 0xFF_00_00];
// The last number should be masked
let blit = BlitBuffer::from_buffer(
&[
0xFF_00_00_AA,
0xFF_00_AA_00,
0xFF_AA_00_00,
0xBB,
0xBB,
0xBB,
],
2,
127,
);
blit.blit(
&mut buffer,
Size::new(2, 3),
&BlitOptions::new_position(0, 0),
);
// Create a copy but cast the u32 to a i32
let expected = [
0xAA | 0xFF_00_00_00,
0xAA_00 | 0xFF_00_00_00,
0xAA_00_00 | 0xFF_00_00_00,
0xFF,
0xFF_00,
0xFF_00_00,
];
assert_eq!(
buffer, expected,
"\nResult:\n{:08x?}\nExpected:\n{:08x?}",
&buffer, &expected
);
}
}