Function AddMaskShape

src/actions/AddMaskShape.js:60–157

(items, config)

 * @return {Phaser.Filters.Mask[]} The new Mask filters, in order of target.
 */
var AddMaskShape = function (items, config)
{
    if (!Array.isArray(items)) { items = [ items ]; }
    if (!config) { config = {}; }
    var aspectRatio = (config.aspectRatio === undefined) ? 1 : config.aspectRatio;
    var padding = config.padding || 0;

    var scene = items[0].scene;
    var output = [];

    for (var i = 0; i < items.length; i++)
    {
        var item = items[i];

        var region = config.region;
        if (!region)
        {
            if (config.useInternal && item._sizeComponent)
            {
                region = new Rectangle(0, 0, item.width, item.height);
            }
            else
            {
                region = new Rectangle(0, 0, scene.scale.width, scene.scale.height);
            }
        }

        // Create a shape to use as a mask.
        var shape;
        switch (config.shape)
        {
            case 'ellipse':
            {
                shape = scene.add.ellipse(0, 0, aspectRatio, 1, 0xffffff);
                break;
            }
            case 'square':
            {
                shape = scene.add.rectangle(0, 0, 1, 1, 0xffffff);
                break;
            }
            case 'rectangle':
            {
                shape = scene.add.rectangle(0, 0, aspectRatio, 1, 0xffffff);
                break;
            }
            case 'circle':
            default:
            {
                shape = scene.add.circle(0, 0, 1, 0xffffff);
                break;
            }
        }

        // Remove shape from scene, as we don't need to display it,
        // and it will be garbage collected once the Mask is destroyed.
        scene.children.remove(shape);