Packagegraphics.filters
Classpublic class HoleFilter
InheritanceHoleFilter Inheritance ShaderCustomFilter Inheritance flash.filters.ShaderFilter

The HoleFilter class applies a hole mask over a display or a bitmap. The Shader must be defines with the Hole pixelbender implementation.



Public Properties
 PropertyDefined By
  center : Point
The center of the hole filter.
HoleFilter
 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
  radius : Number
The radius of the hole filter.
HoleFilter
 Inheritedversion : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
Public Methods
 MethodDefined By
  
HoleFilter(shader:Shader = null, init:Object = null)
Creates a new HoleFilter instance.
HoleFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
HoleFilter
Property Detail
centerproperty
center:Point

The center of the hole filter.


Implementation
    public function get center():Point
    public function set center(value:Point):void
radiusproperty 
radius:Number

The radius of the hole filter.


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

Creates a new HoleFilter instance.

Parameters
shader:Shader (default = null) — The Shader reference with the Hole 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.