Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-24 13:43:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #4301 from tfelix/feat-invert-geo-mask

Browse source 
Adds invertAlpha flag to GeometryMask
This commit is contained in:
Richard Davey 2019-01-23 21:52:16 +00:00 committed by GitHub
commit 87a83d4ff8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
src/display/mask/GeometryMask.js
View file

@ -9,9 +9,9 @@ var Class = require('../../utils/Class');
/** /**
* @classdesc * @classdesc
* A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect a visible pixel from the geometry mask. The mask is essentially a clipping path which can only make a masked pixel fully visible or fully invisible without changing its alpha (opacity). * A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect a visible pixel from the geometry mask. The mask is essentially a clipping path which can only make a masked pixel fully visible or fully invisible without changing its alpha (opacity).
* *
* A Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s) should be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed if the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and alpha of the pixel from the Geometry Mask do not matter. * A Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s) should be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed if the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and alpha of the pixel from the Geometry Mask do not matter.
* *
* The Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects. Moving or transforming the underlying Graphics object will change the mask (and affect the visibility of any masked objects), whereas moving or transforming a masked object will not affect the mask. You can think of the Geometry Mask (or rather, of the its Graphics object) as an invisible curtain placed in front of all masked objects which has its own visual properties and, naturally, respects the camera's visual properties, but isn't affected by and doesn't follow the masked objects by itself. * The Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects. Moving or transforming the underlying Graphics object will change the mask (and affect the visibility of any masked objects), whereas moving or transforming a masked object will not affect the mask. You can think of the Geometry Mask (or rather, of the its Graphics object) as an invisible curtain placed in front of all masked objects which has its own visual properties and, naturally, respects the camera's visual properties, but isn't affected by and doesn't follow the masked objects by itself.
* *
* @class GeometryMask * @class GeometryMask
@ -36,6 +36,16 @@ var GeometryMask = new Class({
* @since 3.0.0 * @since 3.0.0
*/ */
this.geometryMask = graphicsGeometry; this.geometryMask = graphicsGeometry;
/**
* Similiar to the BitmapMasks invertAlpha setting this to true will then hide all pixels
* drawn to the Geometry Mask.
*
* @name Phaser.Display.Masks.GeometryMask#invertAlpha
* @type {boolean}
* @since 3.16.0
*/
this.invertAlpha = false;
}, },
/** /**
@ -82,7 +92,16 @@ var GeometryMask = new Class({
// Use stencil buffer to affect next rendering object // Use stencil buffer to affect next rendering object
gl.colorMask(true, true, true, true); gl.colorMask(true, true, true, true);
gl.stencilFunc(gl.EQUAL, 1, 1);
if (this.invertAlpha)
{
gl.stencilFunc(gl.NOTEQUAL, 1, 1);
}
else
{
gl.stencilFunc(gl.EQUAL, 1, 1);
}
gl.stencilOp(gl.KEEP, gl.KEEP, gl.KEEP); gl.stencilOp(gl.KEEP, gl.KEEP, gl.KEEP);
}, },
@ -140,7 +159,7 @@ var GeometryMask = new Class({
/** /**
* Destroys this GeometryMask and nulls any references it holds. * Destroys this GeometryMask and nulls any references it holds.
* *
* Note that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it, * Note that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,
* so be sure to call `clearMask` on any Game Object using it, before destroying it. * so be sure to call `clearMask` on any Game Object using it, before destroying it.
* *