Packagestarling.filters
Classpublic class GlowFilter
InheritanceGlowFilter Inheritance FragmentFilter Inheritance EventDispatcher Inheritance Object

The GlowFilter class lets you apply a glow effect to display objects. It is similar to the drop shadow filter with the distance and angle properties set to 0.

This filter can also be used to create outlines around objects. The trick is to assign an alpha value that's (much) greater than 1.0, and full resolution. For example, the following code will yield a nice black outline:

object.filter = new GlowFilter(0x0, 30, 1, 1.0);


Public Properties
 PropertyDefined By
  alpha : Number
The alpha value of the glow.
GlowFilter
 InheritedalwaysDrawToBackBuffer : Boolean
Indicates if the last filter pass is always drawn directly to the back buffer.
FragmentFilter
 InheritedantiAliasing : int
The anti-aliasing level.
FragmentFilter
  blur : Number
The amount of blur with which the glow is created.
GlowFilter
  color : uint
The color of the glow.
GlowFilter
  inner : Boolean
Indicates whether or not the glow is an inner glow.
GlowFilter
 InheritedisCached : Boolean
[read-only] Indicates if the filter is cached (via the cache method).
FragmentFilter
  knockout : Boolean
If enabled, applies a knockout effect, which effectively makes the object's fill transparent.
GlowFilter
 InheritednumPasses : int
[read-only] Indicates the number of rendering passes required for this filter.
FragmentFilter
 Inheritedpadding : Padding
Padding can extend the size of the filter texture in all directions.
FragmentFilter
  quality : Number
The quality used for blurring the glow.
GlowFilter
 Inheritedresolution : Number
The resolution of the filter texture.
FragmentFilter
 InheritedtextureFormat : String
The format of the filter texture.
FragmentFilter
 InheritedtextureSmoothing : String
The smoothing mode of the filter texture.
FragmentFilter
Protected Properties
 PropertyDefined By
 Inheritedeffect : FilterEffect
[read-only] The effect instance returning the FilterEffect created via createEffect.
FragmentFilter
 InheritedindexData : IndexData
[read-only] The IndexData used to process the effect.
FragmentFilter
 InheritedmaintainResolutionAcrossPasses : Boolean
Indicates if the filter requires all passes to be processed with the exact same resolution.
FragmentFilter
 InheritedvertexData : VertexData
[read-only] The VertexData used to process the effect.
FragmentFilter
Public Methods
 MethodDefined By
  
GlowFilter(color:uint = 0xffff00, alpha:Number = 1.0, blur:Number = 1.0, quality:Number = 0.5, inner:Boolean = false, knockout:Boolean = false)
Initializes a new GlowFilter instance with the specified parameters.
GlowFilter
 Inherited
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
 Inherited
cache():void
Caches the filter output into a texture.
FragmentFilter
 Inherited
clearCache():void
Clears the cached output of the filter.
FragmentFilter
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered listeners for its type.
EventDispatcher
 Inherited
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.
GlowFilter
 Inherited
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
 Inherited
process(painter:Painter, helper:IFilterHelper, input0:Texture = null, input1:Texture = null, input2:Texture = null, input3:Texture = null):Texture
Does the actual filter processing.
FragmentFilter
 Inherited
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
 Inherited
render(painter:Painter):void
Renders the filtered target object.
FragmentFilter
Protected Methods
 MethodDefined By
 Inherited
createEffect():FilterEffect
Creates the effect that does the actual, low-level rendering.
FragmentFilter
 Inherited
onTargetAssigned(target:DisplayObject):void
Called when assigning a target display object.
FragmentFilter
 Inherited
setRequiresRedraw():void
Call this method when any of the filter's properties changes.
FragmentFilter
Events
 Event Summary Defined By
 Inherited
change
Dispatched when the settings change in a way that requires a redraw.FragmentFilter
 Inherited
enterFrame
Dispatched every frame on filters assigned to display objects connected to the stage.FragmentFilter
Property Detail
alphaproperty
alpha:Number

The alpha value of the glow. Values between 0 and 1 modify the opacity; values > 1 will make it stronger, i.e. produce a harder edge.

The default value is 1.0.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
blurproperty 
blur:Number

The amount of blur with which the glow is created. The number of required passes will be Math.ceil(value) × 2.

The default value is 1.0.


Implementation
    public function get blur():Number
    public function set blur(value:Number):void
colorproperty 
color:uint

The color of the glow.

The default value is 0xffff00.


Implementation
    public function get color():uint
    public function set color(value:uint):void
innerproperty 
inner:Boolean

Indicates whether or not the glow is an inner glow. The default is false, an outer glow (a glow around the outer edges of the object).


Implementation
    public function get inner():Boolean
    public function set inner(value:Boolean):void
knockoutproperty 
knockout:Boolean

If enabled, applies a knockout effect, which effectively makes the object's fill transparent.

The default value is false.


Implementation
    public function get knockout():Boolean
    public function set knockout(value:Boolean):void
qualityproperty 
quality:Number

The quality used for blurring the glow. Forwarded to the internally used BlurFilter.


Implementation
    public function get quality():Number
    public function set quality(value:Number):void
Constructor Detail
GlowFilter()Constructor
public function GlowFilter(color:uint = 0xffff00, alpha:Number = 1.0, blur:Number = 1.0, quality:Number = 0.5, inner:Boolean = false, knockout:Boolean = false)

Initializes a new GlowFilter instance with the specified parameters.

Parameters
color:uint (default = 0xffff00) — the color of the glow
 
alpha:Number (default = 1.0) — the alpha value of the glow. 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 used to create the glow. Note that high values will cause the number of render passes to grow.
 
quality:Number (default = 0.5) — the quality of the glow's blur, '1' being the best (range 0.1 - 1.0)
 
inner:Boolean (default = false) — if enabled, the glow will be drawn inside the object.
 
knockout:Boolean (default = false) — if enabled, only the glow will be drawn.
Method Detail
dispose()method
override public function dispose():void

Disposes all resources that have been created by the filter.





Mon Jul 26 2021, 10:58 AM +02:00