Difference between revisions of "love.audio.setEffect"
(document disabling effects) |
(Move effect definition to EffectType) |
||
| Line 1: | Line 1: | ||
{{newin|[[11.0]]|110|type=function}} | {{newin|[[11.0]]|110|type=function}} | ||
Defines an effect that can be applied to a [[Source]]. | Defines an effect that can be applied to a [[Source]]. | ||
| + | |||
| + | Not all system supports audio effects. Use [[love.audio.isEffectsSupported]] to check. | ||
== Function == | == Function == | ||
| − | |||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
love.audio.setEffect(name, settings) | love.audio.setEffect(name, settings) | ||
</source> | </source> | ||
| − | |||
=== Arguments === | === Arguments === | ||
{{param|string|name|The name of the effect.}} | {{param|string|name|The name of the effect.}} | ||
{{param|table|settings|The settings to use for this effect, with the following fields:}} | {{param|table|settings|The settings to use for this effect, with the following fields:}} | ||
| − | {{subparam| | + | {{subparam|EffectType|type|The type of effect to use.}} |
{{subparam|number|volume|The volume of the effect.}} | {{subparam|number|volume|The volume of the effect.}} | ||
| − | {{subparam|number|...|Effect-specific settings | + | {{subparam|number|...|Effect-specific settings. See [[EffectType]] for available effects and their corresponding settings.}} |
| − | |||
=== Returns === | === Returns === | ||
{{param|boolean|success|Whether the effect was successfully created.}} | {{param|boolean|success|Whether the effect was successfully created.}} | ||
== Function == | == Function == | ||
| − | |||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
love.audio.setEffect(name, enabled) | love.audio.setEffect(name, enabled) | ||
</source> | </source> | ||
| − | |||
=== Arguments === | === Arguments === | ||
{{param|string|name|The name of the effect.}} | {{param|string|name|The name of the effect.}} | ||
{{param|boolean|enabled (true)|If false and the given effect name was previously set, disables the effect.}} | {{param|boolean|enabled (true)|If false and the given effect name was previously set, disables the effect.}} | ||
| − | |||
=== Returns === | === Returns === | ||
{{param|boolean|success|Whether the effect was successfully disabled.}} | {{param|boolean|success|Whether the effect was successfully disabled.}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Examples == | == Examples == | ||
| − | |||
=== Playing music with added reverb === | === Playing music with added reverb === | ||
<source lang="lua"> | <source lang="lua"> | ||
Revision as of 12:02, 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()
