Enum Class AddressableLED.ColorOrder

java.lang.Object

java.lang.Enum<AddressableLED.ColorOrder>

org.wpilib.hardware.led.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 Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BGR	BGR order.
BRG	BRG order.
GBR	GBR order.
GRB	GRB order.
RBG	RBG order.
RGB	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 Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RGB

public static final AddressableLED.ColorOrder RGB

RGB order.

RBG

public static final AddressableLED.ColorOrder RBG

RBG order.

BGR

public static final AddressableLED.ColorOrder BGR

BGR order.

BRG

public static final AddressableLED.ColorOrder BRG

BRG order.

GBR

public static final AddressableLED.ColorOrder GBR

GBR order.

GRB

public static final AddressableLED.ColorOrder GRB

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