libgdx API

com.badlogic.gdx.graphics
Class Color

java.lang.Object
  extended by com.badlogic.gdx.graphics.Color

public class Color
extends java.lang.Object

A color class, holding the r, g, b and alpha component as floats in the range [0,1]. All methods perform clamping on the internal values after execution.

Author:
mzechner

Field Summary
 float a
          the red, green, blue and alpha components
 float b
          the red, green, blue and alpha components
static Color BLACK
           
static Color BLUE
           
static Color CLEAR
           
static Color CYAN
           
static Color DARK_GRAY
           
 float g
          the red, green, blue and alpha components
static Color GRAY
           
static Color GREEN
           
static Color LIGHT_GRAY
           
static Color MAGENTA
           
static Color ORANGE
           
static Color PINK
           
 float r
          the red, green, blue and alpha components
static Color RED
           
static Color WHITE
           
static Color YELLOW
           
 
Constructor Summary
Color()
          Constructs a new Color with all components set to 0.
Color(Color color)
          Constructs a new color using the given color
Color(float r, float g, float b, float a)
          Constructor, sets the components of the color
 
Method Summary
 Color add(Color color)
          Adds the given color to this color.
static int alpha(float alpha)
           
 void clamp()
           
 boolean equals(java.lang.Object o)
           
 int hashCode()
           
static int luminanceAlpha(float luminance, float alpha)
           
 Color mul(Color color)
          Multiplies the this color and the given color
 Color mul(float value)
          Multiplies all components of this Color with the given value.
static int rgb565(Color color)
           
static int rgb565(float r, float g, float b)
           
static void rgb565ToColor(Color color, int value)
          Sets the Color components using the specified integer value in the format RGB565.
static int rgb888(Color color)
           
static int rgb888(float r, float g, float b)
           
static void rgb888ToColor(Color color, int value)
          Sets the Color components using the specified integer value in the format RGB888.
static int rgba4444(Color color)
           
static int rgba4444(float r, float g, float b, float a)
           
static void rgba4444ToColor(Color color, int value)
          Sets the Color components using the specified integer value in the format RGBA4444.
static int rgba8888(Color color)
           
static int rgba8888(float r, float g, float b, float a)
           
static void rgba8888ToColor(Color color, int value)
          Sets the Color components using the specified integer value in the format RGBA8888.
 Color set(Color color)
          Sets this color to the given color.
 void set(float r, float g, float b, float a)
           
 Color sub(Color color)
          Subtracts the given color from this color
 float toFloatBits()
          Packs the 4 components of this color into a 32-bit int and returns it as a float.
static float toFloatBits(float r, float g, float b, float a)
          Packs the 4 components of this color into a 32-bit int and returns it as a float.
static float toFloatBits(int r, int g, int b, int a)
          Packs the four color components which should be in the range 0-255 into a 32-bit integer and then converts it to a float.
 int toIntBits()
          Packs the 4 components of this color into a 32-bit int.
static int toIntBits(int r, int g, int b, int a)
          Packs the four color components which should be in the range 0-255 into a 32-bit.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CLEAR

public static final Color CLEAR

WHITE

public static final Color WHITE

BLACK

public static final Color BLACK

RED

public static final Color RED

GREEN

public static final Color GREEN

BLUE

public static final Color BLUE

LIGHT_GRAY

public static final Color LIGHT_GRAY

GRAY

public static final Color GRAY

DARK_GRAY

public static final Color DARK_GRAY

PINK

public static final Color PINK

ORANGE

public static final Color ORANGE

YELLOW

public static final Color YELLOW

MAGENTA

public static final Color MAGENTA

CYAN

public static final Color CYAN

r

public float r
the red, green, blue and alpha components


g

public float g
the red, green, blue and alpha components


b

public float b
the red, green, blue and alpha components


a

public float a
the red, green, blue and alpha components

Constructor Detail

Color

public Color()
Constructs a new Color with all components set to 0.


Color

public Color(float r,
             float g,
             float b,
             float a)
Constructor, sets the components of the color

Parameters:
r - the red component
g - the green component
b - the blue component
a - the alpha component

Color

public Color(Color color)
Constructs a new color using the given color

Parameters:
color - the color
Method Detail

set

public Color set(Color color)
Sets this color to the given color.

Parameters:
color - the Color

mul

public Color mul(Color color)
Multiplies the this color and the given color

Parameters:
color - the color
Returns:
this color.

mul

public Color mul(float value)
Multiplies all components of this Color with the given value.

Parameters:
value - the value
Returns:
this color

add

public Color add(Color color)
Adds the given color to this color.

Parameters:
color - the color
Returns:
this color

sub

public Color sub(Color color)
Subtracts the given color from this color

Parameters:
color - the color
Returns:
this color

clamp

public void clamp()

set

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

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toFloatBits

public static float toFloatBits(int r,
                                int g,
                                int b,
                                int a)
Packs the four color components which should be in the range 0-255 into a 32-bit integer and then converts it to a float. Note that no range checking is performed for higher performance.

Parameters:
r - the red component, 0 - 255
g - the green component, 0 - 255
b - the blue component, 0 - 255
a - the alpha component, 0 - 255
Returns:
the packed color as a float

toIntBits

public static int toIntBits(int r,
                            int g,
                            int b,
                            int a)
Packs the four color components which should be in the range 0-255 into a 32-bit. Note that no range checking is performed for higher performance.

Parameters:
r - the red component, 0 - 255
g - the green component, 0 - 255
b - the blue component, 0 - 255
a - the alpha component, 0 - 255
Returns:
the packed color as a 32-bit int

toFloatBits

public float toFloatBits()
Packs the 4 components of this color into a 32-bit int and returns it as a float.

Returns:
the packed color as a 32-bit float

toIntBits

public int toIntBits()
Packs the 4 components of this color into a 32-bit int.

Returns:
the packed color as a 32-bit int.

toFloatBits

public static float toFloatBits(float r,
                                float g,
                                float b,
                                float a)
Packs the 4 components of this color into a 32-bit int and returns it as a float.

Returns:
the packed color as a 32-bit float

alpha

public static int alpha(float alpha)

luminanceAlpha

public static int luminanceAlpha(float luminance,
                                 float alpha)

rgb565

public static int rgb565(float r,
                         float g,
                         float b)

rgba4444

public static int rgba4444(float r,
                           float g,
                           float b,
                           float a)

rgb888

public static int rgb888(float r,
                         float g,
                         float b)

rgba8888

public static int rgba8888(float r,
                           float g,
                           float b,
                           float a)

rgb565

public static int rgb565(Color color)

rgba4444

public static int rgba4444(Color color)

rgb888

public static int rgb888(Color color)

rgba8888

public static int rgba8888(Color color)

rgb565ToColor

public static void rgb565ToColor(Color color,
                                 int value)
Sets the Color components using the specified integer value in the format RGB565. This is inverse to the rgb565(r, g, b) method.

Parameters:
color - The Color to be modified.
value - An integer color value in RGB565 format.

rgba4444ToColor

public static void rgba4444ToColor(Color color,
                                   int value)
Sets the Color components using the specified integer value in the format RGBA4444. This is inverse to the rgba4444(r, g, b, a) method.

Parameters:
color - The Color to be modified.
value - An integer color value in RGBA4444 format.

rgb888ToColor

public static void rgb888ToColor(Color color,
                                 int value)
Sets the Color components using the specified integer value in the format RGB888. This is inverse to the rgb888(r, g, b) method.

Parameters:
color - The Color to be modified.
value - An integer color value in RGB888 format.

rgba8888ToColor

public static void rgba8888ToColor(Color color,
                                   int value)
Sets the Color components using the specified integer value in the format RGBA8888. This is inverse to the rgb8888(r, g, b, a) method.

Parameters:
color - The Color to be modified.
value - An integer color value in RGBA8888 format.

libgdx API

Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)