AudioEffectReverb

package
v0.0.0-...-357ca8a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.

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 Any

type Any interface {
	gd.IsClass
	AsAudioEffectReverb() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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

func (*Extension[T]) AsAudioEffect

func (self *Extension[T]) AsAudioEffect() AudioEffect.Instance

func (*Extension[T]) AsAudioEffectReverb

func (self *Extension[T]) AsAudioEffectReverb() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.AudioEffectReverb

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 New

func New() Instance

func (Instance) AsAudioEffect

func (self Instance) AsAudioEffect() AudioEffect.Instance

func (Instance) AsAudioEffectReverb

func (self Instance) AsAudioEffectReverb() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) Damping

func (self Instance) Damping() Float.X

Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.

func (Instance) Dry

func (self Instance) Dry() Float.X

Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.

func (Instance) Hipass

func (self Instance) Hipass() Float.X

High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) PredelayFeedback

func (self Instance) PredelayFeedback() Float.X

Output percent of predelay. Value can range from 0 to 1.

func (Instance) PredelayMsec

func (self Instance) PredelayMsec() Float.X

Time between the original signal and the early reflections of the reverb signal, in milliseconds.

func (Instance) RoomSize

func (self Instance) RoomSize() Float.X

Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.

func (Instance) SetDamping

func (self Instance) SetDamping(value Float.X)

SetDamping sets the property returned by [GetDamping].

func (Instance) SetDry

func (self Instance) SetDry(value Float.X)

SetDry sets the property returned by [GetDry].

func (Instance) SetHipass

func (self Instance) SetHipass(value Float.X)

SetHipass sets the property returned by [GetHpf].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPredelayFeedback

func (self Instance) SetPredelayFeedback(value Float.X)

SetPredelayFeedback sets the property returned by [GetPredelayFeedback].

func (Instance) SetPredelayMsec

func (self Instance) SetPredelayMsec(value Float.X)

SetPredelayMsec sets the property returned by [GetPredelayMsec].

func (Instance) SetRoomSize

func (self Instance) SetRoomSize(value Float.X)

SetRoomSize sets the property returned by [GetRoomSize].

func (Instance) SetSpread

func (self Instance) SetSpread(value Float.X)

SetSpread sets the property returned by [GetSpread].

func (Instance) SetWet

func (self Instance) SetWet(value Float.X)

SetWet sets the property returned by [GetWet].

func (Instance) Spread

func (self Instance) Spread() Float.X

Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Wet

func (self Instance) Wet() Float.X

Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL