Package edu.wpi.first.wpilibj

Enum Class AddressableLED.ColorOrder

java.lang.Object

java.lang.Enum<AddressableLED.ColorOrder>

edu.wpi.first.wpilibj.AddressableLED.ColorOrder

All Implemented Interfaces:

Serializable, Comparable<AddressableLED.ColorOrder>, Constable

Enclosing class:

AddressableLED

public static enum AddressableLED.ColorOrder
extends Enum<AddressableLED.ColorOrder>

Order that color data is sent over the wire.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kBGR	BGR order.
kBRG	BRG order.
kGBR	GBR order.
kGRB	GRB order.
kRBG	RBG order.
kRGB	RGB order.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	The native value for this ColorOrder.

Method Summary

Modifier and Type	Method	Description
AddressableLED.ColorOrder	fromValue(int value)	Gets a color order from an int value.
static AddressableLED.ColorOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AddressableLED.ColorOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kRGB

public static final AddressableLED.ColorOrder kRGB

RGB order.

kRBG

public static final AddressableLED.ColorOrder kRBG

RBG order.

kBGR

public static final AddressableLED.ColorOrder kBGR

BGR order.

kBRG

public static final AddressableLED.ColorOrder kBRG

BRG order.

kGBR

public static final AddressableLED.ColorOrder kGBR

GBR order.

kGRB

public static final AddressableLED.ColorOrder kGRB

GRB order. This is the default order.

Field Details

value

public final int value

The native value for this ColorOrder.

Method Details

values

public static AddressableLED.ColorOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AddressableLED.ColorOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public AddressableLED.ColorOrder fromValue(int value)

Gets a color order from an int value.

Parameters:

value - int value

Returns:

color order