AudioEffectFilter

package
v0.0.0-...-9b8b246 Latest Latest
Warning

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

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

Documentation

Overview

Allows frequencies other than the CutoffHz to pass.

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
	AsAudioEffectFilter() 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]) AsAudioEffectFilter

func (self *Extension[T]) AsAudioEffectFilter() 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 FilterDB

type FilterDB int //gd:AudioEffectFilter.FilterDB
const (
	// Cutting off at 6dB per octave.
	Filter6db FilterDB = 0
	// Cutting off at 12dB per octave.
	Filter12db FilterDB = 1
	// Cutting off at 18dB per octave.
	Filter18db FilterDB = 2
	// Cutting off at 24dB per octave.
	Filter24db FilterDB = 3
)

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.AudioEffectFilter

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) AsAudioEffectFilter

func (self Instance) AsAudioEffectFilter() 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) CutoffHz

func (self Instance) CutoffHz() Float.X

Threshold frequency for the filter, in Hz.

func (Instance) Db

func (self Instance) Db() FilterDB

Steepness of the cutoff curve in dB per octave, also known as the order of the filter. Higher orders have a more aggressive cutoff.

func (Instance) Gain

func (self Instance) Gain() Float.X

Gain amount of the frequencies after the filter.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Resonance

func (self Instance) Resonance() Float.X

Amount of boost in the frequency range near the cutoff frequency.

func (Instance) SetCutoffHz

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

SetCutoffHz sets the property returned by [GetCutoff].

func (Instance) SetDb

func (self Instance) SetDb(value FilterDB)

SetDb sets the property returned by [GetDb].

func (Instance) SetGain

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

SetGain sets the property returned by [GetGain].

func (*Instance) SetObject

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

func (Instance) SetResonance

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

SetResonance sets the property returned by [GetResonance].

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

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