Source:getFilter

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

Gets the filter settings currently applied to the Source.

Function

Synopsis

settings = Source:getFilter( )

Arguments

None.

Returns

table settings (nil)

The filter settings to use for this Source, or nil if the Source has no active filter. The table has the following fields:

FilterType type

The type of filter to use.

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:setFilter
• Source:setEffect