View source

class Outline

package h2d.filter

extends Filter

Provides a solid color outline to the filtered object by utilizing h3d.pass.Outline render pass.

Constructor

@:value({ multiplyAlpha : true, quality : 0.3, color : 0x000000, size : 4.0 })new(size:Float = 4.0, color:Int = 0x000000, quality:Float = 0.3, multiplyAlpha:Bool = true)

Create a new Outline filter.

Parameters:

size

Width of the outline.

color

The color of the outline.

quality

The sample count with quality/speed tradeoff.

multiplyAlpha

Enable alpha premultiplying of the resulting color.

Variables

alpha:Float

The transparency of the outline.

color:Int

The color of the outline.

See also:

multiplyAlpha:Bool

Premultiplies the resulting color with its alpha when enabled.

See also:

quality:Float

Represents sample count with quality/speed tradeoff. Larger value leads to more samples and more accurate outline in exchange to calculation speed.

See also:

size:Float

The width of the outline.

See also:

Methods

Inherited Variables

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(1)resolutionScale:Float = 1

Custom rendering resolution scaling of the filter.

Stacks with additional scaling from Filter.useResolutionScaling if enabled.

@:value(false)smooth:Bool = false

When enabled, filters on not Object which are not Drawable will use bilinear filtering when displayed and some filter will also use bilinear filtering on intermediate textures.

@:value(defaultUseScreenResolution)useScreenResolution:Bool = defaultUseScreenResolution

Use the screen resolution to upscale/downscale the filter rendering resolution.

Stacks with additional scaling from Filter.resolutionScale if enabled.

Inherited Methods

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, scale:Point):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 are still applied, causing rendering area to shrink.

Parameters:

s

The Object instance to which the filter is applied.

bounds

The Bounds instance which should be populated by the filter boundaries.

scale

Contains the desired rendering resolution scaling which should be accounted when constructing the bounds. Can be edited to override provided scale values.

unbind(s:Object):Void

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