AudioEffectDistortion

package
v0.0.0-...-a66c66c Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2025 License: MIT Imports: 24 Imported by: 0

Documentation

Overview

Package AudioEffectDistortion provides methods for working with AudioEffectDistortion object instances.

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

func (self *Extension[T]) AsAudioEffectDistortion() 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.AudioEffectDistortion

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.

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

func (self Instance) AsAudioEffectDistortion() 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) Drive

func (self Instance) Drive() Float.X

func (Instance) ID

func (self Instance) ID() ID

func (Instance) KeepHfHz

func (self Instance) KeepHfHz() Float.X

func (Instance) Mode

func (self Instance) Mode() Mode

func (Instance) PostGain

func (self Instance) PostGain() Float.X

func (Instance) PreGain

func (self Instance) PreGain() Float.X

func (Instance) SetDrive

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

func (Instance) SetKeepHfHz

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

func (Instance) SetMode

func (self Instance) SetMode(value Mode)

func (*Instance) SetObject

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

func (Instance) SetPostGain

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

func (Instance) SetPreGain

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

func (Instance) Virtual

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

type Mode

type Mode int //gd:AudioEffectDistortion.Mode
const (
	/*Digital distortion effect which cuts off peaks at the top and bottom of the waveform.*/
	ModeClip Mode = 0
	ModeAtan Mode = 1
	/*Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.*/
	ModeLofi Mode = 2
	/*Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The [member drive] property has no effect in this mode.*/
	ModeOverdrive Mode = 3
	/*Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.*/
	ModeWaveshape Mode = 4
)

Jump to

Keyboard shortcuts

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