0.0.1 • Published 8 years ago

canvas-filter v0.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
8 years ago

CanvasFilter

Canvas filters using imageData

Very simply API to apply filters on a HTML5 canvas element

Usage

Using JSPM (ECMAScript / ES6 Module)

install

jspm install github:casperlamboo/CanvasFilter

include in your project

import Shape from 'casperlamboo/CanvasFilter';

Using NPM (CommonJS module)

install

npm install canvas-filter

include in your project

var Shape = require('canvas-filter');

API

Filter

Filter accepts one optional argument, canvas. This is the canvas the filter is applied on.

filter = new Filter([ canvas ]);

canvas = HTML5Canvas;

setCanvas

Filter = filter.setCanvas(canvas);

canvas = HTML5Canvas;

setSize

Filter = filter.setSize(width, height);

width = Int;
height = Int;

grayScale

Filter = filter.grayScale(r = 0.2126, g = 0.7152, b = 0.0722);

width = Int;
height = Int;

highPass

Filter = filter.highPass(threshold);

threshold = Int;

lowPass

Filter = filter.lowPass(threshold);

threshold = Int;

lowHighPass

Filter = filter.lowHighPass(minThreshold, maxTreshold);

minThreshold = Int;
maxTreshold = Int;

floodFill

Filter = filter.floodfill(x, y, tolerance, [ { fillColor, edgeColor, backgroundColor } ]);

x = Int;
y = Int;
tolerance = Int;
fillColor = Color;
edgeColor = Color;
backgroundColor = Color;

Color = { r: Int, g: Int, b: Int, a: Int };

threshold

Filter = filter.threshold(threshold);

threshold = Int;

getPixel

Color = filter.getPixel(x, y);

x = Int;
y = Int;
Color = { r: Int, g: Int, b: Int, a: Int };

apply

Filter = filter.apply();

copy

Filter = filter.copy(Filter);

clone

Filter = filter.clone();