public final Class Colors

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.graphics.Colors

Imports

com.badlogic.gdx.utils.ObjectMap

A general purpose class containing named colors that can be changed at will. For example, the markup language defined by the BitmapFontCache class uses this class to retrieve colors and the user can define his own colors.

Author: davebaol

Field Summary

Modifier and Type	Field and Description
private static final ObjectMap<String, Color>	map

Constructor Summary

Access	Constructor and Description
private	Colors()

Method Summary

Modifier and Type	Method and Description
public static Color	Returns: the color to which the specified `name` is mapped, or `null` if there was no mapping for `name` . get(String the name of the color name) Convenience method to lookup a color by `name`.
public static ObjectMap<String, Color>	getColors() Returns the color map.
public static Color	Returns: the previous `color` associated with `name`, or `null` if there was no mapping for `name` . put(String the name of the color name, Color the color color) Convenience method to add a `color` with its `name`.
public static void	reset() Resets the color map to the predefined colors.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

map	back to summary
private static final ObjectMap<String, Color> map

Constructor Detail

Colors	back to summary
private Colors()

Method Detail

get back to summary

get	back to summary
public static Color get(String name) Convenience method to lookup a color by `name`. The invocation of this method is equivalent to the expression `Colors.getColors().get(name)` Parameters name:String the name of the color Returns:Color the color to which the specified `name` is mapped, or `null` if there was no mapping for `name` .

public static Color get(String name)

Convenience method to lookup a color by name. The invocation of this method is equivalent to the expression Colors.getColors().get(name)

Parameters

name:String: the name of the color

Returns:Color

the color to which the specified name is mapped, or null if there was no mapping for name .

getColors	back to summary
public static ObjectMap<String, Color> getColors() Returns the color map.

put back to summary

put	back to summary
public static Color put(String name, Color color) Convenience method to add a `color` with its `name`. The invocation of this method is equivalent to the expression `Colors.getColors().put(name, color)` Parameters name:String the name of the color color:Color the color Returns:Color the previous `color` associated with `name`, or `null` if there was no mapping for `name` .

public static Color put(String name, Color color)

Convenience method to add a color with its name. The invocation of this method is equivalent to the expression Colors.getColors().put(name, color)

Parameters

name:String: the name of the color
color:Color: the color

Returns:Color

the previous color associated with name, or null if there was no mapping for name .

reset	back to summary
public static void reset() Resets the color map to the predefined colors.