Packagegraphics.filters
Classpublic class KnockoutFilter
InheritanceKnockoutFilter Inheritance ShaderCustomFilter Inheritance flash.filters.ShaderFilter

The KnockoutFilter class applies a filter by executing a shader on the object being filtered. The Shader must be defines with the Knockout pixelbender implementation.



Public Properties
 PropertyDefined By
  color : Number
The threshold value of the knockout.
KnockoutFilter
 Inheriteddescription : String
[read-only] The description of the filter (defines in the Shader).
ShaderCustomFilter
 Inheritedname : String
[read-only] The name of the filter (defines in the Shader).
ShaderCustomFilter
 Inheritednamespace : String
[read-only] The namespace of the filter (defines in the Shader).
ShaderCustomFilter
  threshold : Number
The threshold value of the knockout.
KnockoutFilter
 Inheritedversion : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
Public Methods
 MethodDefined By
  
KnockoutFilter(shader:Shader = null, init:Object = null)
Creates a new KnockoutFilter instance.
KnockoutFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
KnockoutFilter
Property Detail
colorproperty
color:Number

The threshold value of the knockout.


Implementation
    public function get color():Number
    public function set color(value:Number):void
thresholdproperty 
threshold:Number

The threshold value of the knockout.


Implementation
    public function get threshold():Number
    public function set threshold(value:Number):void
Constructor Detail
KnockoutFilter()Constructor
public function KnockoutFilter(shader:Shader = null, init:Object = null)

Creates a new KnockoutFilter instance.

Parameters
shader:Shader (default = null) — The Shader reference with the Knockout pixel bender filter inside.
 
init:Object (default = null) — The optional dynamic object to initialize the filter.
Method Detail
clone()method
override public function clone():BitmapFilter

Returns a shallow copy of the object.

Returns
BitmapFilter — a shallow copy of the object.