Packagegraphics.filters
Classpublic class RippleBlocksFilter
InheritanceRippleBlocksFilter Inheritance ShaderCustomFilter Inheritance flash.filters.ShaderFilter

Applies a ripple blocks effect. The Shader must be defines with the RippleBlocks pixelbender implementation.



Public Properties
 PropertyDefined By
  amplitude : Point
The amplitude of the filter.
RippleBlocksFilter
  amplitudeX : Number
The x component only of the amplitude of the filter.
RippleBlocksFilter
  amplitudeY : Number
The y component only of the amplitude of the filter.
RippleBlocksFilter
 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
  phase : Point
The phase of the filter.
RippleBlocksFilter
  phaseX : Number
The x component only of the phase of the filter.
RippleBlocksFilter
  phaseY : Number
The y component only of the phase of the filter.
RippleBlocksFilter
 Inheritedversion : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
  wave : Point
The wave length value of the filter.
RippleBlocksFilter
  waveX : Number
The x component only of the wave of the filter.
RippleBlocksFilter
  waveY : Number
The y component only of the wave of the filter.
RippleBlocksFilter
Public Methods
 MethodDefined By
  
RippleBlocksFilter(shader:Shader = null, init:Object = null)
Creates a new RippleBlocksFilter instance.
RippleBlocksFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
RippleBlocksFilter
Property Detail
amplitudeproperty
amplitude:Point

The amplitude of the filter. You can use too the amplitudeX and amplitudeY properties.


Implementation
    public function get amplitude():Point
    public function set amplitude(value:Point):void
amplitudeXproperty 
amplitudeX:Number

The x component only of the amplitude of the filter.


Implementation
    public function get amplitudeX():Number
    public function set amplitudeX(value:Number):void
amplitudeYproperty 
amplitudeY:Number

The y component only of the amplitude of the filter.


Implementation
    public function get amplitudeY():Number
    public function set amplitudeY(value:Number):void
phaseproperty 
phase:Point

The phase of the filter. You can use too the phaseX and phaseY properties.


Implementation
    public function get phase():Point
    public function set phase(value:Point):void
phaseXproperty 
phaseX:Number

The x component only of the phase of the filter.


Implementation
    public function get phaseX():Number
    public function set phaseX(value:Number):void
phaseYproperty 
phaseY:Number

The y component only of the phase of the filter.


Implementation
    public function get phaseY():Number
    public function set phaseY(value:Number):void
waveproperty 
wave:Point

The wave length value of the filter. You can use too the waveX and waveY properties.


Implementation
    public function get wave():Point
    public function set wave(value:Point):void
waveXproperty 
waveX:Number

The x component only of the wave of the filter.


Implementation
    public function get waveX():Number
    public function set waveX(value:Number):void
waveYproperty 
waveY:Number

The y component only of the wave of the filter.


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

Creates a new RippleBlocksFilter instance.

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