Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.graphics.shaderClasses 
LuminosityMaskShader 
Packagemx.graphics.shaderClasses
Classpublic class LuminosityMaskShader
InheritanceLuminosityMaskShader Inheritance Shader Inheritance Object

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



Public Properties
 PropertyDefined By
 InheritedbyteCode : ByteArray
[write-only] The raw shader bytecode for this Shader instance.
Shader
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheriteddata : ShaderData
Provides access to parameters, input images, and metadata for the Shader instance.
Shader
  mode : int
A convenience field that takes into account whether luminosityClip and/or luminosityInvert are on or off.
LuminosityMaskShader
 InheritedprecisionHint : String
The precision of math operations performed by the shader.
Shader
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Constructor.
LuminosityMaskShader
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

mode

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

  • mode 0 = luminosityClip off, luminosityInvert off
  • mode 1 = luminosityClip off, luminosityInvert on
  • mode 2 = luminosityClip on, luminosityInvert off
  • mode 3 = luminosityClip on, luminosityInvert on



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.

LuminosityMaskShaderExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- 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/ks5792.jpg')" />
        </s:Group>
        <s:Button label="Apply Luminosity mask" click="setMask()" 
            x="15" y="265" />
    </s:Panel>

</s:Application>