AudioEffectDistortion

Documentation

Overview

Package AudioEffectDistortion provides methods for working with AudioEffectDistortion object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioEffect() AudioEffect.Instance
  • func (self Instance) AsAudioEffectDistortion() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) Drive() Float.X
  • func (self Instance) KeepHfHz() Float.X
  • func (self Instance) Mode() gdclass.AudioEffectDistortionMode
  • func (self Instance) PostGain() Float.X
  • func (self Instance) PreGain() Float.X
  • func (self Instance) SetDrive(value Float.X)
  • func (self Instance) SetKeepHfHz(value Float.X)
  • func (self Instance) SetMode(value gdclass.AudioEffectDistortionMode)
  • func (self Instance) SetPostGain(value Float.X)
  • func (self Instance) SetPreGain(value Float.X)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Mode

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

func (self Instance) KeepHfHz() Float.X

func (Instance) Mode

func (self Instance) Mode() gdclass.AudioEffectDistortionMode

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 gdclass.AudioEffectDistortionMode)

func (Instance) SetPostGain

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

func (Instance) SetPreGain

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

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type Mode

type Mode = gdclass.AudioEffectDistortionMode //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
)