net.lenni0451.commons.color

Class ColorConverter

java.lang.Object

net.lenni0451.commons.color.ColorConverter

public class ColorConverter
extends java.lang.Object

Convert colors between different formats.

Field Summary

Fields

Modifier and Type	Field and Description
static ColorConverter	ABGR The ABGR color format (0xAA_BB_GG_RR).
static ColorConverter	ARGB The ARGB color format (0xAA_RR_GG_BB).
static ColorConverter	BGR The BGR color format (0xBB_GG_RR).
static ColorConverter	BGRA The BGRA color format (0xBB_GG_RR_AA).
static ColorConverter	RGB The RGB color format (0xRR_GG_BB).
static ColorConverter	RGBA The RGBA color format (0xRR_GG_BB_AA).

Constructor Summary

Constructors

Constructor and Description
ColorConverter(int rShift, int gShift, int bShift) Create a new color converter.
ColorConverter(int rShift, int gShift, int bShift, int aShift) Create a new color converter.

Method Summary

Modifier and Type	Method and Description
static float[]	convert(float[] color, ColorConverter from, ColorConverter to) Convert a color from one format to another.
static int	convert(int color, ColorConverter from, ColorConverter to) Convert a color from one format to another.
static float[]	convertToFloats(int color, ColorConverter from, ColorConverter to) Convert an int color representation to a float color representation.
static int	convertToInt(float[] color, ColorConverter from, ColorConverter to) Convert a float color representation to an int color representation.
java.awt.Color	from(float[] color) Convert the float representation of a color to a color.
java.awt.Color	from(float r, float g, float b) Convert the float representation of a color to a color.
java.awt.Color	from(float r, float g, float b, float a) Convert the float representation of a color to a color.
java.awt.Color	from(int color) Convert the int representation of a color to a color.
float	getAlpha(float[] color) Get the alpha value of a color.
int	getAlpha(int color) Get the alpha value of a color.
float	getBlue(float[] color) Get the blue value of a color.
int	getBlue(int color) Get the blue value of a color.
float	getGreen(float[] color) Get the green value of a color.
int	getGreen(int color) Get the green value of a color.
float	getRed(float[] color) Get the red value of a color.
int	getRed(int color) Get the red value of a color.
float[]	setAlpha(float[] color, float a) Set the alpha value of a color.
int	setAlpha(int color, int a) Set the alpha value of a color.
float[]	setBlue(float[] color, float b) Set the blue value of a color.
int	setBlue(int color, int b) Set the blue value of a color.
float[]	setGreen(float[] color, float g) Set the green value of a color.
int	setGreen(int color, int g) Set the green value of a color.
float[]	setRed(float[] color, float r) Set the red value of a color.
int	setRed(int color, int r) Set the red value of a color.
int	to(java.awt.Color color) Convert a color to its int representation.
int	to(float r, float g, float b, float a) Convert a color to its int representation.
int	to(int r, int g, int b, int a) Convert a color to its int representation.
float[]	toFloats(java.awt.Color color) Convert a color to its float representation.
float[]	toFloats(float r, float g, float b, float a) Convert a color to its float representation.
float[]	toFloats(int r, int g, int b) Convert a color to its float representation.
float[]	toFloats(int r, int g, int b, int a) Convert a color to its float representation.

Methods inherited from class java.lang.Object

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

Field Detail

RGB

public static final ColorConverter RGB

The RGB color format (0xRR_GG_BB).

ARGB

public static final ColorConverter ARGB

The ARGB color format (0xAA_RR_GG_BB).

RGBA

public static final ColorConverter RGBA

The RGBA color format (0xRR_GG_BB_AA).

BGR

public static final ColorConverter BGR

The BGR color format (0xBB_GG_RR).

ABGR

public static final ColorConverter ABGR

The ABGR color format (0xAA_BB_GG_RR).

BGRA

public static final ColorConverter BGRA

The BGRA color format (0xBB_GG_RR_AA).

Constructor Detail

ColorConverter

public ColorConverter(int rShift,
                      int gShift,
                      int bShift)

Create a new color converter.
The shifts have to be a multiple of 8.

Parameters:

rShift - The shift for the red value

gShift - The shift for the green value

bShift - The shift for the blue value

ColorConverter

public ColorConverter(int rShift,
                      int gShift,
                      int bShift,
                      int aShift)

Create a new color converter.
The shifts have to be a multiple of 8.

Parameters:

rShift - The shift for the red value

gShift - The shift for the green value

bShift - The shift for the blue value

aShift - The shift for the alpha value

Method Detail

convert

public static int convert(int color,
                          ColorConverter from,
                          ColorConverter to)

Convert a color from one format to another.

Parameters:

color - The color to convert

from - The format the color is in

to - The format to convert the color to

Returns:

The converted color

convert

public static float[] convert(float[] color,
                              ColorConverter from,
                              ColorConverter to)

Convert a color from one format to another.

Parameters:

color - The color to convert

from - The format the color is in

to - The format to convert the color to

Returns:

The converted color

convertToInt

public static int convertToInt(float[] color,
                               ColorConverter from,
                               ColorConverter to)

Convert a float color representation to an int color representation.

Parameters:

color - The color to convert

from - The format the color is in

to - The format to convert the color to

Returns:

The converted color

convertToFloats

public static float[] convertToFloats(int color,
                                      ColorConverter from,
                                      ColorConverter to)

Convert an int color representation to a float color representation.

Parameters:

color - The color to convert

from - The format the color is in

to - The format to convert the color to

Returns:

The converted color

getRed

public int getRed(int color)

Get the red value of a color.

Parameters:

color - The color

Returns:

The red value

getRed

public float getRed(float[] color)

Get the red value of a color.

Parameters:

color - The color

Returns:

The red value

setRed

public int setRed(int color,
                  int r)

Set the red value of a color.

Parameters:

color - The color to modify

r - The red value

Returns:

The new color

setRed

public float[] setRed(float[] color,
                      float r)

Set the red value of a color.

Parameters:

color - The color to modify

r - The red value

Returns:

The new color

getGreen

public int getGreen(int color)

Get the green value of a color.

Parameters:

color - The color

Returns:

The green value

getGreen

public float getGreen(float[] color)

Get the green value of a color.

Parameters:

color - The color

Returns:

The green value

setGreen

public int setGreen(int color,
                    int g)

Set the green value of a color.

Parameters:

color - The color to modify

g - The green value

Returns:

The new color

setGreen

public float[] setGreen(float[] color,
                        float g)

Set the green value of a color.

Parameters:

color - The color to modify

g - The green value

Returns:

The new color

getBlue

public int getBlue(int color)

Get the blue value of a color.

Parameters:

color - The color

Returns:

The blue value

getBlue

public float getBlue(float[] color)

Get the blue value of a color.

Parameters:

color - The color

Returns:

The blue value

setBlue

public int setBlue(int color,
                   int b)

Set the blue value of a color.

Parameters:

color - The color to modify

b - The blue value

Returns:

The new color

setBlue

public float[] setBlue(float[] color,
                       float b)

Set the blue value of a color.

Parameters:

color - The color to modify

b - The blue value

Returns:

The new color

getAlpha

public int getAlpha(int color)

Get the alpha value of a color.

Parameters:

color - The color

Returns:

The alpha value

getAlpha

public float getAlpha(float[] color)

Get the alpha value of a color.

Parameters:

color - The color

Returns:

The alpha value

setAlpha

public int setAlpha(int color,
                    int a)

Set the alpha value of a color.

Parameters:

color - The color to modify

a - The alpha value

Returns:

The new color

setAlpha

public float[] setAlpha(float[] color,
                        float a)

Set the alpha value of a color.

Parameters:

color - The color to modify

a - The alpha value

Returns:

The new color

to

public int to(java.awt.Color color)

Convert a color to its int representation.

Parameters:

color - The color

Returns:

The int representation

to

public int to(int r,
              int g,
              int b,
              int a)

Convert a color to its int representation.
If the format has no alpha value, the alpha value will be ignored.

Parameters:

r - The red value

g - The green value

b - The blue value

a - The alpha value

Returns:

The int representation

to

public int to(float r,
              float g,
              float b,
              float a)

Convert a color to its int representation.
If the format has no alpha value, the alpha value will be ignored.

Parameters:

r - The red value

g - The green value

b - The blue value

a - The alpha value

Returns:

The int representation

toFloats

public float[] toFloats(java.awt.Color color)

Convert a color to its float representation.

Parameters:

color - The color

Returns:

The float representation

toFloats

public float[] toFloats(int r,
                        int g,
                        int b)

Convert a color to its float representation.
If the format has an alpha value, it will be set to 1.

Parameters:

r - The red value

g - The green value

b - The blue value

Returns:

The float representation

toFloats

public float[] toFloats(int r,
                        int g,
                        int b,
                        int a)

Convert a color to its float representation.
If the format has no alpha value, the alpha value will be ignored.

Parameters:

r - The red value

g - The green value

b - The blue value

a - The alpha value

Returns:

The float representation

toFloats

public float[] toFloats(float r,
                        float g,
                        float b,
                        float a)

Convert a color to its float representation.
If the format has no alpha value, the alpha value will be ignored.

Parameters:

r - The red value

g - The green value

b - The blue value

a - The alpha value

Returns:

The float representation

from

public java.awt.Color from(int color)

Convert the int representation of a color to a color.

Parameters:

color - The int representation

Returns:

The color

from

public java.awt.Color from(float[] color)

Convert the float representation of a color to a color.

Parameters:

color - The float representation

Returns:

The color

from

public java.awt.Color from(float r,
                           float g,
                           float b)

Convert the float representation of a color to a color.

Parameters:

r - The red value

g - The green value

b - The blue value

Returns:

The color

from

public java.awt.Color from(float r,
                           float g,
                           float b,
                           float a)

Convert the float representation of a color to a color.

Parameters:

r - The red value

g - The green value

b - The blue value

a - The alpha value

Returns:

The color