Documentation
¶
Overview ¶
The base graphics.gd/classdb/Resource for every audio effect. In the editor, an audio effect can be added to the current bus layout through the Audio panel. At run-time, it is also possible to manipulate audio effects through graphics.gd/classdb/AudioServer.AddBusEffect, graphics.gd/classdb/AudioServer.RemoveBusEffect, and graphics.gd/classdb/AudioServer.GetBusEffect.
When applied on a bus, an audio effect creates a corresponding graphics.gd/classdb/AudioEffectInstance. The instance is directly responsible for manipulating the sound, based on the original audio effect's properties.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsAudioEffect() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsAudioEffect ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.AudioEffect
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsAudioEffect ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
type Interface ¶
type Interface interface {
// Override this method to customize the [graphics.gd/classdb/AudioEffectInstance] created when this effect is applied on a bus in the editor's Audio panel, or through [graphics.gd/classdb/AudioServer.AddBusEffect].
//
//
//
// extends AudioEffect
//
//
//
// @export var strength = 4.0
//
//
//
// func _instantiate():
//
// var effect = CustomAudioEffectInstance.new()
//
// effect.base = self
//
//
//
// return effect
//
//
//
// Note: It is recommended to keep a reference to the original [graphics.gd/classdb/AudioEffect] in the new instance. Depending on the implementation this allows the effect instance to listen for changes at run-time and be modified accordingly.
Instantiate() AudioEffectInstance.Instance
}
Source Files