Signal Display

Displays a graphical representation of a signal. Must be used with the display or dispfft opcodes in Csound.

fftdisplay bounds(x, y, width, height), colour("colour"), groundcolour("colour"), \
signalvariable("a-rate variables"), displaytype("type"), identchannel("channel"), alpha(val), \
visible(val), active(val), zoom(val), updaterate(val)


bounds(x, y, width, height) integer values that set position and size on screen(in pixels).

backgroundcolour("colour") This sets the background colour of the display. Any CSS or HTML colour string can be passed to this identifier. The colour identifier can also be passed an RBG, or RGBA value. All channel values must be between 0 and 255. For instance colour(0, 0, 255) will create a blue, while colour(0, 255, 0, 255) will create a green with an alpha channel set to full.

colour("colour") Sets the colour of the FFT data drawn to screen. See above for details on valid colours.

identchannel("channel") Sets the channel which messages from Csound are sent to the widget on. When used with a chnset opcode users can override widget attributes. See Identifier channels

alpha(val) A value between 0 and 1 will set the alpha blend value for the entire component. Can be useful if you need to fade widgets in and out.

visible(val) A value of 0 will cause the widget to become invisible. Widgets have their visibility set to 1 by default.

active(val) Will deactivate a control if 0 is passed. Controls which are deactivate can still be updated from Csound.

displaytype("type") Sets the the type of display. Must be 'spectrogram' or 'spectroscope', 'waveform' or 'lissajous'. Set to 'spectroscope by default.

signalvariable("variables") The Csound variable or variables passed to the display opcodes. If you use 'lissajous' you must pass two a-rate variables to this identifier.

zoom(val) Sets the initial zoom value. Passing a -1 to zoom will cause the zoom buttons to disappear.

updaterate(val) Set the rate at which the display will update. val determines the number of milliseconds between update. The update rate is set to 100 milliseconds by default, which means the display will update itself 10 times a second. Smaller update rates will produce smoother images, but will cost more in terms of CPU.
<!--(End of identifiers)/-->

To enable the use of the signaldisplay widget you must pass --displays to your CsOptions. See the FFTDisplay example for details. Also note that the Lissajous display is the most CPU expensive display option, followed by waveform. The spectral modes are the least CPU expensive.


form size(520, 350), caption("SignalDisplay")
signaldisplay bounds(10, 0, 500, 300), colour("cornflowerblue"), signavariable("aOutput")
button bounds(12, 304, 120, 25), channel("displaytype"), text("Spectroscope", "Spectrogram")