« Back to Product

Documentation

DMX_FadeRGBDelayed

 boolean DMX_FadeRGBDelayed (int $InstanceID, int $R, int $G, int $B, float $FadeTime, float $DelayTime) 

Parameters

InstanceID

ID of the device to be switched

R

Brightness value 0 (off) to 255/65535 (8/16 bit) (on, maximum brightness)

G

Brightness value 0 (off) to 255/65535 (8/16 bit) (on, maximum brightness)

B

Brightness value 0 (off) to 255/65535 (8/16 bit) (on, maximum brightness)

FadeTime

Time in seconds

DelayTime

Time in seconds

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

Dims the red, green, and blue channels of ID InstanceID with a specific FadeTime. A delay time can be specified after which the dimming process is started.

Warning

If no delay time is specified, this command cancels all fadings set for the affected channels via DMX_fadergbDelayed. This allows a new chain of delayed fadings to be set cleanly. If delayed fading is not used, this note is not relevant

Example

//Dims a module completely up and down to yellow. 

//8bit
//Dim the instance to yellow within 5 seconds
DMX_FadeRGB(12345, 255, 255, 0, 5.0);
//Dim the instance to yellow within 2.5 seconds, after a delay of 5 seconds
DMX_FadeRGBDelayed(12345, 255, 255, 0, 2.5, 5);

//16 bit
//Dim the instance to yellow within 5 seconds
DMX_FadeRGB(12345, 65535, 65535, 0, 5.0);
//Dim the instance to yellow within 2.5 seconds, after a delay of 5 seconds
DMX_FadeRGBDelayed(12345, 65535, 65535, 0, 2.5, 5);
Any questions?