de.sciss.synth.ugen

Type members

Classlikes

Companion
class
final case
class AudioControl(values: IndexedSeq[Float], ctrlName: Option[String]) extends MultiOut with AudioRated
Companion
object
final case
class AudioControlProxy(values: IndexedSeq[Float], name: Option[String]) extends ControlProxyLike with AudioRated
Companion
object

Binary operations are generally constructed by calling one of the methods of GEOps.

Binary operations are generally constructed by calling one of the methods of GEOps.

See also

GEOps

UnaryOpUGen

Companion
class
abstract
class BinaryOpUGen extends SingleOut
Companion
object
case
object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Companion
class
final case
class ChannelProxy(elem: GE, index: Int) extends Lazy

A helper graph element that selects a particular output channel of another element. The index is an Integer and thus cannot be determined at graph expansion time. If this is desired, the Select UGen can be used.

A helper graph element that selects a particular output channel of another element. The index is an Integer and thus cannot be determined at graph expansion time. If this is desired, the Select UGen can be used.

Usually the graph element operator \ (backlash) can be used instead of explicitly writing ChannelProxy. Thus elem \ index is equivalent to ChannelProxy(elem, index). UGens with a fixed number of outputs often have auxiliary methods to access the channels in meaningful way, e.g. Pitch has method freq and hasFreq, which are equivalent to pitch \ 0 and pitch \ 1.

Because ScalaCollider allows late-expanding graph elements, we have no direct way to get some array of a UGen's outputs.

===Examples===

// frequency of a pitch estimator
play {
 val sin = SinOsc.ar(MouseX.kr(10, 10000, warp = 1))
 val pch = Pitch.kr(sin)
 val freq = pch \ 0  // same as pch.freq
 freq.poll(label = "freq")
 ()
}
Value Params
elem

a multi-channel element from which to select a channel.

index

channel index starting at zero. It automatically wraps around the actual number of channels the input elem expands to.

See also

NumChannels

Select

Companion
object
object Constant
Companion
class
final case
class Constant(value: Float) extends UGenIn with ScalarRated

A scalar constant used as an input to a UGen. These constants are stored in a separate table of the synth graph.

A scalar constant used as an input to a UGen. These constants are stored in a separate table of the synth graph.

Companion
object
object Control extends ProductReader[Control]
Companion
class
final case
class Control(rate: Rate, values: IndexedSeq[Float], ctrlName: Option[String]) extends MultiOut
Companion
object
final
Companion
class
final case
class ControlProxy(rate: Rate, values: IndexedSeq[Float], name: Option[String]) extends ControlProxyLike
Companion
object
Companion
class
final
class ControlProxyFactory(val this: String) extends AnyVal
Companion
object
trait ControlProxyLike extends GE
final case
class ControlUGenOutProxy(source: ControlProxyLike, outputIndex: Int) extends UGenIn

A ControlOutProxy is similar to a UGenOutProxy in that it denotes an output channel of a control UGen. However it refers to a control-proxy instead of a real control ugen, since the proxies are synthesized into actual ugens only at the end of a synth graph creation, in order to clump several controls together. ControlOutProxy instance are typically returned from the ControlProxyFactory class, that is, using the package implicits, from calls such as "myControl".kr.

A ControlOutProxy is similar to a UGenOutProxy in that it denotes an output channel of a control UGen. However it refers to a control-proxy instead of a real control ugen, since the proxies are synthesized into actual ugens only at the end of a synth graph creation, in order to clump several controls together. ControlOutProxy instance are typically returned from the ControlProxyFactory class, that is, using the package implicits, from calls such as "myControl".kr.

Companion
class
final case
class ControlValues(seq: IndexedSeq[Float])
Companion
object
object GESeq extends ProductReader[GESeq]
Companion
class
final case
class GESeq(elems: IndexedSeq[GE]) extends GE
Companion
object
object MulAdd extends ProductReader[MulAdd]
Companion
class
final case
class MulAdd(in: GE, mul: GE, add: GE) extends SingleOut

A UGen that multiplies an input with another signal and then adds a third signal. This can be used to translate an element into a different value range.

A UGen that multiplies an input with another signal and then adds a third signal. This can be used to translate an element into a different value range.

Usually the graph element operator mulAdd is used instead of explicitly writing MulAdd.

MulAdd(in, mul, add) == in.mulAdd(mul, add) == in * mul + add

===Examples===

// scale value range
play {
 // input range -1 to +1,
 // output range ((-1 * 100) + 300) = 200
 // to           ((+1 * 100) + 300) = 400
 val freq = SinOsc.kr(1).mulAdd(100, 300) // or MulAdd(..., 100, 300)
 freq.poll(label = "freq")
 SinOsc.ar(freq) * 0.1
}
Value Params
add

the offset, added after applying the multiplication

in

the input signal to scale and offset

mul

the scaling factor, applied first to the input

See also
Companion
object
object Nyquist extends ProductReader[Nyquist]

A helper graph element equivalent to SampleRate.ir * 0.5.

A helper graph element equivalent to SampleRate.ir * 0.5.

===Examples===

// as frequency argument
play {
 Dust.ar(Nyquist()).pow(8)
}
See also

SampleRate

Companion
class
final case
class Nyquist() extends GE with ScalarRated

A helper graph element equivalent to SampleRate.ir * 0.5.

A helper graph element equivalent to SampleRate.ir * 0.5.

See also

SampleRate

Companion
object
object Sum3 extends ProductReader[Sum3]

A UGen to efficiently add three signals together. Usually used indirectly through Mix.

A UGen to efficiently add three signals together. Usually used indirectly through Mix.

See also
Companion
class
final case
class Sum3(in0: GE, in1: GE, in2: GE) extends SingleOut

A UGen to efficiently add three signals together. Usually used indirectly through Mix.

A UGen to efficiently add three signals together. Usually used indirectly through Mix.

Value Params
in0

first of the three inputs

in1

second of the three inputs

in2

third of the three inputs

See also
Companion
object
object Sum4 extends ProductReader[Sum4]

A UGen to efficiently add four signals together. Usually used indirectly through Mix.

A UGen to efficiently add four signals together. Usually used indirectly through Mix.

See also
Companion
class
final case
class Sum4(in0: GE, in1: GE, in2: GE, in3: GE) extends SingleOut

A UGen to efficiently add four signals together. Usually used indirectly through Mix.

A UGen to efficiently add four signals together. Usually used indirectly through Mix.

Value Params
in0

first of the four inputs

in1

second of the four inputs

in2

third of the four inputs

in3

fourth of the four inputs

See also
Companion
object
Companion
class
final case
class TrigControl(values: IndexedSeq[Float], ctrlName: Option[String]) extends MultiOut with ControlRated
Companion
object
final case
class TrigControlProxy(values: IndexedSeq[Float], name: Option[String]) extends ControlProxyLike with ControlRated
Companion
object
Companion
class
sealed
trait UGenInGroup extends UGenInLike

A trait that can be either a group of UGenInLike or a UGen.MultiOut

A trait that can be either a group of UGenInLike or a UGen.MultiOut

Companion
object
final case
class UGenOutProxy(source: MultiOut, outputIndex: Int) extends UGenIn with UGenProxy

A UGenOutProxy refers to a particular output of a multi-channel UGen. A sequence of these form the representation of a multi-channel-expanded UGen.

A UGenOutProxy refers to a particular output of a multi-channel UGen. A sequence of these form the representation of a multi-channel-expanded UGen.

sealed
trait UGenProxy extends UGenIn

Unary operations are generally constructed by calling one of the methods of GEOps.

Unary operations are generally constructed by calling one of the methods of GEOps.

See also

GEOps

BinaryOpUGen

Companion
class
abstract
class UnaryOpUGen extends SingleOut
Companion
object