[ view source ]

class HighPassFilter

package ceramic

extends AudioFilter › Entity

@:build(ceramic.macros.AudioFiltersMacro.buildFilter())@:autoBuild(ceramic.macros.AudioFiltersMacro.buildFilter())@:build(tracker.macros.EventsMacro.build())@:autoBuild(tracker.macros.EventsMacro.build())@:build(ceramic.macros.EntityMacro.buildForCompletion())@:autoBuild(ceramic.macros.EntityMacro.buildForCompletion())

Available on all targets

Constructor

new()

Available on clay

Variables

@:value(1000.0)@paramcutoffFrequency:Float = 1000.0

Cutoff frequency in Hz

@:value(1.0)@paramgain:Float = 1.0

Filter gain/amplitude multiplier

@:value(0.707)@paramresonance:Float = 0.707

Filter resonance/Q factor (0.1 to 10.0, 0.707 = no resonance)

Methods

Inherited Events

Defined by AudioFilter

@:dox(show)ready(bus:Int):Void

Fired when the audio filter is successfuly attached to a given bus. When this is called, the audio filter is expected to be ready in the sense that all the underlying layers have been properly plugged and the audio output bus should be affected by this audio filter's worklet.

Parameters:

null

bus

@:dox(show)dispose(entity:Entity):Void

@:dox(show)destroy(entity:Entity):Void

Inherited Variables

Defined by AudioFilter

finalfilterId:Int

The unique id of this filter

@:value(-1)bus:Int = -1

The bus this filter is attached to (-1 if not attached)

@:value(true)active:Bool = true

Whether this filter is currently active

Defined by Entity

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

@:value(null)read onlyautoruns:Array<Autorun> = null

components:ReadOnlyMap<String, Component>

Public components mapping. Contain components created separately with component() or macro-based components as well.

scriptContent:ScriptContent

Available with script plugin

script:Script

Available with script plugin

Inherited Methods

Defined by AudioFilter

acquireParams():Void

releaseParams():Void

numParams():Int

Return the number of parameters this filter has. (automatically generated from fields marked with @param, no need to override it)

Defined by Entity

dispose():Void

Schedules destroy, at the end of the current frame.

unbindEvents():Void

Remove all events handlers from this entity.

autorun(run:() ‑> Void, ?afterRun:() ‑> Void):Autorun

Creates a new Autorun instance with the given callback associated with the current entity.

Parameters:

run

The run callback

Returns:

The autorun instance

tween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

Start a tween associated with this entity.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

eagerTween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

Start an eager tween associated with this entity. This is the same as a regular tween, except that it will start updating itself using current frame's delta time instead of next frame like in a regular tween.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

className():String

inlineclearComponents():Void

@:value({ hasField : false })component<C>(?name:String, ?component:Null<C>, hasField:Bool = false):C

hasComponent(name:String):Bool

removeComponent(name:String):Void