Skip to content

Commit

Permalink
docs: made sure that a pitfall of make_sdf is documented (#85)
Browse files Browse the repository at this point in the history
  • Loading branch information
CommanderStorm authored Oct 20, 2024
1 parent 8ddf0d2 commit 02d3e76
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/sprite/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,10 @@ impl SpritesheetBuilder {
self
}

/// Add metadata to indicate that all images are SDF sprites.
///
/// You have to ensure that the sprites are created as an SDF file beforehand. See
/// [`Sprite::new_sdf`] for further context.
pub fn make_sdf(&mut self) -> &mut Self {
self.sdf = true;
self
Expand Down

0 comments on commit 02d3e76

Please sign in to comment.