Packagemx.graphics.shaderClasses
Classpublic class LuminosityMaskShader
InheritanceLuminosityMaskShader Inheritance flash.display.Shader

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Creates a blend shader that is equivalent to the luminosity masking option (also known as soft masking) available in Adobe Creative Suite tools. This mask type is not native to Flash, but is available in tools like Adobe Illustrator and Adobe Photoshop.

A luminosity mask type can be set on Flex groups and graphic elements. The visual appearance in tools like Adobe Illustrator and Adobe Photoshop will be mimicked through this blend shader.

View the examples

See also

spark.primitives.supportClasses.GraphicElement.maskType
spark.components.supportClasses.GroupBase.maskType


Public Properties
 PropertyDefined By
  mode : int
A convenience field that takes into account whether luminosityClip and/or luminosityInvert are on or off.
LuminosityMaskShader
Public Methods
 MethodDefined By
  
Constructor.
LuminosityMaskShader
Property Detail
modeproperty
mode:int

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

A convenience field that takes into account whether luminosityClip and/or luminosityInvert are on or off.


Implementation
    public function get mode():int
    public function set mode(value:int):void

See also

Constructor Detail
LuminosityMaskShader()Constructor
public function LuminosityMaskShader()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Examples
LuminosityMaskShaderExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- LuminosityMaskShader.mxml -->
<s:Application name="LuminosityMaskShader"
        xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark">
    
    <fx:Script>
    <![CDATA[
    
         //function to set mask and maskType
         private function setMask(): void
         {
             group2.mask = rectMask;
             group2.maskType = "luminosity";
         }
    ]]>
    </fx:Script>
    
    <fx:Declarations>
        <s:Group id="rectMask" blendMode="normal" x="10"  y="20">
        <s:Ellipse width="170" height="220">
            <s:fill>
                <s:SolidColor color="0x33CC99" />
            </s:fill>
        </s:Ellipse>
        </s:Group> 
    </fx:Declarations>
    
    <s:Panel title="LuminosityMaskShader Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">

        <s:Group id="group2" horizontalCenter="0" y="10">
        <s:BitmapImage source="@Embed('/assets/SampleImage.jpg')" />
        </s:Group>
        <s:Button label="Apply Luminosity mask" click="setMask()" 
            x="15" y="265" />
    </s:Panel>

</s:Application>