Next: , Previous: Sound Board, Up: Core APIs


5.6 General Illumination

General illumination allows for additional lighting that is managed in groups of lamps, which are all enabled and disabled at the same time. These are often referred to as GI "strings". FreeWPC supports a maximum of 8 strings.

On the WPC platform, GI can be dimmed, because the controls for these strings are governed through triacs. (On WPC-95, some of the GI are dimmable and some are not.)

gi_enable
Turns on one or more GI strings. The argument given is a bitmask where each bit corresponds to an entire set of lamps (thus, we support at most 8 strings).
gi_disable
Turns off one or more GI strings.
gi_dim
Dims one or more GI strings. This is like gi_enable, but it takes an extra parameter, which specifies the intensity of the lamps. Not all hardware supports dimming. If dimming is not supported, then this API is unavailable and will cause a compiler error.