Skip to content

Commit

Permalink
made sure that the docs are not all over the place in terms of wordin…
Browse files Browse the repository at this point in the history
…g for this feature
  • Loading branch information
CommanderStorm committed Sep 25, 2024
1 parent b62ddd3 commit 947bc6e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/src/sources-sprites.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ martin --sprite /path/to/sprite_a --sprite /path/to/other/sprite_b
```

To use generate Signed Distance Fields (SDFs) images instead, the `--make_sdf` Option can be added.
SDF-Images allow their color to be set at runtime in the map redering engine.
SDF Images allow their color to be set at runtime in the map rendering engine.

```bash
martin --sprite /path/to/sprite_a --sprite /path/to/other/sprite_b --make_sdf
Expand All @@ -78,8 +78,8 @@ sprites:
sources:
# SVG images in this directory will be published under the sprite_id "my_sprites"
my_sprites: /path/to/some_dir
# This tells Martin to handle images in directories as Signed Distance Fields (SDFs)
# SDF-Images allow their color to be set at runtime in the map redering engine.
# Tells Martin to handle sprites as Signed Distance Fields (SDFs)
# SDF Images allow their color to be set at runtime in the map rendering engine.
# Defaults to `false`.
make_sdf: false
```
Expand Down
4 changes: 2 additions & 2 deletions martin/src/args/root.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ pub struct ExtraArgs {
/// Export a directory with SVG files as a sprite source. Can be specified multiple times.
#[arg(short, long)]
pub sprite: Vec<PathBuf>,
/// tells Martin to handle images in directories as Signed Distance Fields (SDFs)
/// Images handled as a SDF allow their color to be set at runtime in the map redering enines.
/// Tells Martin to handle sprites as Signed Distance Fields (SDFs)
/// SDF Images allow their color to be set at runtime in the map rendering engine.
///
/// Defaults to `false`.
#[arg(long)]
Expand Down
8 changes: 4 additions & 4 deletions martin/src/sprites/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ pub type SpriteCatalog = BTreeMap<String, CatalogSpriteEntry>;

#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct SpriteConfig {
/// This tells Martin to handle images in directories as Signed Distance Fields (SDFs)
/// Images are handled as a signed-distance field (SDF) allow their color to be set at runtime in the map redering enines.
/// Tells Martin to handle sprites as Signed Distance Fields (SDFs)
/// SDF Images allow their color to be set at runtime in the map rendering engine.
///
/// Defaults to `false`.
pub make_sdf: bool,
Expand All @@ -78,8 +78,8 @@ impl ConfigExtras for SpriteConfig {
#[derive(Debug, Clone, Default)]
pub struct SpriteSources {
sources: HashMap<String, SpriteSource>,
/// This tells Martin to handle images in directories as Signed Distance Fields (SDFs)
/// Images are handled as a signed-distance field (SDF) allow their color to be set at runtime in the map redering enines.
/// Tells Martin to handle sprites as Signed Distance Fields (SDFs)
/// SDF Images allow their color to be set at runtime in the map rendering engine.
///
/// Defaults to `false`.
make_sdf: bool,
Expand Down

0 comments on commit 947bc6e

Please sign in to comment.