Difference between revisions of "love.audio.setEffect"
(Move effect definition to EffectType) |
m |
||
| Line 52: | Line 52: | ||
== See Also == | == See Also == | ||
* [[parent::love.audio]] | * [[parent::love.audio]] | ||
| + | * [[love.audio.isEffectsSupported]] | ||
* [[Source:setEffect]] | * [[Source:setEffect]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Defines an effect that can be applied to a Source.}} | {{#set:Description=Defines an effect that can be applied to a Source.}} | ||
Revision as of 12:04, 28 November 2018
| Available since LÖVE 11.0 |
| This function is not supported in earlier versions. |
Defines an effect that can be applied to a Source.
Not all system supports audio effects. Use love.audio.isEffectsSupported to check.
Contents
Function
Synopsis
love.audio.setEffect(name, settings)
Arguments
string name- The name of the effect.
table settings- The settings to use for this effect, with the following fields:
EffectType type- The type of effect to use.
number volume- The volume of the effect.
number ...- Effect-specific settings. See EffectType for available effects and their corresponding settings.
Returns
boolean success- Whether the effect was successfully created.
Function
Synopsis
love.audio.setEffect(name, enabled)
Arguments
string name- The name of the effect.
boolean enabled (true)- If false and the given effect name was previously set, disables the effect.
Returns
boolean success- Whether the effect was successfully disabled.
Examples
Playing music with added reverb
love.audio.setEffect('myEffect', {type = 'reverb'})
local source = love.audio.newSource('music.ogg', 'stream')
source:setEffect('myEffect')
source:play()
Playing music with distortion
love.audio.setEffect('myEffect', {
type = 'distortion',
gain = .5,
edge = .25,
})
local source = love.audio.newSource('music.ogg', 'stream')
source:setEffect('myEffect')
source:play()
