topical media & game development

talk show tell print

mobile-graphic-easel-src-easeljs-filters-ColorMatrixFilter.js / js



  /*
  * ColorMatrixFilter
  * 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() {
  
  
Allows you to carry out complex color operations such as modifying saturation, brightness, or inverting. See the {{#crossLink "ColorMatrix"}}{{/crossLink}} for more information on changing colors. See {{#crossLink "Filter"}}{{/crossLink}} for an example of how to apply filters. @class ColorMatrixFilter @constructor @extends Filter
parameter: {Array} matrix A 4x5 matrix describing the color operation to perform. See also the ColorMatrix class.

  
  var ColorMatrixFilter = function(matrix) {
    this.initialize(matrix);
  }
  var p = ColorMatrixFilter.prototype = new createjs.Filter();
  
  // public properties:
          p.matrix = null;
          
  // constructor:
          // TODO: detailed docs.
          
@method initialize @protected
parameter: {Array} matrix A 4x5 matrix describing the color operation to perform.

  
          p.initialize = function(matrix) {
                  this.matrix = matrix;
          }
  
  // 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;
                  var r,g,b,a;
                  var mtx = this.matrix;
                  var m0 =  mtx[0],  m1 =  mtx[1],  m2 =  mtx[2],  m3 =  mtx[3],  m4 =  mtx[4];
                  var m5 =  mtx[5],  m6 =  mtx[6],  m7 =  mtx[7],  m8 =  mtx[8],  m9 =  mtx[9];
                  var m10 = mtx[10], m11 = mtx[11], m12 = mtx[12], m13 = mtx[13], m14 = mtx[14];
                  var m15 = mtx[15], m16 = mtx[16], m17 = mtx[17], m18 = mtx[18], m19 = mtx[19];
                  
                  for (var i=0; i<l; i+=4) {
                          r = data[i];
                          g = data[i+1];
                          b = data[i+2];
                          a = data[i+3];
                          data[i] = r*m0+g*m1+b*m2+a*m3+m4; // red
                          data[i+1] = r*m5+g*m6+b*m7+a*m8+m9; // green
                          data[i+2] = r*m10+g*m11+b*m12+a*m13+m14; // blue
                          data[i+3] = r*m15+g*m16+b*m17+a*m18+m19; // alpha
                  }
                  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 "[ColorMatrixFilter]";
          }
          
          
          
Returns a clone of this ColorMatrixFilter instance. @method clone
returns: {ColorMatrixFilter} A clone of the current ColorMatrixFilter instance.

  
          p.clone = function() {
                  return new ColorMatrixFilter(this.matrix);
          }
          
  createjs.ColorMatrixFilter = ColorMatrixFilter;
  }());


(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.