# image-sdf

> generate a signed distance field from an image

Latest version **1.0.4** (published 2015-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install image-sdf
pnpm add image-sdf
yarn add image-sdf
bun add image-sdf
```

Provides the command `image-sdf`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2015-02-20 |
| First published | 2014-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 234 |
| Author | Matt DesLauriers |
| Maintainers | mattdesl |
| Keywords | sdf, bitmap, bmp, png, img, jpg, image, signed, distance, field, text, alpha, test, fonts, webgl, gl, stackgl, glsl, shader |

## Links

- npm: https://www.npmjs.com/package/image-sdf
- Repository: https://github.com/mattdesl/image-sdf
- Issues: https://github.com/mattdesl/image-sdf/issues
- npm.io page: https://npm.io/package/image-sdf

## Dependencies (8)

- [clamp](https://npm.io/package/clamp.md) ^1.0.1
- [yargs](https://npm.io/package/yargs.md) ^1.3.3
- [ndarray](https://npm.io/package/ndarray.md) ^1.0.16
- [as-number](https://npm.io/package/as-number.md) ^1.0.0
- [get-pixels](https://npm.io/package/get-pixels.md) ^3.1.0
- [save-pixels](https://npm.io/package/save-pixels.md) ^2.2.0
- [color-string](https://npm.io/package/color-string.md) ^0.2.1
- [typedarray-pool](https://npm.io/package/typedarray-pool.md) ^1.1.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2015-02-20
- 1.0.3 — 2014-12-11
- 1.0.2 — 2014-12-11
- 1.0.1 — 2014-12-11

## README

# image-sdf

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

Command-line tool which takes a 4-channel RGBA image and generates a signed distance field. The bitmask is determined by pixels with alpha over 128 and any RGB channel over 128.

![img1](http://i.imgur.com/36wtCMa.png)

```sh
# install the tool
npm install image-sdf -g

# apply the effect on an image
# and pipe it to a new file
image-sdf atlas.png --spread 32 --downscale 2 > atlas-sdf.png
```

The code has been adpated from [libgdx](https://github.com/libgdx/libgdx/blob/master/extensions/gdx-tools/src/com/badlogic/gdx/tools/distancefield/DistanceFieldGenerator.java).

PRs welcome. This could be split into more modules (generating a bit mask, computing SDF, better image support, etc).

## Usage

[![NPM](https://nodei.co/npm/image-sdf.png)](https://nodei.co/npm/image-sdf/)

```
image-sdf input.png [opt]

Options:
  -o, --output     output file                                    
  -s, --spread     distance spread amount, default 1              
  -d, --downscale  amount to downscale the output, default 1      
  -c, --color      output color, accepts css strings, default #fff
  -h               Show help                                      
```

Examples:

```
image-sdf input.png -c "rgb(128,255,20)" -s 10 -o output.png
image-sdf input.png --spread 2 --downscale 2 > output.png
image-sdf input.png --color black -o build/output.png
```

The programmatic API may evolve into their own modules, i.e. for custom bitmasks.

## License

MIT, see [LICENSE.md](http://github.com/mattdesl/image-sdf/blob/master/LICENSE.md) for details.

---
_Source: https://npm.io/package/image-sdf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._