View source

class Glow

package h2d.filter

extends Blur › Filter

extended by DropShadow

Adds a glow backdrop to the filtered Object.

Constructor

@:value({ smoothColor : false, quality : 1., gain : 1., radius : 1., alpha : 1., color : 0xFFFFFF })new(color:Int = 0xFFFFFF, alpha:Float = 1., radius:Float = 1., gain:Float = 1., quality:Float = 1., smoothColor:Bool = false)

Create new Glow filter.

Parameters:

color

The color of the glow.

alpha

Transparency value of the glow.

radius

The glow distance in pixels.

gain

The glow color intensity.

quality

The sample count on each pixel as a tradeoff of speed/quality.

smoothColor

Produce gradient glow when enabled, otherwise creates hard glow without smoothing.

Variables

alpha:Float

Transparency value of the glow.

color:Int

The color of the glow.

knockout:Bool

Subtracts the original image from the glow output when enabled.

smoothColor:Bool

Produce gradient glow when enabled, otherwise creates hard glow without smoothing.

Methods

Inherited Variables

Defined by Blur

Defined by Filter

@:value(true)autoBounds:Bool = true

When enabled, rendering bounds of the filter will be expanded by Filter.boundsExtend in all directions. Otherwise filter should provide custom bounds through Filter.getBounds call.
Default : true.

@:value(0.)boundsExtend:Float = 0.

Rendering texture boundaries extent. Increases the rendering area by twice the Filter.boundsExtend value.
Automatically applied to object bounds when autoBounds = true or Filter.getBounds is not overridden.
Does not affect boundaries when autoBounds = true and boundsExtend is less than 0.

@:value(true)@:isVarenable:Bool = true

When filter is disabled, attached object will render as usual.

@:value(false)smooth:Bool = false

When enabled, some filters will use bilinear filtering on temporary textures.
Does not affect the majority of filters.

See also:

Inherited Methods

Defined by Blur

Defined by Filter

bind(s:Object):Void

Sent when filter is bound to an Object s. If Object was not yet allocated, method will be called when it's added to allocated Scene.

getBounds(s:Object, bounds:Bounds):Void

Method should populate bounds with rendering boundaries of the Filter for Object s. Initial bounds contents are undefined and it's recommended to either clear them or call s.getBounds(s, bounds). Only used when Filter.autoBounds is false. By default uses given Object bounds and extends them with Filter.boundsExtend. Compared to autoBounds = true, negative boundsExtend is still applied, causing rendering area to shrink.

unbind(s:Object):Void

Sent when filter was unbound from an Object s. Method won't be called if Object was not yet allocated.