Package com.ctre.phoenix.led

Class RgbFadeAnimation

java.lang.Object

com.ctre.phoenix.led.Animation

com.ctre.phoenix.led.RgbFadeAnimation

@Deprecated(since="2026",
            forRemoval=true)
public class RgbFadeAnimation
extends Animation

Deprecated, for removal: This API element is subject to removal in a future version.

This device's Phoenix 5 API is deprecated for removal in the 2027 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue

Constructor Summary

Constructors

Constructor	Description
RgbFadeAnimation()	Deprecated, for removal: This API element is subject to removal in a future version. Constructor for an RgbFadeAnimation.
RgbFadeAnimation(double brightness, double speed, int numLed)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor for an RgbFadeAnimation
RgbFadeAnimation(double brightness, double speed, int numLed, int ledOffset)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor for an RgbFadeAnimation

Method Summary

Modifier and Type	Method	Description
com.ctre.phoenix.led.BaseStandardAnimation	getBaseStandardAnimation()	Deprecated, for removal: This API element is subject to removal in a future version.
com.ctre.phoenix.led.BaseTwoSizeAnimation	getBaseTwoSizeAnimation()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setBrightness(double brightness)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the brightness of this animation

Methods inherited from class com.ctre.phoenix.led.Animation

setLedOffset, setNumLed, setSpeed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RgbFadeAnimation

public RgbFadeAnimation(double brightness,
 double speed,
 int numLed,
 int ledOffset)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor for an RgbFadeAnimation

Parameters:

brightness - How bright the LEDs are [0, 1]

speed - How fast the LEDs fade between Red, Green, and Blue [0, 1]

numLed - How many LEDs are controlled by the CANdle

ledOffset - Where to start the animation

RgbFadeAnimation

public RgbFadeAnimation(double brightness,
 double speed,
 int numLed)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor for an RgbFadeAnimation

Parameters:

brightness - How bright the LEDs are [0, 1]

speed - How fast the LEDs fade between Red, Green, and Blue [0, 1]

numLed - How many LEDs are controlled by the CANdle

RgbFadeAnimation

public RgbFadeAnimation()

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor for an RgbFadeAnimation. Call the individual setters to tune the animation.

Method Details

setBrightness

public void setBrightness(double brightness)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets the brightness of this animation

Parameters:

brightness - The brightness to run the animation at. This is a scalar from [0, 1]

getBaseStandardAnimation

public com.ctre.phoenix.led.BaseStandardAnimation getBaseStandardAnimation()

Deprecated, for removal: This API element is subject to removal in a future version.

getBaseTwoSizeAnimation

public com.ctre.phoenix.led.BaseTwoSizeAnimation getBaseTwoSizeAnimation()

Deprecated, for removal: This API element is subject to removal in a future version.