~~NOTOC~~

====== Wave Filter ======

---- dataentry extension ----
author_mail   : tadeubas@gmail.com Tadeu Sampaio and @yloquen
description   : Custom filter for Waves effect           # enter a short description of the extension
compatible    : v2.3       # the Starling version you tested the extension with
tags          : filter, wave           # enter a few tags, separated by commas
homepage_url  : https://github.com/Tudumanu/Starling2-Wave-Filter           # if the ext. has an URL (e.g. a Gist-page), add it here
----

===== Overview =====
A custom filter for Wave effect, as an extension for Starling2

{{ :extensions:wave.mp4?760x492 |}}

<code as3>
//creating and configuring the WaveFilter
var waveFilter:WaveFilter = new WaveFilter();
var linear_source:WaveSource = new WaveSource(WaveSource.LINEAR, .01, .5, 50, 30);
var radial_source:WaveSource = new WaveSource(WaveSource.RADIAL, .02, 5, 60, 5, new Point(.3,.3), 1);

waveFilter.addWaveSource(linear_source);
waveFilter.addWaveSource(radial_source);			
starling.juggler.add(waveFilter);


//creating an Image and applying the filter
var imgBoat:Image = new Image(Texture.fromEmbeddedAsset(EmbeddedAssets.boat));
imgBoat.x = 50;
imgBoat.y = 30;
imgBoat.filter = waveFilter;
addChild(imgBoat);
</code>

**Authors:**

  * Original version for Starling 1.x: yloquen
  * Modified for Starling 2.x: TadeuBAS

**More information:**

  * [[https://forum.starling-framework.org/topic/wave-filter-ported-from-starling-1x-to-2x|Wave Filter Starling 2.x forum post]]
  * [[https://forum.starling-framework.org/topic/wave-filter|Wave Filter Starling 1.x forum post]]
  * [[https://github.com/yloquen/WaveFilter|Wave Filter Starling 1.x on GitHub]]
  * [[https://github.com/yloquen/StarlingFilters|Wave Filter Starling 1.x on GitHub other repo]]

===== Changelog =====

  * //2018/06/20 20:07//: First public version

===== User Comments =====

//Feel free to edit this part of the page if you want to add information that's lacking in the above description.\\
Questions are better asked in this [[https://forum.starling-framework.org/topic/wave-filter-ported-from-starling-1x-to-2x|forum post]], though.//