Difference between revisions of "Source:getFilter"

(Created page)
 
m (updated version from 0.11.0 to 11.0)
 
Line 1: Line 1:
{{newin|[[0.11.0]]|110|type=function}}
+
{{newin|[[11.0]]|110|type=function}}
 
Gets the [[Source:setFilter|filter]] settings currently applied to the Source.
 
Gets the [[Source:setFilter|filter]] settings currently applied to the Source.
  

Latest revision as of 12:42, 2 April 2018

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

Other Languages