SCE Pulse / Stroboscope

   Print  Previous  Next

Functions Provided By SCE Pulse / Stroboscope

Function

Description

void SetColor(color col)

Sets the color for the effect.

color GetColor()

Returns the currently set color.

void SetFrequency(int frequency)

Sets the frequency for the pulse mode. Valid values range from 1 to 25.

int GetFrequency()

Returns the frequency for the pulse mode.

void SetOnTime(float time)

Sets the time the flash is activated for the strobe mode. The given time must be greater 0.

float GetOnTime()

Returns the current time the flash is activated for the strobe mode.

void SetOffTime(float time)

Sets the time the flash is off for the strobe mode. The given time must be greater 0.

float GetOffTime()

Returns the current time the flash is off for the strobe mode.

void SetMode(int mode)

Sets the mode for the effect. This may be pulse or strobe mode. See table below for valid values.

int GetMode()

Returns the current mode of the effect. See table below for values handed back.

void SetFade(int enable)

Disables fade if enable is false, otherwise it will be enabled.

int GetFade()

Returns true if fade is enabled, otherwise false.

 

This Effect uses the Color Picker. Learn more about Using Colors.

 

Effect Modes

This effect supports the two modes "pulse" and "strobe". To change the mode, call the function SetMode using one the following parameters.

Value

Description

MODE_PULSE

Activates pulse mode.

MODE_STROBO

Activates strobe mode.