forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Clarify index order in TextureAtlas::from_grid (#6058)

Browse Source 
# Objective

Docs on from_grid/from_grid_with_padding aren't clear on indexing order.

## Solution

Make the docs better!
This commit is contained in:
pcone 2022-09-22 17:44:24 +00:00
parent 527dce9a69
commit e668b47277
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/bevy_sprite/src/texture_atlas.rs
View File

@ -68,7 +68,8 @@ impl TextureAtlas {
} }
/// Generate a `TextureAtlas` by splitting a texture into a grid where each /// Generate a `TextureAtlas` by splitting a texture into a grid where each
/// `tile_size` by `tile_size` grid-cell is one of the textures in the atlas /// `tile_size` by `tile_size` grid-cell is one of the textures in the
/// atlas. Resulting `TextureAtlas` is indexed left to right, top to bottom.
pub fn from_grid( pub fn from_grid(
texture: Handle<Image>, texture: Handle<Image>,
tile_size: Vec2, tile_size: Vec2,
@ -81,7 +82,8 @@ impl TextureAtlas {
/// Generate a `TextureAtlas` by splitting a texture into a grid where each /// Generate a `TextureAtlas` by splitting a texture into a grid where each
/// `tile_size` by `tile_size` grid-cell is one of the textures in the /// `tile_size` by `tile_size` grid-cell is one of the textures in the
/// atlas. Grid cells are separated by some `padding`, and the grid starts /// atlas. Grid cells are separated by some `padding`, and the grid starts
/// at `offset` pixels from the top left corner. /// at `offset` pixels from the top left corner. Resulting `TextureAtlas` is
/// indexed left to right, top to bottom.
pub fn from_grid_with_padding( pub fn from_grid_with_padding(
texture: Handle<Image>, texture: Handle<Image>,
tile_size: Vec2, tile_size: Vec2,