kink Reference

Distort a sawtooth waveform or event rate linear ramp values.

kink

Examples

Arguments

slope [number]

Optional

The multiplier that affects the slope of the output between an output (Y) value of 0 and 0.5.

After the output reaches 0.5, the output ramp will increase to 1 so that the entire output moves from 0 to 1 in the same period of time as the input. A slope multiplier of 1 produces no distortion. Slope multipliers below 1 have a slower rise to 0.5 than the input, and slope multipliers above 1 have a faster rise to 0.5 than the input.

Inlets

x [number]

The input to kink should be a linear ramp of values that repeatedly goes from 0 to 1.

slope [number]

The multiplier that affects the slope of the output between an output (Y) value of 0 and 0.5.

After the output reaches 0.5, the output ramp will increase to 1 so that the entire output moves from 0 to 1 in the same period of time as the input. A slope multiplier of 1 produces no distortion. Slope multipliers below 1 have a slower rise to 0.5 than the input, and slope multipliers above 1 have a faster rise to 0.5 than the input.

Outlets

Out [number]

If the kink objects slope is less than 0.5, that value is output. Otherwise, a complementary slope is used which is equal to 0.5 at the same input value but equal to 1 when the input is 1. This creates a "kink" in the linear ramp when the slope is not equal to 1.

Fixed Attributes

These attributes must be set in the object box and determine the behavior of the object at runtime.

hot [bool] (default: false)

Trigger computation on all inlets.

Dynamic Attributes

These attributes can be modified in the code during execution using the set object

reset [bang] (default: 0)

Banging this attribute will reset the object to its default state.

slope [number]

The multiplier that affects the slope of the output between an output (Y) value of 0 and 0.5.

After the output reaches 0.5, the output ramp will increase to 1 so that the entire output moves from 0 to 1 in the same period of time as the input. A slope multiplier of 1 produces no distortion. Slope multipliers below 1 have a slower rise to 0.5 than the input, and slope multipliers above 1 have a faster rise to 0.5 than the input.

x [number]

The input to kink should be a linear ramp of values that repeatedly goes from 0 to 1.

See Also

Name Description
kink~ Distort a sawtooth waveform
phasor~ Generate sawtooth signals
line~ Linear ramp generator
cycle~ A periodic waveform oscillator.