topical media & game development
mobile-graphic-easel-src-easeljs-filters-ColorFilter.js / js
/*
* ColorFilter
* Visit http://createjs.com/ for documentation, updates and examples.
*
* Copyright (c) 2010 gskinner.com, inc.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
// namespace:
this.createjs = this.createjs||{};
(function() {
Applies color transforms.
See {{#crossLink "Filter"}}{{/crossLink}} for an example of how to apply filters.
@class ColorFilter
@constructor
@extends Filter
parameter: {Number} redMultiplier
parameter: {Number} greenMultiplier
parameter: {Number} blueMultiplier
parameter: {Number} alphaMultiplier
parameter: {Number} redOffset
parameter: {Number} greenOffset
parameter: {Number} blueOffset
parameter: {Number} alphaOffset
var ColorFilter = function(redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier, redOffset, greenOffset, blueOffset, alphaOffset) {
this.initialize(redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier, redOffset, greenOffset, blueOffset, alphaOffset);
}
var p = ColorFilter.prototype = new createjs.Filter();
// public properties:
Red channel multiplier.
@property redMultiplier
@type Number
p.redMultiplier = 1;
Green channel multiplier.
@property greenMultiplier
@type Number
p.greenMultiplier = 1;
Blue channel multiplier.
@property blueMultiplier
@type Number
p.blueMultiplier = 1;
Alpha channel multiplier.
@property redMultiplier
@type Number
p.alphaMultiplier = 1;
Red channel offset (added to value).
@property redOffset
@type Number
p.redOffset = 0;
Green channel offset (added to value).
@property greenOffset
@type Number
p.greenOffset = 0;
Blue channel offset (added to value).
@property blueOffset
@type Number
p.blueOffset = 0;
Alpha channel offset (added to value).
@property alphaOffset
@type Number
p.alphaOffset = 0;
// constructor:
Initialization method.
@method initialize
@protected
p.initialize = function(redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier, redOffset, greenOffset, blueOffset, alphaOffset) {
this.redMultiplier = redMultiplier != null ? redMultiplier : 1;
this.greenMultiplier = greenMultiplier != null ? greenMultiplier : 1;
this.blueMultiplier = blueMultiplier != null ? blueMultiplier : 1;
this.alphaMultiplier = alphaMultiplier != null ? alphaMultiplier : 1;
this.redOffset = redOffset || 0;
this.greenOffset = greenOffset || 0;
this.blueOffset = blueOffset || 0;
this.alphaOffset = alphaOffset || 0;
}
// public methods:
Applies the filter to the specified context.
@method applyFilter
parameter: {CanvasRenderingContext2D} ctx The 2D context to use as the source.
parameter: {Number} x The x position to use for the source rect.
parameter: {Number} y The y position to use for the source rect.
parameter: {Number} width The width to use for the source rect.
parameter: {Number} height The height to use for the source rect.
parameter: {CanvasRenderingContext2D} targetCtx Optional. The 2D context to draw the result to. Defaults to the context passed to ctx.
parameter: {Number} targetX Optional. The x position to draw the result to. Defaults to the value passed to x.
parameter: {Number} targetY Optional. The y position to draw the result to. Defaults to the value passed to y.
returns: {Boolean}
p.applyFilter = function(ctx, x, y, width, height, targetCtx, targetX, targetY) {
targetCtx = targetCtx || ctx;
if (targetX == null) { targetX = x; }
if (targetY == null) { targetY = y; }
try {
var imageData = ctx.getImageData(x, y, width, height);
} catch(e) {
//if (!this.suppressCrossDomainErrors) throw new Error("unable to access local image data: " + e);
return false;
}
var data = imageData.data;
var l = data.length;
for (var i=0; i<l; i+=4) {
data[i] = data[i]*this.redMultiplier+this.redOffset;
data[i+1] = data[i+1]*this.greenMultiplier+this.greenOffset;
data[i+2] = data[i+2]*this.blueMultiplier+this.blueOffset;
data[i+3] = data[i+3]*this.alphaMultiplier+this.alphaOffset;
}
imageData.data = data;
targetCtx.putImageData(imageData, targetX, targetY);
return true;
}
Returns a string representation of this object.
@method toString
returns: {String} a string representation of the instance.
p.toString = function() {
return "[ColorFilter]";
}
Returns a clone of this ColorFilter instance.
@method clone
returns: {ColorFilter} A clone of the current ColorFilter instance.
p.clone = function() {
return new ColorFilter(this.redMultiplier, this.greenMultiplier, this.blueMultiplier, this.alphaMultiplier, this.redOffset, this.greenOffset, this.blueOffset, this.alphaOffset);
}
createjs.ColorFilter = ColorFilter;
}());
(C) Æliens
04/09/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
