Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo in README.md #37

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix typo in README.md #37

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1ac7fc3
Fix typo in README.md
Spaceface16518 Feb 12, 2020
987d05f
Fix Format example
Spaceface16518 Feb 12, 2020
b9c686c
Fix formatting of bulleted paragraphs
Spaceface16518 Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ pub struct MyFormat;
#[derive(Serialize)]
pub struct Foo {}

impl Format for AmethystFOrmat {
impl Format for MyFormat {
type Data = Foo;

fn encode(dimensions: (u32, u32), sprites: &[SpriteAnchor]) -> Self::Data {
Expand All @@ -82,12 +82,10 @@ let meta = sheep::encode::<MyFormat>(&sprite_sheet);

Right now, there are two implementations to choose from:

- MAXRECTS (**recommended**)

- MAXRECTS (**recommended**)
Implementation of the maxrects sprite packing algorithm. The paper and original implementation used as a reference for this can be found [here](https://github.com/juj/RectangleBinPack). This algorithm should yield optimal results in most scenarios.

- simple

- simple
A naive implementation that will sort the sprites by area and then pack them all into a single texture. This won't scale very well since you can't limit the maximum size of the resulting sprite sheet, but can be quicker than maxrects in simple scenarios.

## Roadmap
Expand Down