Source:getEffect

Available since LÖVE 11.0
This function is not supported in earlier versions.

Gets the filter settings associated to a specific effect.

This function returns nil if the effect was applied with no filter settings associated to it.

Function

Synopsis

filtersettings = Source:getEffect( name, filtersettings )

Arguments

string name

The name of the effect.

table filtersettings ({})

An optional empty table that will be filled with the filter settings.

Returns

table filtersettings

The settings for the filter associated to this effect, or nil if the effect is not present in this Source or has no filter associated. The table has the following fields:

number volume

The overall volume of the audio.

number highgain

Volume of high-frequency audio. Only applies to low-pass and band-pass filters.

number lowgain

Volume of low-frequency audio. Only applies to high-pass and band-pass filters.

See Also

• Source
• Source:setEffect
• love.audio.setEffect