Documentation
¶
Overview ¶
An audio effect instance manipulates the audio it receives for a given effect. This instance is automatically created by an graphics.gd/classdb/AudioEffect when it is added to a bus, and should usually not be created directly. If necessary, it can be fetched at run-time with graphics.gd/classdb/AudioServer.GetBusEffectInstance.
Index ¶
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 AudioFrame ¶
type AudioFrame = gd.AudioFrame
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]) AsAudioEffectInstance ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
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.AudioEffectInstance
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) AsAudioEffectInstance ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
type Interface ¶
type Interface interface {
// Called by the [graphics.gd/classdb/AudioServer] to process this effect. When [Interface.ProcessSilence] is not overridden or it returns false, this method is called only when the bus is active.
//
// Note: It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it.
Process(src_buffer gdextension.Pointer, dst_buffer *AudioFrame, frame_count int)
// Override this method to customize the processing behavior of this effect instance.
//
// Should return true to force the [graphics.gd/classdb/AudioServer] to always call [Interface.Process], even if the bus has been muted or cannot otherwise be heard.
ProcessSilence() bool
}
Source Files