Package edu.wpi.first.util

Enum PixelFormat

java.lang.Object

java.lang.Enum<PixelFormat>

edu.wpi.first.util.PixelFormat

All Implemented Interfaces:

Serializable, Comparable<PixelFormat>, Constable

public enum PixelFormat
extends Enum<PixelFormat>

Image pixel format.

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 8-8-8, 24 bpp.
kBGRA	BGRA 8-8-8-8.
kGray	Grayscale, 8 bpp.
kMJPEG	Motion-JPEG (compressed image data).
kRGB565	RGB 5-6-5, 16 bpp.
kUnknown	Unknown format.
kUYVY	YUV 4:2:2, 16 bpp.
kY16	Grayscale, 16 bpp.
kYUYV	YUY 4:2:2, 16 bpp.

Method Summary

Modifier and Type	Method	Description
static PixelFormat	getFromInt(int pixelFormat)	Gets a PixelFormat enum value from its integer value.
int	getValue()	Gets the integer value of the pixel format.
static PixelFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PixelFormat[]	values()	Returns an array containing the constants of this enum type, 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

kUnknown

public static final PixelFormat kUnknown

Unknown format.

kMJPEG

public static final PixelFormat kMJPEG

Motion-JPEG (compressed image data).

kYUYV

public static final PixelFormat kYUYV

YUY 4:2:2, 16 bpp.

kRGB565

public static final PixelFormat kRGB565

RGB 5-6-5, 16 bpp.

kBGR

public static final PixelFormat kBGR

BGR 8-8-8, 24 bpp.

kGray

public static final PixelFormat kGray

Grayscale, 8 bpp.

kY16

public static final PixelFormat kY16

Grayscale, 16 bpp.

kUYVY

public static final PixelFormat kUYVY

YUV 4:2:2, 16 bpp.

kBGRA

public static final PixelFormat kBGRA

BGRA 8-8-8-8. 32 bpp.

Method Details

values

public static PixelFormat[] values()

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

Returns:

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

valueOf

public static PixelFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Gets the integer value of the pixel format.

Returns:

Integer value

getFromInt

public static PixelFormat getFromInt(int pixelFormat)

Gets a PixelFormat enum value from its integer value.

Parameters:

pixelFormat - integer value

Returns:

Enum value