GFX_Module : AbstractGFX : Object

Extension

Description

Class Methods

GFX_Module.new(target, bus: 0, lags: 0.1, numChannels: 2, addAction: 'addToTail', args)

GFX_Module.newModule(efx, target, bus: 0, lags: 0.1, numChannels: 2, addAction: 'addToTail', args)

GFX_Module.ar

GFX_Module.specs

GFX_Module.allSubclasses

Inherited class methods

Instance Methods

.order

.prefix

Synth

.lags = val

Convenience methods

.openCodeFile

Generated methods

.pause

Boolean. Get or set the running state (see Node: -run). Can be used for saving CPU. Modules are then automatically unpaused as soon as the mix parameter is > 0.0. It is also possible to double-click the horizontal label in the GUI to pause and unpause a module.g= GFXPch2(); g.pause= true;

NOTE: might click with reverb and delay effect modules.

...Mix

Float. Get or set the dry/wet mix 0.0 - 1.0. Exact method name will depend on class name.g= GFXPch2(); g.pch2Mix= 0.5;

...Name

Get or set effect parameters. Exact method names are defined in the *specs class method.g= GFXPch2(); g.pch2Ratio= 2.4;

Inherited instance methods

Undocumented instance methods

.code(verbose: false)

.gui(position, version: 0)

Examples

Basics

Writing custom modules

It is fairly easy to add your own custom effect modules. Just follow the following guidelines...

• Write a class that is a subclass of GFX_Module.
• Add two class methods called *ar and *specs.
• For *ar the first argument must be called in. This argument will be the incoming audio and should deal with any number of channels.
• Additional *ar arguments should not use the reserved names mix, pause, lags and bus.
• *ar argument order will determine parameter sorting in the GUI.
• The *specs class method should return an Event with parameter names as keys and specs as values. There is a little bit of magic here as the key names should follow the naming convention prefixParameter.

Simple module example class...GFXFreq : GFX_Module { *ar {|in, shift= -50| ^FreqShift.ar(in, shift) } *specs { ^( freqShift: ControlSpec(-1000, 1000) ) } }

See the classes in the folder Modules for more examples.

A properly written class can be used like any other module - including being added to a GFX_Rack, as a SynthDef variant (with optional GUI) or as a pseudo UGen variant...GFXFreq().gui; //SynthDef variant with GUI {GFXFreq.ar(SinOsc.ar)}.play; //pseudo UGen variant

A special feature is that when used in a rack, a module will be sent the parameter 'feedback'. This is the index of an internal audio bus that is tapped from the rack output pre volume fader. See the GFXFeed module for an example.