From 7d97c1de0b752d74e4806760ef50f0cad2b1483c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-Philippe=20C=C3=B4t=C3=A9?= <jp@cote.cc>
Date: Fri, 6 Jun 2014 21:16:57 -0400
Subject: [PATCH 1/2] Added autoUpdate functionality.

When 'autoUpdate' is enabled, the mask will be automatically re-applied whenever the display list changes.
---
 .../pixelmask/PixelMaskDisplayObject.as       | 461 ++++++++++--------
 1 file changed, 259 insertions(+), 202 deletions(-)

diff --git a/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as b/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
index 657c0fc..7c7d267 100644
--- a/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
+++ b/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
@@ -1,206 +1,263 @@
-package starling.extensions.pixelmask
-{
-	import flash.display3D.Context3DBlendFactor;
-	import flash.geom.Matrix;
-	
-	import starling.core.RenderSupport;
-	import starling.core.Starling;
-	import starling.display.BlendMode;
-	import starling.display.DisplayObject;
-	import starling.display.DisplayObjectContainer;
-	import starling.display.Image;
-	import starling.events.Event;
-	import starling.textures.RenderTexture;
-	
-	public class PixelMaskDisplayObject extends DisplayObjectContainer
-	{
-		private static const MASK_MODE_NORMAL:String = "mask";
-		private static const MASK_MODE_INVERTED:String = "maskinverted";
-		
-		private var _mask:DisplayObject;
-		private var _renderTexture:RenderTexture;
-		private var _maskRenderTexture:RenderTexture;
-		
-		private var _image:Image;
-		private var _maskImage:Image;
-		
-		private var _superRenderFlag:Boolean = false;
-		private var _inverted:Boolean = false;
-		private var _scaleFactor:Number;
-		private var _isAnimated:Boolean = true;
-		private var _maskRendered:Boolean = false;
-		
-		public function PixelMaskDisplayObject(scaleFactor:Number=-1, isAnimated:Boolean=true)
-		{
-			super();			
-			
-			_isAnimated = isAnimated;
-			_scaleFactor = scaleFactor;
-			
-			BlendMode.register(MASK_MODE_NORMAL, Context3DBlendFactor.ZERO, Context3DBlendFactor.SOURCE_ALPHA);
-			BlendMode.register(MASK_MODE_INVERTED, Context3DBlendFactor.ZERO, Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA);
-			
-			// Handle lost context. By using the conventional event, we can make a weak listener.  
-			// This avoids memory leaks when people forget to call "dispose" on the object.
-			Starling.current.stage3D.addEventListener(Event.CONTEXT3D_CREATE, 
-				onContextCreated, false, 0, true);
-		}
-		
+package starling.extensions.pixelmask
+{
+	import flash.display3D.Context3DBlendFactor;
+	import flash.geom.Matrix;
+	
+	import starling.core.RenderSupport;
+	import starling.core.Starling;
+	import starling.display.BlendMode;
+	import starling.display.DisplayObject;
+	import starling.display.DisplayObjectContainer;
+	import starling.display.Image;
+	import starling.events.Event;
+	import starling.textures.RenderTexture;
+	
+	public class PixelMaskDisplayObject extends DisplayObjectContainer
+	{
+		private static const MASK_MODE_NORMAL:String = "mask";
+		private static const MASK_MODE_INVERTED:String = "maskinverted";
+		
+		private var _mask:DisplayObject;
+		private var _renderTexture:RenderTexture;
+		private var _maskRenderTexture:RenderTexture;
+		
+		private var _image:Image;
+		private var _maskImage:Image;
+		
+		private var _superRenderFlag:Boolean = false;
+		private var _inverted:Boolean = false;
+		private var _scaleFactor:Number;
+		private var _isAnimated:Boolean = true;
+		private var _autoUpdate:Boolean = true;
+		private var _maskRendered:Boolean = false;
+		
+		public function PixelMaskDisplayObject(
+			scaleFactor:Number=-1, 
+			isAnimated:Boolean=true, 
+			autoUpdate:Boolean=true
+		)
+		{
+			super();			
+			
+			_scaleFactor = scaleFactor;
+			_isAnimated = isAnimated;
+			_autoUpdate = autoUpdate;
+			
+			BlendMode.register(MASK_MODE_NORMAL, Context3DBlendFactor.ZERO, Context3DBlendFactor.SOURCE_ALPHA);
+			BlendMode.register(MASK_MODE_INVERTED, Context3DBlendFactor.ZERO, Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA);
+			
+			// Handle lost context. By using the conventional event, we can make a weak listener.  
+			// This avoids memory leaks when people forget to call "dispose" on the object.
+			Starling.current.stage3D.addEventListener(Event.CONTEXT3D_CREATE, 
+				onContextCreated, false, 0, true);
+		}
+		
 		public function get isAnimated():Boolean
-		{
-			return _isAnimated;
-		}
-
+		{
+			return _isAnimated;
+		}
+
 		public function set isAnimated(value:Boolean):void
-		{
-			_isAnimated = value;
-		}
-
-		override public function dispose():void
-		{
-			clearRenderTextures();
-			Starling.current.stage3D.removeEventListener(Event.CONTEXT3D_CREATE, onContextCreated);
-			super.dispose();
-		}
-		
-		private function onContextCreated(event:Object):void
-		{
-			refreshRenderTextures();
-		}
-
+		{
+			_isAnimated = value;
+		}
+		
+		public function get autoUpdate():Boolean
+		{
+			return _autoUpdate;
+		}
+
+		public function set autoUpdate(value:Boolean):void
+		{
+			_autoUpdate = value;
+		}
+
+		override public function dispose():void
+		{
+			clearRenderTextures();
+			Starling.current.stage3D.removeEventListener(Event.CONTEXT3D_CREATE, onContextCreated);
+			super.dispose();
+		}
+		
+		private function onContextCreated(event:Object):void
+		{
+			refreshRenderTextures();
+		}
+
 		public function get inverted():Boolean
-		{
-			return _inverted;
-		}
-
+		{
+			return _inverted;
+		}
+
 		public function set inverted(value:Boolean):void
-		{
-			_inverted = value;
-			refreshRenderTextures(null);
-		}
-
-		public function set mask(mask:DisplayObject) : void
-		{
-			
-			// clean up existing mask if there is one
-			if (_mask) {
-				_mask = null;
-			}
-			
-			if (mask) {
-				_mask = mask;				
-				
-				if (_mask.width==0 || _mask.height==0) {
-					throw new Error ("Mask must have dimensions. Current dimensions are " + _mask.width + "x" + _mask.height + ".");
-				}
-				
-				refreshRenderTextures(null);
-			} else {
-				clearRenderTextures();
-			}
-		}
-		
-		private function clearRenderTextures() : void
-		{
-			// clean up old render textures and images
-			if (_maskRenderTexture) {
-				_maskRenderTexture.dispose();
-			}
-			
-			if (_renderTexture) {
-				_renderTexture.dispose();
-			}
-			
-			if (_image) {
-				_image.dispose();
-			}
-			
-			if (_maskImage) {
-				_maskImage.dispose();
-			}
-		}
-		
-		private function refreshRenderTextures(e:Event=null) : void
-		{
-			if (_mask) {
-				
-				clearRenderTextures();
-				
-				_maskRenderTexture = new RenderTexture(_mask.width, _mask.height, false, _scaleFactor);
-				_renderTexture = new RenderTexture(_mask.width, _mask.height, false, _scaleFactor);
-				
-				// create image with the new render texture
-				_image = new Image(_renderTexture);
-				
-				// create image to blit the mask onto
-				_maskImage = new Image(_maskRenderTexture);
-			
-				// set the blending mode to MASK (ZERO, SRC_ALPHA)
-				if (_inverted) {
-					_maskImage.blendMode = MASK_MODE_INVERTED;
-				} else {
-					_maskImage.blendMode = MASK_MODE_NORMAL;
-				}
-			}
-			_maskRendered = false;
-		}
-		
-		public override function render(support:RenderSupport, parentAlpha:Number):void
-		{
-			if (_isAnimated || (!_isAnimated && !_maskRendered)) {
-				if (_superRenderFlag || !_mask) {
-					super.render(support, parentAlpha);
-				} else {			
-					if (_mask) {					 
-						_maskRenderTexture.draw(_mask);
-						_renderTexture.drawBundled(drawRenderTextures);				
-						_image.render(support, parentAlpha);
-						_maskRendered = true;
-					}
-				}
-			} else {
-				_image.render(support, parentAlpha);
-			}
-		}
-		
-		private static var _a:Number;
-		private static var _b:Number;
-		private static var _c:Number;
-		private static var _d:Number;
-		private static var _tx:Number;
-		private static var _ty:Number;
-		
-		private function drawRenderTextures(object:DisplayObject=null, matrix:Matrix=null, alpha:Number=1.0) : void
-		{
-			_a = this.transformationMatrix.a;
-			_b = this.transformationMatrix.b;
-			_c = this.transformationMatrix.c;
-			_d = this.transformationMatrix.d;
-			
-			_tx = this.transformationMatrix.tx;
-			_ty = this.transformationMatrix.ty;
-			
-			this.transformationMatrix.a = 1;
-			this.transformationMatrix.b = 0;
-			this.transformationMatrix.c = 0;
-			this.transformationMatrix.d = 1;
-			
-			this.transformationMatrix.tx = 0;
-			this.transformationMatrix.ty = 0;
-			
-			_superRenderFlag = true;			
-			_renderTexture.draw(this);
-			_superRenderFlag = false;
-			
-			this.transformationMatrix.a = _a;
-			this.transformationMatrix.b = _b;
-			this.transformationMatrix.c = _c;
-			this.transformationMatrix.d = _d;
-			
-			this.transformationMatrix.tx = _tx;
-			this.transformationMatrix.ty = _ty;
-			
-			_renderTexture.draw(_maskImage);
-		}
-	}
-}
\ No newline at end of file
+		{
+			_inverted = value;
+			refreshRenderTextures(null);
+		}
+
+		public function set mask(mask:DisplayObject) : void
+		{
+			
+			// clean up existing mask if there is one
+			if (_mask) {
+				_mask = null;
+			}
+			
+			if (mask) {
+				_mask = mask;				
+				
+				if (_mask.width==0 || _mask.height==0) {
+					throw new Error ("Mask must have dimensions. Current dimensions are " + _mask.width + "x" + _mask.height + ".");
+				}
+				
+				refreshRenderTextures(null);
+			} else {
+				clearRenderTextures();
+			}
+		}
+		
+		private function clearRenderTextures() : void
+		{
+			// clean up old render textures and images
+			if (_maskRenderTexture) {
+				_maskRenderTexture.dispose();
+			}
+			
+			if (_renderTexture) {
+				_renderTexture.dispose();
+			}
+			
+			if (_image) {
+				_image.dispose();
+			}
+			
+			if (_maskImage) {
+				_maskImage.dispose();
+			}
+		}
+		
+		private function refreshRenderTextures(e:Event=null) : void
+		{
+			if (_mask) {
+				
+				clearRenderTextures();
+				
+				_maskRenderTexture = new RenderTexture(_mask.width, _mask.height, false, _scaleFactor);
+				_renderTexture = new RenderTexture(_mask.width, _mask.height, false, _scaleFactor);
+				
+				// create image with the new render texture
+				_image = new Image(_renderTexture);
+				
+				// create image to blit the mask onto
+				_maskImage = new Image(_maskRenderTexture);
+			
+				// set the blending mode to MASK (ZERO, SRC_ALPHA)
+				if (_inverted) {
+					_maskImage.blendMode = MASK_MODE_INVERTED;
+				} else {
+					_maskImage.blendMode = MASK_MODE_NORMAL;
+				}
+			}
+			_maskRendered = false;
+		}
+		
+		public override function render(support:RenderSupport, parentAlpha:Number):void
+		{
+			if (_isAnimated || (!_isAnimated && !_maskRendered)) {
+				if (_superRenderFlag || !_mask) {
+					super.render(support, parentAlpha);
+				} else {			
+					if (_mask) {					 
+						_maskRenderTexture.draw(_mask);
+						_renderTexture.drawBundled(drawRenderTextures);				
+						_image.render(support, parentAlpha);
+						_maskRendered = true;
+					}
+				}
+			} else {
+				_image.render(support, parentAlpha);
+			}
+		}
+		
+		private static var _a:Number;
+		private static var _b:Number;
+		private static var _c:Number;
+		private static var _d:Number;
+		private static var _tx:Number;
+		private static var _ty:Number;
+		
+		private function drawRenderTextures(object:DisplayObject=null, matrix:Matrix=null, alpha:Number=1.0) : void
+		{
+			_a = this.transformationMatrix.a;
+			_b = this.transformationMatrix.b;
+			_c = this.transformationMatrix.c;
+			_d = this.transformationMatrix.d;
+			
+			_tx = this.transformationMatrix.tx;
+			_ty = this.transformationMatrix.ty;
+			
+			this.transformationMatrix.a = 1;
+			this.transformationMatrix.b = 0;
+			this.transformationMatrix.c = 0;
+			this.transformationMatrix.d = 1;
+			
+			this.transformationMatrix.tx = 0;
+			this.transformationMatrix.ty = 0;
+			
+			_superRenderFlag = true;			
+			_renderTexture.draw(this);
+			_superRenderFlag = false;
+			
+			this.transformationMatrix.a = _a;
+			this.transformationMatrix.b = _b;
+			this.transformationMatrix.c = _c;
+			this.transformationMatrix.d = _d;
+			
+			this.transformationMatrix.tx = _tx;
+			this.transformationMatrix.ty = _ty;
+			
+			_renderTexture.draw(_maskImage);
+		}
+		
+		override public function addChild(child:DisplayObject):DisplayObject {
+			var r:DisplayObject = super.addChild(child);
+			_autoUpdate && refreshRenderTextures(null);
+			return r;
+		}
+		
+		override public function addChildAt(child:DisplayObject, index:int):DisplayObject {
+			var r:DisplayObject = super.addChildAt(child, index);
+			_autoUpdate && refreshRenderTextures(null);
+			return r;
+		}
+		
+		override public function removeChild(child:DisplayObject, dispose:Boolean=false):DisplayObject {
+			var r:DisplayObject = super.removeChild(child, dispose);
+			_autoUpdate && refreshRenderTextures(null);
+			return r;
+		}
+		
+		override public function removeChildAt(index:int, dispose:Boolean=false):DisplayObject {
+			var r:DisplayObject = super.removeChildAt(index, dispose);
+			_autoUpdate && refreshRenderTextures(null);
+			return r;
+		}
+		
+		override public function setChildIndex(child:DisplayObject, index:int):void {
+			super.setChildIndex(child, index);
+			_autoUpdate && refreshRenderTextures(null);
+		}
+		
+		override public function swapChildren(child1:DisplayObject, child2:DisplayObject):void {
+			super.swapChildren(child1, child2);
+			_autoUpdate && refreshRenderTextures(null);
+		}
+		
+		override public function swapChildrenAt(index1:int, index2:int):void {
+			super.swapChildrenAt(index1, index2);
+			_autoUpdate && refreshRenderTextures(null);
+		}
+		
+	}
+	
+}

From 67635dcc18e3c48d8370f94837ff8b47dd0a09df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-Philippe=20C=C3=B4t=C3=A9?= <jp@cote.cc>
Date: Fri, 6 Jun 2014 21:24:06 -0400
Subject: [PATCH 2/2] autoUpdate is disabled by default

I figured it would probably be better this way for backwards-compatibility.
---
 src/starling/extensions/pixelmask/PixelMaskDisplayObject.as | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as b/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
index 7c7d267..0b1d68d 100644
--- a/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
+++ b/src/starling/extensions/pixelmask/PixelMaskDisplayObject.as
@@ -28,13 +28,13 @@ package starling.extensions.pixelmask
 		private var _inverted:Boolean = false;
 		private var _scaleFactor:Number;
 		private var _isAnimated:Boolean = true;
-		private var _autoUpdate:Boolean = true;
+		private var _autoUpdate:Boolean = false;
 		private var _maskRendered:Boolean = false;
 		
 		public function PixelMaskDisplayObject(
 			scaleFactor:Number=-1, 
 			isAnimated:Boolean=true, 
-			autoUpdate:Boolean=true
+			autoUpdate:Boolean=false
 		)
 		{
 			super();