A filter that renders nothing.
Constructor
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(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 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.