Package codechicken.lib.colour

Class Colour

java.lang.Object

codechicken.lib.colour.Colour

All Implemented Interfaces:

Copyable<Colour>

Direct Known Subclasses:

ColourARGB, ColourRGBA

public abstract class Colour
extends Object
implements Copyable<Colour>

Field Summary

Fields

Modifier and Type	Field	Description
byte	a
byte	b
byte	g
byte	r

Constructor Summary

Constructors

Constructor	Description
Colour(int r, int g, int b, int a)
Colour(Colour colour)

Method Summary

Modifier and Type	Method	Description
int	a()
static int	add(int c1, int c2)	For each color component in c1 and c2, adds them together clamping to 0 - 255.
Colour	add(Colour colour2)
float	aF()
Colour	aF(float a)
Colour	aF(int a)
int	argb()
int	b()
float	bF()
Colour	bF(float b)
Colour	bF(int b)
abstract Colour	copy()
boolean	equals(@Nullable Colour other)
boolean	equals(Object o)
static int	flipABGR(int colour)	Flips a color between ABGR and RGBA.
int	g()
float[]	getARGB()
float[]	getRGBA()
float	gF()
Colour	gF(float g)
Colour	gF(int g)
int	hashCode()
Colour	interpolate(Colour colour2, double d)
Colour	invert()
static int	mid(int c1, int c2)	For each color component in c1 and c2, calculates the midpoint.
Colour	multiply(Colour colour2)
Colour	multiplyC(double d)
abstract int	pack()
static int	pack(int[] data)
static int	pack(int c, int i)
static int	packARGB(byte r, byte g, byte b, byte a)
static int	packARGB(double r, double g, double b, double a)
static int	packARGB(float[] data)
static int	packARGB(int r, int g, int b, int a)
abstract float[]	packArray()
static int	packRGBA(byte r, byte g, byte b, byte a)
static int	packRGBA(double r, double g, double b, double a)
static int	packRGBA(float[] data)
static int	packRGBA(int r, int g, int b, int a)
int	r()
static int	replace(int c, int i, float v)
static int	replace(int c, int i, int v)	Replace the packed 8-bit color component at the specified index.
float	rF()
Colour	rF(float r)
Colour	rF(int r)
int	rgb()
int	rgba()
Colour	scale(double d)
Colour	set(double[] doubles)
Colour	set(double r, double g, double b, double a)
Colour	set(float[] floats)
Colour	set(float r, float g, float b, float a)
abstract Colour	set(int colour)
Colour	set(int r, int g, int b, int a)
Colour	set(Colour colour)
static int	sub(int c1, int c2)	For each color component in c1 and c2, subtracts them clamping to 0 - 255.
Colour	sub(Colour colour2)
String	toString()
static int[]	unpack(int colour)
static int	unpack(int c, int i)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

r

public byte r

g

public byte g

b

public byte b

a

public byte a

Constructor Details

Colour

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

Colour

public Colour(Colour colour)

Method Details

pack

public abstract int pack()

packArray

public abstract float[] packArray()

add

public Colour add(Colour colour2)

sub

public Colour sub(Colour colour2)

invert

public Colour invert()

multiply

public Colour multiply(Colour colour2)

scale

public Colour scale(double d)

interpolate

public Colour interpolate(Colour colour2,
 double d)

multiplyC

public Colour multiplyC(double d)

copy

public abstract Colour copy()

Specified by:

copy in interface Copyable<Colour>

rgb

public int rgb()

argb

public int argb()

rgba

public int rgba()

set

public abstract Colour set(int colour)

set

public Colour set(Colour colour)

set

public Colour set(double r,
 double g,
 double b,
 double a)

set

public Colour set(float r,
 float g,
 float b,
 float a)

set

public Colour set(int r,
 int g,
 int b,
 int a)

set

public Colour set(double[] doubles)

set

public Colour set(float[] floats)

rF

public Colour rF(float r)

gF

public Colour gF(float g)

bF

public Colour bF(float b)

aF

public Colour aF(float a)

rF

public Colour rF(int r)

gF

public Colour gF(int g)

bF

public Colour bF(int b)

aF

public Colour aF(int a)

rF

public float rF()

gF

public float gF()

bF

public float bF()

aF

public float aF()

r

public int r()

g

public int g()

b

public int b()

a

public int a()

flipABGR

public static int flipABGR(int colour)

Flips a color between ABGR and RGBA.

Parameters:

colour - The input either ABGR or RGBA.

Returns:

The flipped color.

unpack

public static int[] unpack(int colour)

pack

public static int pack(int[] data)

getRGBA

public float[] getRGBA()

getARGB

public float[] getARGB()

packRGBA

public static int packRGBA(byte r,
 byte g,
 byte b,
 byte a)

packARGB

public static int packARGB(byte r,
 byte g,
 byte b,
 byte a)

packRGBA

public static int packRGBA(int r,
 int g,
 int b,
 int a)

packARGB

public static int packARGB(int r,
 int g,
 int b,
 int a)

packRGBA

public static int packRGBA(double r,
 double g,
 double b,
 double a)

packARGB

public static int packARGB(double r,
 double g,
 double b,
 double a)

packRGBA

public static int packRGBA(float[] data)

packARGB

public static int packARGB(float[] data)

replace

public static int replace(int c,
 int i,
 float v)

replace

public static int replace(int c,
 int i,
 int v)

Replace the packed 8-bit color component at the specified index.

Parameters:

c - The packed color.

i - The index to replace.

v - The value to replace with.

Returns:

The new packed color.

unpack

public static int unpack(int c,
 int i)

pack

public static int pack(int c,
 int i)

add

public static int add(int c1,
 int c2)

For each color component in c1 and c2, adds them together clamping to 0 - 255.

Agnostic of color packing order.

sub

public static int sub(int c1,
 int c2)

For each color component in c1 and c2, subtracts them clamping to 0 - 255.

Agnostic of color packing order.

mid

public static int mid(int c1,
 int c2)

For each color component in c1 and c2, calculates the midpoint.

Agnostic of color packing order.

equals

public boolean equals(@Nullable
 @Nullable Colour other)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object