Packagekm.filters
Classpublic final class VignetFilter
InheritanceVignetFilter Inheritance SizeDependentFilter Inheritance flash.filters.ShaderFilter

The VignetFilter class [FlashPlayer 10].
This filter can be used to apply a vignet effect to a display object.


Example
import km.filters.*;

var shape:Shape = new Shape();
shape.graphics.beginFill(0xc00000);
shape.graphics.drawRect(0, 0, 40, 40);
addChild(shape);

var filter:VignetFilter = new VignetFilter(10);
filter.sizeTo(shape);
shape.filters = [filter];



Public Properties
 PropertyDefined by
 InheritedobjectHeight : Number
Gets or sets the object height to be passed to the filter.
SizeDependentFilter
 InheritedobjectWidth : Number
Gets or sets the object width to be passed to the filter.
SizeDependentFilter
  strength : Number
Strength.
VignetFilter
Public Methods
 MethodDefined by
  
VignetFilter(strength:Number = 1.0)
Initializes a new VignetFilter instance with the specified parameter.
VignetFilter
  
clone():BitmapFilter
Returns a copy of this filter object.
VignetFilter
 Inherited
sizeTo(displayObject:DisplayObject):void
Sets the object width and height to be passed to the filter by specifying the object itself.
SizeDependentFilter
Property detail
strengthproperty
strength:Number  [read-write]

Strength. Valid values are from 1 to 10 (floating point). The default value is 1.0.

Implementation
    public function get strength():Number
    public function set strength(value:Number):void
Constructor detail
VignetFilter()constructor
public function VignetFilter(strength:Number = 1.0)

Initializes a new VignetFilter instance with the specified parameter.

Parameters
strength:Number (default = 1.0)
Method detail
clone()method
public override function clone():BitmapFilter

Returns a copy of this filter object.

Returns
BitmapFilter