org.mini2Dx.core.graphics

Interface Color

All Known Implementing Classes:

LibgdxColor, LibgdxReadOnlyColor

public interface Color

Common interface for platform native Color representations

Method Summary

Modifier and Type	Method and Description
byte	ab()
Color	add(byte r, byte g, byte b, byte a) Adds RGBA components to this Color
Color	add(Color color) Adds another Color to this Color.
Color	add(float r, float g, float b, float a) Adds RGBA components to this Color
float	af()
int	argb8888() Returns the color value in ARGB8888 format
byte	bb()
float	bf()
int	bgr565() Returns the color value in BGR565 format
int	bgra4444() Returns the color value in BGR4444 format
Color	copy() Creates a new Color with the same R,G,B and A components as this Color
boolean	equals(Color color) Returns if this Color is the same as another Color
byte	gb()
byte	getAAsByte() Returns the alpha component of this Color
float	getAAsFloat() Returns the alpha component of this Color
byte	getBAsByte() Returns the blue component of this Color
float	getBAsFloat() Returns the blue component of this Color
byte	getGAsByte() Returns the green component of this Color
float	getGAsFloat() Returns the green component of this Color
byte	getRAsByte() Returns the red component of this Color
float	getRAsFloat() Returns the red component of this Color
float	gf()
Color	lerp(byte r, byte g, byte b, byte a, float t) Linearly interpolates between this color and the target color by t
Color	lerp(Color color, float t) Linearly interpolates between this color and the target color by t
Color	lerp(float r, float g, float b, float a, float t) Linearly interpolates between this color and the target color by t
Color	multiply(byte r, byte g, byte b, byte a) Multiplies this Color by the given RGBA components
Color	multiply(Color color) Multiplies this Color by the given Color
Color	multiply(float multiplier) Multiplies this Color by the given multiplier
Color	multiply(float r, float g, float b, float a) Multiplies this Color by the given RGBA components
byte	rb()
float	rf()
int	rgb565() Returns the color value in RGB565 format
int	rgb888() Returns the color value in RGB888 format
int	rgba4444() Returns the color value in RGBA4444 format
int	rgba8888() Returns the color value in RBGA8888 format
Color	set(byte r, byte g, byte b, byte a) Sets the RGBA components
Color	set(Color color) Sets the RGBA components of this Color from another Color
Color	set(float r, float g, float b, float a) Sets the RGBA components
void	setA(byte a)
void	setA(float a) Sets the alpha component
void	setB(byte b)
void	setB(float b) Sets the blue component
void	setG(byte g)
void	setG(float g) Sets the green component
void	setR(byte r)
void	setR(float r) Sets the red component
Color	subtract(byte r, byte g, byte b, byte a) Subtracts RGBA components from this Color
Color	subtract(Color color) Subtracts a Color from this Color
Color	subtract(float r, float g, float b, float a) Subtracts RGBA components from this Color

Method Detail

copy

Color copy()

Creates a new Color with the same R,G,B and A components as this Color

Returns:

A new Color instance

set

Color set(Color color)

Sets the RGBA components of this Color from another Color

Parameters:

color -

Returns:

This Color for chaining

set

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

Sets the RGBA components

Parameters:

r - The red component (between 0.0 and 1.0)

g - The green component (between 0.0 and 1.0)

b - The blue component (between 0.0 and 1.0)

a - The alpha component (between 0.0 and 1.0)

Returns:

This Color for chaining

set

Color set(byte r,
          byte g,
          byte b,
          byte a)

Sets the RGBA components

Parameters:

r - The red component (between -128 and 127 (inclusive))

g - The green component (between -128 and 127 (inclusive))

b - The blue component (between -128 and 127 (inclusive))

a - The alpha component (between -128 and 127 (inclusive))

Returns:

This Color for chaining

add

Color add(Color color)

Adds another Color to this Color.

Parameters:

color - The Color to add

Returns:

This Color for chaining

add

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

Adds RGBA components to this Color

Parameters:

r - The red component (between 0.0 and 1.0)

g - The green component (between 0.0 and 1.0)

b - The blue component (between 0.0 and 1.0)

a - The alpha component (between 0.0 and 1.0)

Returns:

This Color for chaining

add

Color add(byte r,
          byte g,
          byte b,
          byte a)

Adds RGBA components to this Color

Parameters:

r - The red component (between -128 and 127 (inclusive))

g - The green component (between -128 and 127 (inclusive))

b - The blue component (between -128 and 127 (inclusive))

a - The alpha component (between -128 and 127 (inclusive))

Returns:

This Color for chaining

multiply

Color multiply(Color color)

Multiplies this Color by the given Color

Parameters:

color - The Color to multiply by

Returns:

This Color for chaining

multiply

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

Multiplies this Color by the given RGBA components

Parameters:

r - The red component (between 0.0 and 1.0)

g - The green component (between 0.0 and 1.0)

b - The blue component (between 0.0 and 1.0)

a - The alpha component (between 0.0 and 1.0)

Returns:

This Color for chaining

multiply

Color multiply(byte r,
               byte g,
               byte b,
               byte a)

Multiplies this Color by the given RGBA components

Parameters:

r - The red component (between -128 and 127 (inclusive))

g - The green component (between -128 and 127 (inclusive))

b - The blue component (between -128 and 127 (inclusive))

a - The alpha component (between -128 and 127 (inclusive))

Returns:

This Color for chaining

multiply

Color multiply(float multiplier)

Multiplies this Color by the given multiplier

Parameters:

multiplier - The value to multiply the RGBA components by

Returns:

This Color for chaining

subtract

Color subtract(Color color)

Subtracts a Color from this Color

Parameters:

color - The Color to subtract

Returns:

This Color for chaining

subtract

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

Subtracts RGBA components from this Color

Parameters:

r - The red component (between 0.0 and 1.0)

g - The green component (between 0.0 and 1.0)

b - The blue component (between 0.0 and 1.0)

a - The alpha component (between 0.0 and 1.0)

Returns:

This Color for chaining

subtract

Color subtract(byte r,
               byte g,
               byte b,
               byte a)

Subtracts RGBA components from this Color

Parameters:

r - The red component (between -128 and 127 (inclusive))

g - The green component (between -128 and 127 (inclusive))

b - The blue component (between -128 and 127 (inclusive))

a - The alpha component (between -128 and 127 (inclusive))

Returns:

This Color for chaining

lerp

Color lerp(Color color,
           float t)

Linearly interpolates between this color and the target color by t

Parameters:

color - The target Color

t - The interpolation coefficient

Returns:

This Color for chaining

lerp

Color lerp(float r,
           float g,
           float b,
           float a,
           float t)

Linearly interpolates between this color and the target color by t

Parameters:

r - The red component of the target Color (A value between 0.0. and 1.0)

g - The green component of the target Color (A value between 0.0. and 1.0)

b - The blue component of the target Color (A value between 0.0. and 1.0)

a - The alpha component of the target Color (A value between 0.0. and 1.0)

t - The interpolation coefficient

Returns:

This Color for chaining

lerp

Color lerp(byte r,
           byte g,
           byte b,
           byte a,
           float t)

Linearly interpolates between this color and the target color by t

Parameters:

r - The red component of the target Color (A value between -128 and 127 (inclusive))

g - The green component of the target Color (A value between -128 and 127 (inclusive))

b - The blue component of the target Color (A value between -128 and 127 (inclusive))

a - The alpha component of the target Color (A value between -128 and 127 (inclusive))

t - The interpolation coefficient

Returns:

This Color for chaining

getRAsFloat

float getRAsFloat()

Returns the red component of this Color

Returns:

A value between 0.0 and 1.0

getGAsFloat

float getGAsFloat()

Returns the green component of this Color

Returns:

A value between 0.0 and 1.0

getBAsFloat

float getBAsFloat()

Returns the blue component of this Color

Returns:

A value between 0.0 and 1.0

getAAsFloat

float getAAsFloat()

Returns the alpha component of this Color

Returns:

A value between 0.0 and 1.0

getRAsByte

byte getRAsByte()

Returns the red component of this Color

Returns:

A value between -128 and 127 (inclusive)

getGAsByte

byte getGAsByte()

Returns the green component of this Color

Returns:

A value between -128 and 127 (inclusive)

getBAsByte

byte getBAsByte()

Returns the blue component of this Color

Returns:

A value between -128 and 127 (inclusive)

getAAsByte

byte getAAsByte()

Returns the alpha component of this Color

Returns:

A value between -128 and 127 (inclusive)

setR

void setR(float r)

Sets the red component

Parameters:

r - A value between 0f and 1f

setG

void setG(float g)

Sets the green component

Parameters:

g - A value between 0f and 1f

setB

void setB(float b)

Sets the blue component

Parameters:

b - A value between 0f and 1f

setA

void setA(float a)

Sets the alpha component

Parameters:

a - A value between 0f and 1f

setR

void setR(byte r)

setG

void setG(byte g)

setB

void setB(byte b)

setA

void setA(byte a)

equals

boolean equals(Color color)

Returns if this Color is the same as another Color

Parameters:

color - The Color to compare to

Returns:

True if same RGBA

rf

float rf()

See Also:

getRAsFloat()

gf

float gf()

See Also:

getGAsFloat()

bf

float bf()

See Also:

getBAsFloat()

af

float af()

See Also:

getAAsFloat()

rb

byte rb()

See Also:

getRAsByte()

gb

byte gb()

See Also:

getGAsByte()

bb

byte bb()

See Also:

getBAsByte()

ab

byte ab()

See Also:

getAAsByte()

argb8888

int argb8888()

Returns the color value in ARGB8888 format

rgba8888

int rgba8888()

Returns the color value in RBGA8888 format

rgba4444

int rgba4444()

Returns the color value in RGBA4444 format

rgb888

int rgb888()

Returns the color value in RGB888 format

rgb565

int rgb565()

Returns the color value in RGB565 format

bgr565

int bgr565()

Returns the color value in BGR565 format

bgra4444

int bgra4444()

Returns the color value in BGR4444 format