Package | starling.filters |
Class | public class DropShadowFilter |
Inheritance | DropShadowFilter FragmentFilter EventDispatcher Object |
Property | Defined By | ||
---|---|---|---|
alpha : Number The alpha value of the shadow. | DropShadowFilter | ||
alwaysDrawToBackBuffer : Boolean Indicates if the last filter pass is always drawn directly to the back buffer. | FragmentFilter | ||
angle : Number The angle with which the shadow is offset, in radians. | DropShadowFilter | ||
blur : Number The amount of blur with which the shadow is created. | DropShadowFilter | ||
color : uint The color of the shadow. | DropShadowFilter | ||
distance : Number The offset distance for the shadow, in points. | DropShadowFilter | ||
isCached : Boolean [read-only] Indicates if the filter is cached (via the cache method). | FragmentFilter | ||
numPasses : int [read-only] Indicates the number of rendering passes required for this filter. | FragmentFilter | ||
padding : Padding Padding can extend the size of the filter texture in all directions. | FragmentFilter | ||
resolution : Number [override] | DropShadowFilter | ||
textureFormat : String The format of the filter texture. | FragmentFilter | ||
textureSmoothing : String The smoothing mode of the filter texture. | FragmentFilter |
Method | Defined By | ||
---|---|---|---|
DropShadowFilter(distance:Number = 4.0, angle:Number = 0.785, color:uint = 0x0, alpha:Number = 0.5, blur:Number = 1.0, resolution:Number = 0.5) Creates a new DropShadowFilter instance with the specified parameters. | DropShadowFilter | ||
addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | ||
cache():void Caches the filter output into a texture. | FragmentFilter | ||
clearCache():void Clears the cached output of the filter. | FragmentFilter | ||
dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | ||
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | ||
dispose():void [override] Disposes all resources that have been created by the filter. | DropShadowFilter | ||
hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | ||
process(painter:Painter, helper:IFilterHelper, input0:Texture = null, input1:Texture = null, input2:Texture = null, input3:Texture = null):Texture Does the actual filter processing. | FragmentFilter | ||
removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | ||
removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | ||
Renders the filtered target object. | FragmentFilter |
alpha | property |
alpha:Number
The alpha value of the shadow. Values between 0 and 1 modify the opacity; values > 1 will make it stronger, i.e. produce a harder edge.
The default value is 0.5
.
public function get alpha():Number
public function set alpha(value:Number):void
angle | property |
angle:Number
The angle with which the shadow is offset, in radians.
The default value is Math.PI / 4
.
public function get angle():Number
public function set angle(value:Number):void
blur | property |
blur:Number
The amount of blur with which the shadow is created.
The number of required passes will be Math.ceil(value) × 2
.
The default value is 1.0
.
public function get blur():Number
public function set blur(value:Number):void
color | property |
color:uint
The color of the shadow.
The default value is 0x0
.
public function get color():uint
public function set color(value:uint):void
distance | property |
distance:Number
The offset distance for the shadow, in points.
The default value is 4.0
.
public function get distance():Number
public function set distance(value:Number):void
resolution | property |
resolution:Number
[override] public function get resolution():Number
public function set resolution(value:Number):void
DropShadowFilter | () | Constructor |
public function DropShadowFilter(distance:Number = 4.0, angle:Number = 0.785, color:uint = 0x0, alpha:Number = 0.5, blur:Number = 1.0, resolution:Number = 0.5)
Creates a new DropShadowFilter instance with the specified parameters.
Parametersdistance:Number (default = 4.0 ) — the offset distance of the shadow, in points.
| |
angle:Number (default = 0.785 ) — the angle with which the shadow is offset, in radians.
| |
color:uint (default = 0x0 ) — the color of the shadow.
| |
alpha:Number (default = 0.5 ) — the alpha value of the shadow. Values between 0 and 1 modify the
opacity; values > 1 will make it stronger, i.e. produce a harder edge.
| |
blur:Number (default = 1.0 ) — the amount of blur with which the shadow is created. Note that high
values will cause the number of render passes to grow.
| |
resolution:Number (default = 0.5 ) — the resolution of the filter texture. '1' means full resolution,
'0.5' half resolution, etc.
|
dispose | () | method |
override public function dispose():void
Disposes all resources that have been created by the filter.