org.dayflower.pathtracer.color

Class Color

java.lang.Object

org.dayflower.pathtracer.color.Color

public final class Color
extends java.lang.Object

The Color class is used to encapsulate colors in the default sRGB color space.

This class is immutable and therefore suitable for concurrent use without external synchronization.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
float	a The value of the alpha component (A).
float	b The value of the blue component (B).
static Color	BLACK A Color denoting the color black.
static Color	BLUE A Color denoting the color blue.
static Color	CYAN A Color denoting the color cyan.
static float	DEFAULT_GAMMA The default gamma used in gamma correction.
float	g The value of the green component (G).
static Color	GRAY A Color denoting the color gray.
static Color	GREEN A Color denoting the color green.
static Color	MAGENTA A Color denoting the color magenta.
static Color	ORANGE A Color denoting the color orange.
float	r The value of the red component (R).
static Color	RED A Color denoting the color red.
static Color	TRANSPARENT A Color denoting total transparency.
static Color	WHITE A Color denoting the color white.
static Color	YELLOW A Color denoting the color yellow.

Constructor Summary

Constructors

Constructor and Description
Color() Constructs a new Color instance denoting the color black.
Color(float r, float g, float b) Constructs a new Color instance given the specified components.
Color(float r, float g, float b, float a) Constructs a new Color instance given the specified components.
Color(int rGB) Constructs a new Color instance given the specified RGB-value.
Color(int r, int g, int b) Constructs a new Color instance given the specified RGB-values.
Color(int r, int g, int b, int a) Constructs a new Color instance given the specified RGBA-values.

Method Summary

Modifier and Type	Method and Description
Color	add(Color color) Adds color to this Color instance.
Color	add(float s) Adds s to the R-, G- and B-component values of this Color instance.
Color	add(float r, float g, float b) Adds r, g and b to the R-, G- and B-component values of this Color instance, respectively.
Color	add(float r, float g, float b, float a) Adds r, g, b and a to the R-, G-, B- and A-component values of this Color instance, respectively.
Color	applyGammaCorrection() Applies Gamma Correction to this Color instance.
Color	applyGammaCorrection(float gamma) Applies Gamma Correction to this Color instance.
Color	applyToneMapping() Applies Tone Mapping to this Color instance.
Color	applyToneMapping(ToneMapper toneMapper) Applies Tone Mapping to this Color instance.
float	average() Returns the average value of the RGB-component values of this Color instance.
Color	constrain() Constrains this Color instance to be representable.
Color	divide(Color color) Divides this Color instance with color.
Color	divide(float s) Divides the R-, G- and B-component values of this Color instance with s.
Color	divide(float r, float g, float b) Divides the R-, G- and B-component values of this Color instance with r, g and b, respectively.
Color	divide(float r, float g, float b, float a) Divides the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.
boolean	equals(java.lang.Object object) Compares object to this Color instance for equality.
Color	exp() Returns a new Color instance with Euler's number e raised to the power of each RGB-component value.
float	getA() Returns the value of the A component.
float	getB() Returns the value of the B component.
float	getG() Returns the value of the G component.
float	getR() Returns the value of the R component.
int	hashCode() Returns a hash code for this Color instance.
boolean	isBlack() Returns true if, and only if, this Color denotes the color black, false otherwise.
float	luminance() Returns the luminance of this Color instance.
Color	makeDisplayCompatible() Makes this Color instance display compatible.
Color	makeDisplayCompatible(float gamma) Makes this Color instance display compatible.
Color	makeDisplayCompatible(float gamma, ToneMapper toneMapper) Makes this Color instance display compatible.
Color	makeDisplayCompatible(ToneMapper toneMapper) Makes this Color instance display compatible.
float	max() Returns the maximum RGB-component value of this Color instance.
float	min() Returns the minimum RGB-component value of this Color instance.
Color	multiply(Color color) Multiplies this Color instance with color.
Color	multiply(float s) Multiplies the R-, G- and B-component values of this Color instance with s.
Color	multiply(float r, float g, float b) Multiplies the R-, G- and B-component values of this Color instance with r, g and b, respectively.
Color	multiply(float r, float g, float b, float a) Multiplies the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.
Color	negate() Returns a new Color instance with each RGB-component value negated.
Color	pow(Color color) Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of the R-, G- and B-component values of color, respectively.
Color	pow(float exponent) Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of exponent.
Color	pow(float r, float g, float b) Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of r, g and b, respectively.
Color	pow(float r, float g, float b, float a) Returns a new Color instance with the R-, G-, B- and A-component values of this Color instance raised to the power of r, g, b and a, respectively.
Color	redoGammaCorrection(ColorSpace colorSpace) Call this method to redo Gamma Correction using the specified ColorSpace.
Color	saturate(float min, float max) Saturates this Color instance, such that each component value will lie in the range [min, max].
Color	sqrt() Returns a new Color instance with the square root performed on each RGB-component value.
Color	subtract(Color color) Subtracts this Color instance with color.
Color	subtract(float s) Subtracts s from the R-, G- and B-component values of this Color instance.
Color	subtract(float r, float g, float b) Subtracts the R-, G- and B-component values of this Color instance with r, g and b, respectively.
Color	subtract(float r, float g, float b, float a) Subtracts the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.
static int	toA(int aRGB) Returns the A component value of aRGB.
int	toARGB() Returns an int representation of the ARGB-component values of this Color instance.
static int	toB(int rGB) Returns the B component value of rGB.
static int	toG(int rGB) Returns the G component value of rGB.
static int	toR(int rGB) Returns the R component value of rGB.
int	toRGB() Returns an int representation of the RGB-component values of this Color instance.
static int	toRGB(int r, int g, int b) Returns an int with the R-, G- and B-component values.
java.lang.String	toString() Returns a String representation of this Color instance.
Color	undoGammaCorrection(ColorSpace colorSpace) Call this method to undo Gamma Correction using the specified ColorSpace.

Methods inherited from class java.lang.Object

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

Field Detail

BLACK

public static final Color BLACK

A Color denoting the color black.

BLUE

public static final Color BLUE

A Color denoting the color blue.

CYAN

public static final Color CYAN

A Color denoting the color cyan.

GRAY

public static final Color GRAY

A Color denoting the color gray.

GREEN

public static final Color GREEN

A Color denoting the color green.

MAGENTA

public static final Color MAGENTA

A Color denoting the color magenta.

ORANGE

public static final Color ORANGE

A Color denoting the color orange.

RED

public static final Color RED

A Color denoting the color red.

TRANSPARENT

public static final Color TRANSPARENT

A Color denoting total transparency.

WHITE

public static final Color WHITE

A Color denoting the color white.

YELLOW

public static final Color YELLOW

A Color denoting the color yellow.

DEFAULT_GAMMA

public static final float DEFAULT_GAMMA

The default gamma used in gamma correction.

See Also:

Constant Field Values

a

public final float a

The value of the alpha component (A).

b

public final float b

The value of the blue component (B).

g

public final float g

The value of the green component (G).

r

public final float r

The value of the red component (R).

Constructor Detail

Color

public Color()

Constructs a new Color instance denoting the color black.

Color

public Color(float r,
             float g,
             float b)

Constructs a new Color instance given the specified components.

Calling this constructor is equivalent to calling new Color(r, g, b, 1.0F).

Parameters:

r - the value of the red component (R)

g - the value of the green component (G)

b - the value of the blue component (B)

Color

public Color(float r,
             float g,
             float b,
             float a)

Constructs a new Color instance given the specified components.

Parameters:

r - the value of the red component (R)

g - the value of the green component (G)

b - the value of the blue component (B)

a - the value of the alpha component (A)

Color

public Color(int rGB)

Constructs a new Color instance given the specified RGB-value.

Parameters:

rGB - the RGB-value

Color

public Color(int r,
             int g,
             int b)

Constructs a new Color instance given the specified RGB-values.

Calling this constructor is equivalent to calling new Color(r, g, b, 255).

Parameters:

r - the value of the red component (R)

g - the value of the green component (G)

b - the value of the blue component (B)

Color

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

Constructs a new Color instance given the specified RGBA-values.

Parameters:

r - the value of the red component (R)

g - the value of the green component (G)

b - the value of the blue component (B)

a - the value of the alpha component (A)

Method Detail

add

public Color add(Color color)

Adds color to this Color instance.

Returns a new Color instance with the result of the addition.

If color is null, a NullPointerException will be thrown.

Parameters:

color - the Color to add to this Color instance

Returns:

a new Color instance with the result of the addition

Throws:

java.lang.NullPointerException - thrown if, and only if, color is null

add

public Color add(float s)

Adds s to the R-, G- and B-component values of this Color instance.

Returns a new Color instance with the result of the addition.

Parameters:

s - the value to add

Returns:

a new Color instance with the result of the addition

add

public Color add(float r,
                 float g,
                 float b)

Adds r, g and b to the R-, G- and B-component values of this Color instance, respectively.

Returns a new Color instance with the result of the addition.

Parameters:

r - the value to add to the R component

g - the value to add to the G component

b - the value to add to the B component

Returns:

a new Color instance with the result of the addition

add

public Color add(float r,
                 float g,
                 float b,
                 float a)

Adds r, g, b and a to the R-, G-, B- and A-component values of this Color instance, respectively.

Returns a new Color instance with the result of the addition.

Parameters:

r - the value to add to the R component

g - the value to add to the G component

b - the value to add to the B component

a - the value to add to the A component

Returns:

a new Color instance with the result of the addition

applyGammaCorrection

public Color applyGammaCorrection()

Applies Gamma Correction to this Color instance.

Returns a new Color instance with Gamma Correction applied.

Calling this method is equivalent to color.applyGammaCorrection(Color.DEFAULT_GAMMA).

Returns:

a new Color instance with Gamma Correction applied

applyGammaCorrection

public Color applyGammaCorrection(float gamma)

Applies Gamma Correction to this Color instance.

Returns a new Color instance with Gamma Correction applied.

Parameters:

gamma - the gamma value to use

Returns:

a new Color instance with Gamma Correction applied

applyToneMapping

public Color applyToneMapping()

Applies Tone Mapping to this Color instance.

Returns a new Color instance with Tone Mapping applied.

Calling this method is equivalent to color.applyToneMapping(ToneMapper.linear()).

Returns:

a new Color instance with Tone Mapping applied

applyToneMapping

public Color applyToneMapping(ToneMapper toneMapper)

Applies Tone Mapping to this Color instance.

Returns a new Color instance with Tone Mapping applied.

If toneMapper is null, a NullPointerException will be thrown.

Parameters:

toneMapper - the ToneMapper to use

Returns:

a new Color instance with Tone Mapping applied

Throws:

java.lang.NullPointerException - thrown if, and only if, toneMapper is null

constrain

public Color constrain()

Constrains this Color instance to be representable.

Returns a constrained version of this Color instance.

Returns:

a constrained version of this Color instance

divide

public Color divide(Color color)

Divides this Color instance with color.

Returns a new Color instance with the result of the division.

If color is null, a NullPointerException will be thrown.

Parameters:

color - the Color to divide this Color instance with

Returns:

a new Color instance with the result of the division

Throws:

java.lang.NullPointerException - thrown if, and only if, color is null

divide

public Color divide(float s)

Divides the R-, G- and B-component values of this Color instance with s.

Returns a new Color instance with the result of the division.

Parameters:

s - the value to divide with

Returns:

a new Color instance with the result of the division

divide

public Color divide(float r,
                    float g,
                    float b)

Divides the R-, G- and B-component values of this Color instance with r, g and b, respectively.

Returns a new Color instance with the result of the division.

Parameters:

r - the value to divide the R component with

g - the value to divide the G component with

b - the value to divide the B component with

Returns:

a new Color instance with the result of the division

divide

public Color divide(float r,
                    float g,
                    float b,
                    float a)

Divides the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.

Returns a new Color instance with the result of the division.

Parameters:

r - the value to divide the R component with

g - the value to divide the G component with

b - the value to divide the B component with

a - the value to divide the A component with

Returns:

a new Color instance with the result of the division

exp

public Color exp()

Returns a new Color instance with Euler's number e raised to the power of each RGB-component value.

Returns:

a new Color instance with Euler's number e raised to the power of each RGB-component value

makeDisplayCompatible

public Color makeDisplayCompatible()

Makes this Color instance display compatible.

Returns a new Color instance.

Calling this method is equivalent to color.makeDisplayCompatible(Color.DEFAULT_GAMMA).

Returns:

a new Color instance

makeDisplayCompatible

public Color makeDisplayCompatible(float gamma)

Makes this Color instance display compatible.

Returns a new Color instance.

Calling this method is equivalent to color.makeDisplayCompatible(gamma, ToneMapper.linear()).

Parameters:

gamma - the gamma value to use

Returns:

a new Color instance

makeDisplayCompatible

public Color makeDisplayCompatible(float gamma,
                                   ToneMapper toneMapper)

Makes this Color instance display compatible.

Returns a new Color instance.

Calling this method is equivalent to the following:

 
 color.applyToneMapping(toneMapper).applyGammaCorrection(gamma).saturate(0.0F, 1.0F).multiply(255.0F)
 
 

If toneMapper is null, a NullPointerException will be thrown.

Parameters:

gamma - the gamma value to use

toneMapper - the ToneMapper to use

Returns:

a new Color instance

Throws:

java.lang.NullPointerException - thrown if, and only if, toneMapper is null

makeDisplayCompatible

public Color makeDisplayCompatible(ToneMapper toneMapper)

Makes this Color instance display compatible.

Returns a new Color instance.

Calling this method is equivalent to the following:

 
 color.applyToneMapping(toneMapper).saturate(0.0F, 1.0F).multiply(255.0F)
 
 

If toneMapper is null, a NullPointerException will be thrown.

Note that this method should preferably only be used if toneMapper takes care of Gamma Correction.

Parameters:

toneMapper - the ToneMapper to use

Returns:

a new Color instance

Throws:

java.lang.NullPointerException - thrown if, and only if, toneMapper is null

multiply

public Color multiply(Color color)

Multiplies this Color instance with color.

Returns a new Color instance with the result of the multiplication.

If color is null, a NullPointerException will be thrown.

Parameters:

color - the Color to multiply this Color instance with

Returns:

a new Color instance with the result of the multiplication

Throws:

java.lang.NullPointerException - thrown if, and only if, color is null

multiply

public Color multiply(float s)

Multiplies the R-, G- and B-component values of this Color instance with s.

Returns a new Color instance with the result of the multiplication.

Parameters:

s - the value to multiply with

Returns:

a new Color instance with the result of the multiplication

multiply

public Color multiply(float r,
                      float g,
                      float b)

Multiplies the R-, G- and B-component values of this Color instance with r, g and b, respectively.

Returns a new Color instance with the result of the multiplication.

Parameters:

r - the value to multiply with the R component

g - the value to multiply with the G component

b - the value to multiply with the B component

Returns:

a new Color instance with the result of the multiplication

multiply

public Color multiply(float r,
                      float g,
                      float b,
                      float a)

Multiplies the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.

Returns a new Color instance with the result of the multiplication.

Parameters:

r - the value to multiply with the R component

g - the value to multiply with the G component

b - the value to multiply with the B component

a - the value to multiply with the A component

Returns:

a new Color instance with the result of the multiplication

negate

public Color negate()

Returns a new Color instance with each RGB-component value negated.

Returns:

a new Color instance with each RGB-component value negated

pow

public Color pow(Color color)

Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of the R-, G- and B-component values of color, respectively.

If color is null, a NullPointerException will be thrown.

Parameters:

color - a Color instance with R-, G- and B-component values that are used as exponents

Returns:

a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of the R-, G- and B-component values of color, respectively

Throws:

java.lang.NullPointerException - thrown if, and only if, color is null

pow

public Color pow(float exponent)

Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of exponent.

Parameters:

exponent - the exponent to use

Returns:

a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of exponent

pow

public Color pow(float r,
                 float g,
                 float b)

Returns a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of r, g and b, respectively.

Parameters:

r - the exponent of the R-component value

g - the exponent of the G-component value

b - the exponent of the B-component value

Returns:

a new Color instance with the R-, G- and B-component values of this Color instance raised to the power of r, g and b, respectively

pow

public Color pow(float r,
                 float g,
                 float b,
                 float a)

Returns a new Color instance with the R-, G-, B- and A-component values of this Color instance raised to the power of r, g, b and a, respectively.

Parameters:

r - the exponent of the R-component value

g - the exponent of the G-component value

b - the exponent of the B-component value

a - the exponent of the A-component value

Returns:

a new Color instance with the R-, G-, B- and A-component values of this Color instance raised to the power of r, g, b and a, respectively

redoGammaCorrection

public Color redoGammaCorrection(ColorSpace colorSpace)

Call this method to redo Gamma Correction using the specified ColorSpace.

Returns a new Color instance.

If colorSpace is null, a NullPointerException will be thrown.

Parameters:

colorSpace - the ColorSpace to use

Returns:

a new Color instance

Throws:

java.lang.NullPointerException - thrown if, and only if, colorSpace is null

saturate

public Color saturate(float min,
                      float max)

Saturates this Color instance, such that each component value will lie in the range [min, max].

Returns a new Color instance with the result of the saturation.

Parameters:

min - the minimum value

max - the maximum value

Returns:

a new Color instance with the result of the saturation

sqrt

public Color sqrt()

Returns a new Color instance with the square root performed on each RGB-component value.

Returns:

a new Color instance with the square root performed on each RGB-component value

subtract

public Color subtract(Color color)

Subtracts this Color instance with color.

Returns a new Color instance with the result of the subtraction.

If color is null, a NullPointerException will be thrown.

Parameters:

color - the Color to subtract from this Color instance

Returns:

a new Color instance with the result of the subtraction

Throws:

java.lang.NullPointerException - thrown if, and only if, color is null

subtract

public Color subtract(float s)

Subtracts s from the R-, G- and B-component values of this Color instance.

Returns a new Color instance with the result of the subtraction.

Parameters:

s - the value to subtract

Returns:

a new Color instance with the result of the subtraction

subtract

public Color subtract(float r,
                      float g,
                      float b)

Subtracts the R-, G- and B-component values of this Color instance with r, g and b, respectively.

Returns a new Color instance with the result of the subtraction.

Parameters:

r - the value to subtract from the R component

g - the value to subtract from the G component

b - the value to subtract from the B component

Returns:

a new Color instance with the result of the subtraction

subtract

public Color subtract(float r,
                      float g,
                      float b,
                      float a)

Subtracts the R-, G-, B- and A-component values of this Color instance with r, g, b and a, respectively.

Returns a new Color instance with the result of the subtraction.

Parameters:

r - the value to subtract from the R component

g - the value to subtract from the G component

b - the value to subtract from the B component

a - the value to subtract from the A component

Returns:

a new Color instance with the result of the subtraction

undoGammaCorrection

public Color undoGammaCorrection(ColorSpace colorSpace)

Call this method to undo Gamma Correction using the specified ColorSpace.

Returns a new Color instance.

If colorSpace is null, a NullPointerException will be thrown.

Parameters:

colorSpace - the ColorSpace to use

Returns:

a new Color instance

Throws:

java.lang.NullPointerException - thrown if, and only if, colorSpace is null

toString

public java.lang.String toString()

Returns a String representation of this Color instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Color instance

equals

public boolean equals(java.lang.Object object)

Compares object to this Color instance for equality.

Returns true if, and only if, object is an instance of Color, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this Color instance for equality

Returns:

true if, and only if, object is an instance of Color, and their respective values are equal, false otherwise

isBlack

public boolean isBlack()

Returns true if, and only if, this Color denotes the color black, false otherwise.

Returns:

true if, and only if, this Color denotes the color black, false otherwise

average

public float average()

Returns the average value of the RGB-component values of this Color instance.

Returns:

the average value of the RGB-component values of this Color instance

getA

public float getA()

Returns the value of the A component.

Returns:

the value of the A component

getB

public float getB()

Returns the value of the B component.

Returns:

the value of the B component

getG

public float getG()

Returns the value of the G component.

Returns:

the value of the G component

getR

public float getR()

Returns the value of the R component.

Returns:

the value of the R component

luminance

public float luminance()

Returns the luminance of this Color instance.

Returns:

the luminance of this Color instance

max

public float max()

Returns the maximum RGB-component value of this Color instance.

Returns:

the maximum RGB-component value of this Color instance

min

public float min()

Returns the minimum RGB-component value of this Color instance.

Returns:

the minimum RGB-component value of this Color instance

hashCode

public int hashCode()

Returns a hash code for this Color instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this Color instance

toARGB

public int toARGB()

Returns an int representation of the ARGB-component values of this Color instance.

Returns:

an int representation of the ARGB-component values of this Color instance

toRGB

public int toRGB()

Returns an int representation of the RGB-component values of this Color instance.

Returns:

an int representation of the RGB-component values of this Color instance

toA

public static int toA(int aRGB)

Returns the A component value of aRGB.

Parameters:

aRGB - an int with the ARGB-component values

Returns:

the A component value of aRGB

toB

public static int toB(int rGB)

Returns the B component value of rGB.

Parameters:

rGB - an int with the RGB-component values

Returns:

the B component value of rGB

toG

public static int toG(int rGB)

Returns the G component value of rGB.

Parameters:

rGB - an int with the RGB-component values

Returns:

the G component value of rGB

toR

public static int toR(int rGB)

Returns the R component value of rGB.

Parameters:

rGB - an int with the RGB-component values

Returns:

the R component value of rGB

toRGB

public static int toRGB(int r,
                        int g,
                        int b)

Returns an int with the R-, G- and B-component values.

Parameters:

r - the R-component value

g - the G-component value

b - the B-component value

Returns:

an int with the R-, G- and B-component values