npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fastsdf

v0.0.11

Published

This package provides a simple way to generate Signed Distance Fields (SDFs) and other distance-based fields from images using WebGPU.

Downloads

69

Readme

FastSDF

This package provides a simple way to generate Signed Distance Fields (SDFs) and other distance-based fields from images using WebGPU.

Installation

You can install this package using npm:

npm install fastsdf

Usage

Here are basic examples of how to use the main functions:

import { generateSDF, generateDF, generateNearestNeighbourMap } from 'fastsdf';

// Load the source image
const srcImg = new Image();
srcImg.onload = async () => {
  // Generate a Signed Distance Field
  const sdfCanvas = await generateSDF(srcImg, 0.5, 10, 0.25);
  document.body.appendChild(sdfCanvas);

  // Generate a Distance Field
  const dfCanvas = await generateDF(srcImg, 0.5, false, 10);
  document.body.appendChild(dfCanvas);

  // Generate a Nearest Neighbour Map
  const nnMap = await generateNearestNeighbourMap(srcImg, 0.5);
  // Use nnMap as needed
};
srcImg.src = 'path/to/your/image.png';

API

generateSDF(src: HTMLImageElement | HTMLCanvasElement, srcAlphaThreshold: number, maxDistance: number, dstAlphaThreshold: number): Promise<HTMLCanvasElement>

Generates a Signed Distance Field from the input image.

  • src: The source image as an HTMLImageElement or HTMLCanvasElement.
  • srcAlphaThreshold: The alpha threshold for the source image.
  • maxDistance: The maximum distance to consider for the SDF.
  • dstAlphaThreshold: The threshold for the destination alpha channel.
  • Returns: A Promise that resolves to an HTMLCanvasElement containing the generated SDF.

generateDF(src: HTMLImageElement | HTMLCanvasElement, srcAlphaThreshold: number, inverseAlpha: boolean, maxDistance: number): Promise<HTMLCanvasElement>

Generates a Distance Field from the input image.

  • src: The source image as an HTMLImageElement or HTMLCanvasElement.
  • srcAlphaThreshold: The alpha threshold for the source image.
  • inverseAlpha: Whether to invert the alpha channel.
  • maxDistance: The maximum distance to consider for the DF.
  • Returns: A Promise that resolves to an HTMLCanvasElement containing the generated DF.

generateNearestNeighbourMap(src: HTMLImageElement | HTMLCanvasElement, srcAlphaThreshold: number): Promise<FloatField>

Generates a Nearest Neighbour Map from the input image.

  • src: The source image as an HTMLImageElement or HTMLCanvasElement.
  • srcAlphaThreshold: The alpha threshold for the source image.
  • Returns: A Promise that resolves to a FloatField containing the Nearest Neighbour Map.

How it works

The functions use WebGPU to efficiently generate various distance-based fields from the input image. The process involves:

  1. Initializing a Computron and JFACompute instance.
  2. Creating seed maps from the input image.
  3. Computing the required fields using Jump Flooding Algorithm (JFA).
  4. Generating the final output (SDF, DF, or Nearest Neighbour Map).

Notes

  • This package requires WebGPU support in the browser.
  • The input image should be loaded before calling the functions.
  • All main functions return Promises, so make sure to use await or .then() when calling them.
  • The generated fields are returned as HTMLCanvasElement or FloatField, depending on the function.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues

If you find a bug or have a suggestion, please file an issue on the GitHub repository.