Socket
Socket
Sign inDemoInstall

lens-core

Package Overview
Dependencies
1
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    lens-core

Core module for lens-filter


Version published
Weekly downloads
2
Maintainers
1
Created
Weekly downloads
 

Readme

Source

npm version

lens-core

Small library that relies on webworkers to apply image transformations.

There are several modules that use lens-core, check them on the filters folder on the lens repo.

But you can easily create your own transformation function and rely on lens-core to handle the webworkers and to split the work.

Install

npm install lens-core --save

Methods

getCanvas()

It returns a canvas with the given width and height

import { getCanvas } from 'lens-core';

const canvas = getCanvas(100, 100);

convertImageDataToCanvasURL()

Given a ImageData it returns the dataURL

import { convertImageDataToCanvasURL } from 'lens-core';

const canvasURL = convertImageDataToCanvasURL(imageData);

applyFilters()

Provide the ImageData, the transformation function, the options to be passed to the transformation function and the number of workers to split the work.

import { applyFilters } from 'lens-core';

applyFilters({ 
    data: 'image-data', 
    transform: transformationFunction, 
    options: {},  // options that are passed to the transformation function
    nWorkers: 4 // number of webworkers to transform the image
}).then(imageData => {
    // Do whatever you want with imageData
});

How to create a custom transformation function?

The transform function receives ImageData, the length of data to transform and the options that the developer provided to image-fiter-core, example transformation function for the threshold effect:

const transform = ({ data, length, options }) => {
    for (let i = 0; i < length; i += 4) {
        const r = data[i];
        const g = data[i + 1];
        const b = data[i + 2];
        const v = (0.2126 * r + 0.7152 * g + 0.0722 * b >= options.level) ? 255 : 0;
        data[i] = data[i + 1] = data[i + 2] = v;
    }

    return data;
};

Keywords

FAQs

Last updated on 10 Jun 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc