AudioEffectDistortion
Adds a distortion audio effect to an Audio bus.
AudioEffectDistortion.swift:17class AudioEffectDistortion
Modifies the sound to make it distorted.
Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.
By distorting the waveform the frequency content changes, which will often make the sound “crunchy” or “abrasive”. For games, it can simulate sound coming from some saturated device or speaker very efficiently.
Superclasses
class AudioEffect
Audio effect for audio.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Types
Type members
Instance members
var drive: Double
Distortion power. Value can range from 0 to 1.
var keepHfHz: Double
High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
var mode: AudioEffectDistortion.Mode
Distortion type.
var postGain: Double
Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24.
var preGain: Double
Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60.