https://github.com/tversteeg/blit

:space_invader: Blitting library for 2D sprites
https://github.com/tversteeg/blit

2d-graphics 2d-sprites gamedev rust sprites

Last synced: 4 days ago
JSON representation

:space_invader: Blitting library for 2D sprites

• Host: GitHub
• URL: https://github.com/tversteeg/blit
• Owner: tversteeg
• License: gpl-3.0
• Created: 2018-01-06T20:39:51.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T20:18:56.000Z (4 months ago)
• Last Synced: 2024-10-06T07:09:47.556Z (about 2 months ago)
• Topics: 2d-graphics, 2d-sprites, gamedev, rust, sprites
• Language: Rust
• Homepage: https://tversteeg.nl/blit/showcase
• Size: 54.4 MB
• Stars: 30
• Watchers: 2
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# blit

[![Build Status](https://github.com/tversteeg/blit/workflows/CI/badge.svg)](https://github.com/tversteeg/blit/actions?workflow=CI)

[![Crates.io](https://img.shields.io/crates/v/blit.svg)](https://crates.io/crates/blit)

[![Documentation](https://docs.rs/blit/badge.svg)](https://docs.rs/blit)

[![License: GPL-3.0](https://img.shields.io/crates/l/blit.svg)](#license)

[![Downloads](https://img.shields.io/crates/d/blit.svg)](#downloads)

### [Documentation](https://docs.rs/blit/)

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

```rust

use blit::{Blit, ToBlitBuffer, BlitOptions, geom::Size};

const CANVAS_SIZE: Size = Size { width: 180, height: 180 };

const MASK_COLOR: u32 = 0xFF_00_FF;

// Create a buffer in which we'll draw our image

let mut canvas: Vec = 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));

```