Packagegraphics.filters
Classpublic class ShaderCustomFilter
InheritanceShaderCustomFilter Inheritance flash.filters.ShaderFilter
Subclasses CircleSpectrumFilter, GnomonicFilter, GrayScaleFilter, HalftoneFilter, HoleFilter, KnockoutFilter, LambertFilter, MagnifyFilter, MosaicFilter, OrthographicFilter, ReflectionFilter, RGBDistortFilter, RippleBlocksFilter, RippleCrossingFilter, RoundPixelFilter, SharpenFilter, StereographicFilter, TwirlFilter, WaveReflectionFilter

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



Public Properties
 PropertyDefined By
  description : String
[read-only] The description of the filter (defines in the Shader).
ShaderCustomFilter
  name : String
[read-only] The name of the filter (defines in the Shader).
ShaderCustomFilter
  namespace : String
[read-only] The namespace of the filter (defines in the Shader).
ShaderCustomFilter
  version : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
Public Methods
 MethodDefined By
  
ShaderCustomFilter(shader:Shader = null, init:Object = null)
Creates a new ShaderCustomFilter instance.
ShaderCustomFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
ShaderCustomFilter
Property Detail
descriptionproperty
description:String  [read-only]

The description of the filter (defines in the Shader).


Implementation
    public function get description():String
nameproperty 
name:String  [read-only]

The name of the filter (defines in the Shader).


Implementation
    public function get name():String
namespaceproperty 
namespace:String  [read-only]

The namespace of the filter (defines in the Shader).


Implementation
    public function get namespace():String
versionproperty 
version:String  [read-only]

The version of the filter (defines in the Shader).


Implementation
    public function get version():String
Constructor Detail
ShaderCustomFilter()Constructor
public function ShaderCustomFilter(shader:Shader = null, init:Object = null)

Creates a new ShaderCustomFilter instance.

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