@saschazar/wasm-mean-color
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

npm

📦 WebAssembly mean-color calculator

A dependency-free mean-color calculator written in WebAssembly

It calculates the mean color from raw RGB/A image data in a Uint8Array and returns a hex string.

Installation

yarn add @saschazar/wasm-mean-color

or

npm install --save @saschazar/wasm-mean-color

Usage

It supports usage in the browser, in a Web Worker and of course Node.js.

// Node.js
import wasm_mean_color from '@saschazar/wasm-mean-color';

// Web Worker - see: https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts
importScripts('wasm_mean_color.js');

// -------- Browser/Web Worker/Node.js code below --------

// Load raw RGB/A image data in Uint8Array (e.g. consistently chained [R][G][B] data)
const array = new Uint8Array(['some', 'raw', 'RGB', 'image', 'data']);

// Initialize the WebAssembly Module
const meanColorModule = wasm_mean_color({
  onRuntimeInitialized() {
    const channels = 3; // 3 if image has 3 color channels (RGB), 4 if image has an additional alpha channel (RGBA)
    console.log(meanColorModule.getColor(array, array.length, channels)); // returns e.g. '#FAFAFA'
  },
});

Example

A working example is available on RunKit.

License

Licensed under the MIT license.

Copyright ©️ 2020—2021 Sascha Zarhuber

Package Sidebar

Install

npm i @saschazar/wasm-mean-color

Weekly Downloads

10

Version

3.0.0

License

MIT

Unpacked Size

75.6 kB

Total Files

7

Last publish

Collaborators

  • saschazar21