Class Colors

java.lang.Object

com.botwithus.bot.api.draw.Colors

public final class Colors
extends Object

Packed 0xAARRGGBB colours for debug drawing, and the two helpers for building one.

Every named constant is fully opaque. Blend by passing an explicit alpha through withAlpha(int, int) or argb(int, int, int, int) — a colour with a zero alpha draws nothing, which looks exactly like a broken overlay.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLACK
static final int	BLUE
static final int	CYAN
static final int	GREEN	The producer's own default when a command omits color.
static final int	GREY
static final int	MAGENTA
static final int	OPAQUE	Fully opaque alpha, as it appears in the top byte of an ARGB value.
static final int	ORANGE
static final int	RED
static final int	WHITE
static final int	YELLOW

Method Summary

Modifier and Type	Method	Description
static int	alphaOf(int argb)	The 0..255 alpha channel of a packed colour.
static int	argb(int alpha, int red, int green, int blue)	Pack four 0..255 channels.
static int	withAlpha(int argb, int alpha)	The same colour at a different 0..255 alpha.

Methods inherited from class Object

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

Field Details

OPAQUE

public static final int OPAQUE

Fully opaque alpha, as it appears in the top byte of an ARGB value.

See Also:

• Constant Field Values

GREEN

public static final int GREEN

The producer's own default when a command omits color.

See Also:

• Constant Field Values

RED

public static final int RED

See Also:

• Constant Field Values

BLUE

public static final int BLUE

See Also:

• Constant Field Values

CYAN

public static final int CYAN

See Also:

• Constant Field Values

MAGENTA

public static final int MAGENTA

See Also:

• Constant Field Values

YELLOW

public static final int YELLOW

See Also:

• Constant Field Values

ORANGE

public static final int ORANGE

See Also:

• Constant Field Values

WHITE

public static final int WHITE

See Also:

• Constant Field Values

BLACK

public static final int BLACK

See Also:

• Constant Field Values

GREY

public static final int GREY

See Also:

• Constant Field Values

Method Details

argb

public static int argb(int alpha,
 int red,
 int green,
 int blue)

Pack four 0..255 channels. Values outside that range are masked rather than rejected, so an arithmetic overflow in a caller's colour ramp cannot bleed into a neighbouring channel.

withAlpha

public static int withAlpha(int argb,
 int alpha)

The same colour at a different 0..255 alpha.

alphaOf

public static int alphaOf(int argb)

The 0..255 alpha channel of a packed colour.