# Guillotière

<p align="center">
  <a href="https://crates.io/crates/guillotiere">
      <img src="https://img.shields.io/crates/v/guillotiere.svg" alt="crates.io">
  </a>
  <a href="https://github.com/nical/guillotiere/actions">
      <img src="https://github.com/nical/guillotiere/actions/workflows/main.yml/badge.svg" alt="Build Status">
  </a>
  <a href="https://docs.rs/guillotiere">
      <img src="https://docs.rs/guillotiere/badge.svg" alt="documentation">
  </a>

</p>

A dynamic texture atlas allocator with fast deallocation and rectangle coalescing.

## Motivation

The ability to dynamically batch textures together is important for some graphics rendering scenarios (for example [WebRender](https://github.com/servo/webrender)).
A challenging aspect of dynamic atlas allocation is the need to coalesce free rectangles after deallocation to defragment the available space.
Some atlas allocators perform this task by examining all possible pairs of free rectangles and test if they can be merged, which is prohibitively expensive for real-time applications.

Guillotière solves this problem by internally maintaining a data structure that allows constant time access to neighbor rectangles and greatly speeds up the coalesing operation.

The details of how this works are explained in the [`AtlasAllocator` documentation](https://docs.rs/guillotiere/*/guillotiere/struct.AtlasAllocator.html).

## Example

```rust
use guillotiere::*;

let mut atlas = AtlasAllocator::new(size2(1000, 1000));

let a = atlas.allocate(size2(100, 1000)).unwrap();
let b = atlas.allocate(size2(900, 200)).unwrap();

atlas.deallocate(a.id);

let c = atlas.allocate(size2(300, 200)).unwrap();

assert_eq!(c.rectangle, atlas[c.id]);

atlas.deallocate(c.id);
atlas.deallocate(b.id);
```

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/license/mit)

at your option.

