Color (NOVA-Core 0.1.0-SNAPSHOT API)

java.lang.Object
- nova.core.render.Color

```
public final class Color
extends java.lang.Object
```
Arbitrary immutable color object. Holds a color in argb space.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Color.ColorRangeException

Nested Classes
Modifier and Type	Class and Description
`static class`	`Color.ColorRangeException`

Field Summary

Fields
Modifier and Type	Field and Description
`static Color`	`black` Black color.
`static Color`	`blue` Blue color.
`static Color`	`cyan` Cyan color.
`static Color`	`darkGray` Dark gray color.
`static Color`	`gray` Gray color.
`static Color`	`green` Green color.
`static Color`	`lightGray` Light gray color.
`static Color`	`magenta` Magenta color.
`static Color`	`orange` Orange color.
`static Color`	`pink` Pink color.
`static Color`	`red` Red color.
`static Color`	`white` White color.
`static Color`	`yellow` Yellow color.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`add(Color color)` Performs addition operation.
`int`	`alpha()`
`Color`	`alpha(int alpha)` Creates Color instance with replaced alpha component.
`float`	`alphaf()`
`Color`	`alphaf(float alpha)` Creates Color instance with replaced alpha component.
`int`	`argb()`
`static Color`	`argb(int argb)` Creates Color instance out of packed ARGB data.
`Color`	`average(Color color)` Performs average operation.
`Color`	`blend(Color color)` Performs alpha color blending.
`int`	`blue()`
`Color`	`blue(int blue)` Creates Color instance with replaced blue component.
`float`	`bluef()`
`Color`	`bluef(float blue)` Creates Color instance with replaced blue component.
`Color`	`complementary()` Calculates complementary color to this color instance.
`Color`	`divide(Color color)` Performs division operation.
`boolean`	`equals(java.lang.Object obj)`
`int`	`green()`
`Color`	`green(int green)` Creates Color instance with replaced green component.
`float`	`greenf()`
`Color`	`greenf(float green)` Creates Color instance with replaced green component.
`int`	`hashCode()`
`org.apache.commons.math3.geometry.euclidean.threed.Vector3D`	`hsl()` Getter for HSL components.
`static Color`	`hsl(double h, double s, double l)` Creates Color instance from HSL color format.
`static Color`	`hsl(org.apache.commons.math3.geometry.euclidean.threed.Vector3D hsl)` Creates Color instance from HSL color format using vector as source of components.
`float`	`hue()`
`Color`	`hue(float h)`
`float`	`lighting()`
`Color`	`lighting(float l)`
`Color`	`multiply(Color color)` Performs multiplication operation.
`Color`	`negate()` Performs negation operation.
`int`	`red()`
`Color`	`red(int red)` Creates Color instance with replaced red component.
`float`	`redf()`
`Color`	`redf(float red)` Creates Color instance with replaced red component.
`static Color`	`rgb(int rgb)` Creates Color instance out of packed RGB data.
`static Color`	`rgb(int red, int green, int blue)` Creates Color instance out of integer components.
`int`	`rgba()`
`static Color`	`rgba(int rgba)` Creates Color instance out of packed RGBA data.
`static Color`	`rgba(int rgb, int alpha)` Creates Color instance out of packed RGB data and byte alpha component.
`static Color`	`rgba(int red, int green, int blue, int alpha)` Creates Color instance out of integer components.
`static Color`	`rgbac(int rgb, int alpha)` Creates Color instance out of packed RGB data and byte alpha component.
`static Color`	`rgbac(int red, int green, int blue, int alpha)` Creates Color instance out of integer components.
`static Color`	`rgbaf(double red, double green, double blue, double alpha)` Creates Color instance out of double components.
`static Color`	`rgbaf(int rgb, float alpha)` Creates Color instance out of packed RGB data and double alpha component.
`static Color`	`rgbafc(double red, double green, double blue, double alpha)` Creates Color instance out of double components.
`static Color`	`rgbafc(int rgb, float alpha)` Creates Color instance out of packed RGB data and double alpha component.
`static Color`	`rgbc(int red, int green, int blue)` Creates Color instance out of integer components.
`static Color`	`rgbf(double red, double green, double blue)` Creates Color instance out of double components.
`static Color`	`rgbfc(double red, double green, double blue)` Creates Color instance out of double components.
`float`	`saturation()`
`Color`	`saturation(float s)`
`Color`	`subtract(Color color)` Performs subtraction operation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - white
```
public static final Color white
```
    White color.
  - lightGray
```
public static final Color lightGray
```
    Light gray color.
  - gray
```
public static final Color gray
```
    Gray color.
  - darkGray
```
public static final Color darkGray
```
    Dark gray color.
  - black
```
public static final Color black
```
    Black color.
  - red
```
public static final Color red
```
    Red color.
  - pink
```
public static final Color pink
```
    Pink color.
  - orange
```
public static final Color orange
```
    Orange color.
  - yellow
```
public static final Color yellow
```
    Yellow color.
  - green
```
public static final Color green
```
    Green color.
  - magenta
```
public static final Color magenta
```
    Magenta color.
  - cyan
```
public static final Color cyan
```
    Cyan color.
  - blue
```
public static final Color blue
```
    Blue color.
- Method Detail
  - rgbc
```
public static Color rgbc(int red,
                         int green,
                         int blue)
```
    Creates Color instance out of integer components. Clamps input variables into 0-255 range. Uses the most opaque alpha value.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    Returns:
    
    a color instance.
  - rgb
```
public static Color rgb(int red,
                        int green,
                        int blue)
```
    Creates Color instance out of integer components. Uses the most opaque alpha value.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if component variables are out of 0-255 range.
  - rgbfc
```
public static Color rgbfc(double red,
                          double green,
                          double blue)
```
    Creates Color instance out of double components. Uses the most opaque alpha value. Clamps input variables into 0-1 range.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    Returns:
    
    a color instance.
  - rgbf
```
public static Color rgbf(double red,
                         double green,
                         double blue)
```
    Creates Color instance out of double components. Uses the most opaque alpha value. Clamps input variables into 0-1 range.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if component variables are out of 0-1 range.
  - rgb
```
public static Color rgb(int rgb)
```
    Creates Color instance out of packed RGB data.
    
    Parameters:
    
    rgb - data occupying lower 24bits.
    
    Returns:
    
    a color instance.
  - rgbac
```
public static Color rgbac(int red,
                          int green,
                          int blue,
                          int alpha)
```
    Creates Color instance out of integer components. Uses the most opaque alpha value.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    alpha - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if component variables are out of 0-255 range.
  - rgba
```
public static Color rgba(int red,
                         int green,
                         int blue,
                         int alpha)
```
    Creates Color instance out of integer components. Uses the most opaque alpha value.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    alpha - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if component variables are out of 0-255 range.
  - rgbafc
```
public static Color rgbafc(double red,
                           double green,
                           double blue,
                           double alpha)
```
    Creates Color instance out of double components. Uses the most opaque alpha value. Clamps input variables into 0-1 range.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    alpha - component.
    
    Returns:
    
    a color instance.
  - rgbaf
```
public static Color rgbaf(double red,
                          double green,
                          double blue,
                          double alpha)
```
    Creates Color instance out of double components. Uses the most opaque alpha value. Clamps input variables into 0-1 range.
    
    Parameters:
    
    red - component.
    
    green - component.
    
    blue - component.
    
    alpha - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if component variables are out of 0-1 range.
  - rgbac
```
public static Color rgbac(int rgb,
                          int alpha)
```
    Creates Color instance out of packed RGB data and byte alpha component.
    
    Parameters:
    
    rgb - packed into lower 24bits.
    
    alpha - will be clamped into 0-255 range.
    
    Returns:
    
    a color instance.
  - rgba
```
public static Color rgba(int rgb,
                         int alpha)
```
    Creates Color instance out of packed RGB data and byte alpha component.
    
    Parameters:
    
    rgb - packed into lower 24bits.
    
    alpha - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if alpha component is out of 0-255 range.
  - rgbafc
```
public static Color rgbafc(int rgb,
                           float alpha)
```
    Creates Color instance out of packed RGB data and double alpha component.
    
    Parameters:
    
    rgb - packed into lower 24bits.
    
    alpha - will be clamped into 0-1 range.
    
    Returns:
    
    a color instance.
  - rgbaf
```
public static Color rgbaf(int rgb,
                          float alpha)
```
    Creates Color instance out of packed RGB data and double alpha component.
    
    Parameters:
    
    rgb - packed into lower 24bits.
    
    alpha - component.
    
    Returns:
    
    a color instance.
    
    Throws:
    
    Color.ColorRangeException - if alpha component is out of 0-1 range.
  - argb
```
public static Color argb(int argb)
```
    Creates Color instance out of packed ARGB data.
    
    Parameters:
    
    argb - packed into 32bits.
    
    Returns:
    
    a color instance.
  - rgba
```
public static Color rgba(int rgba)
```
    Creates Color instance out of packed RGBA data.
    
    Parameters:
    
    rgba - packed into 32bits.
    
    Returns:
    
    a color instance.
  - hsl
```
public static Color hsl(double h,
                        double s,
                        double l)
```
    Creates Color instance from HSL color format.
    
    Parameters:
    
    h - component.
    
    s - component.
    
    l - component.
    
    Returns:
    
    a color instance.
  - hsl
```
public static Color hsl(org.apache.commons.math3.geometry.euclidean.threed.Vector3D hsl)
```
    Creates Color instance from HSL color format using vector as source of components.
    
    Parameters:
    
    hsl - vector which components will be used as HSL color components. X -> H, Y -> S, Z -> L
    
    Returns:
    
    a color instance.
  - argb
```
public int argb()
```
    Returns:
    
    packed color in ARGB format.
  - rgba
```
public int rgba()
```
    Returns:
    
    packed color in RGBA format.
  - red
```
public int red()
```
    Returns:
    
    red component of the color in lowest 8bit of the integer.
  - green
```
public int green()
```
    Returns:
    
    green component of the color in lowest 8bit of the integer.
  - blue
```
public int blue()
```
    Returns:
    
    blue component of the color in lowest 8bit of the integer.
  - alpha
```
public int alpha()
```
    Returns:
    
    alpha component of the color in lowest 8bit of the integer.
  - red
```
public Color red(int red)
```
    Creates Color instance with replaced red component.
    
    Parameters:
    
    red - a new red component.
    
    Returns:
    
    a new Color instance.
  - green
```
public Color green(int green)
```
    Creates Color instance with replaced green component.
    
    Parameters:
    
    green - a new green component.
    
    Returns:
    
    a new Color instance.
  - blue
```
public Color blue(int blue)
```
    Creates Color instance with replaced blue component.
    
    Parameters:
    
    blue - a new blue component.
    
    Returns:
    
    a new Color instance.
  - alpha
```
public Color alpha(int alpha)
```
    Creates Color instance with replaced alpha component.
    
    Parameters:
    
    alpha - a new alpha component.
    
    Returns:
    
    a new Color instance.
  - redf
```
public float redf()
```
    Returns:
    
    red component of the color as a normalized float.
  - greenf
```
public float greenf()
```
    Returns:
    
    green component of the color as a normalized float.
  - bluef
```
public float bluef()
```
    Returns:
    
    blue component of the color as a normalized float.
  - alphaf
```
public float alphaf()
```
    Returns:
    
    alpha component of the color as a normalized float.
  - redf
```
public Color redf(float red)
```
    Creates Color instance with replaced red component.
    
    Parameters:
    
    red - a new red component.
    
    Returns:
    
    a new Color instance.
  - greenf
```
public Color greenf(float green)
```
    Creates Color instance with replaced green component.
    
    Parameters:
    
    green - a new green component.
    
    Returns:
    
    a new Color instance.
  - bluef
```
public Color bluef(float blue)
```
    Creates Color instance with replaced blue component.
    
    Parameters:
    
    blue - a new blue component.
    
    Returns:
    
    a new Color instance.
  - alphaf
```
public Color alphaf(float alpha)
```
    Creates Color instance with replaced alpha component.
    
    Parameters:
    
    alpha - a new alpha component.
    
    Returns:
    
    a new Color instance.
  - blend
```
public Color blend(Color color)
```
    Performs alpha color blending.
    
    Parameters:
    
    color - color to blend with.
    
    Returns:
    
    a new, bended, Color instance.
  - add
```
public Color add(Color color)
```
    Performs addition operation.
    
    Parameters:
    
    color - color to be added.
    
    Returns:
    
    a new Color instance.
  - subtract
```
public Color subtract(Color color)
```
    Performs subtraction operation.
    
    Parameters:
    
    color - color to be subtracted.
    
    Returns:
    
    a new Color instance.
  - multiply
```
public Color multiply(Color color)
```
    Performs multiplication operation.
    
    Parameters:
    
    color - color to be multiplied.
    
    Returns:
    
    a new Color instance.
  - divide
```
public Color divide(Color color)
```
    Performs division operation.
    
    Parameters:
    
    color - color to be divisor.
    
    Returns:
    
    a new Color instance.
  - average
```
public Color average(Color color)
```
    Performs average operation.
    
    Parameters:
    
    color - color to second part of the average.
    
    Returns:
    
    a new Color instance.
  - negate
```
public Color negate()
```
    Performs negation operation.
    
    Returns:
    
    a new Color instance.
  - hsl
```
public org.apache.commons.math3.geometry.euclidean.threed.Vector3D hsl()
```
    Getter for HSL components.
    
    Returns:
    
    a vector with HSL components.
  - lighting
```
public float lighting()
```
  - saturation
```
public float saturation()
```
  - hue
```
public float hue()
```
  - lighting
```
public Color lighting(float l)
```
  - saturation
```
public Color saturation(float s)
```
  - hue
```
public Color hue(float h)
```
  - complementary
```
public Color complementary()
```
    Calculates complementary color to this color instance.
    
    Returns:
    
    a new Color which is complementary to current.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Color

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

white

lightGray

gray

darkGray

black

red

pink

orange

yellow

green

magenta

cyan

blue

Method Detail

rgbc

rgb

rgbfc

rgbf

rgb

rgbac

rgba

rgbafc

rgbaf

rgbac

rgba

rgbafc

rgbaf

argb

rgba

hsl

hsl

argb

rgba

red

green

blue

alpha

red

green

blue

alpha

redf

greenf

bluef

alphaf

redf

greenf

bluef

alphaf

blend

add

subtract

multiply

divide

average

negate

hsl

lighting

saturation

hue

lighting

saturation

hue

complementary

hashCode

equals