agi.foundation.graphics.advanced

(agi.foundation.graphics-2023r1.jar)

Class TranslucencyHelper

java.lang.Object

agi.foundation.graphics.advanced.TranslucencyHelper

public final class TranslucencyHelper
extends Object

Contains helpful methods for working with colors and translucency.

Method Summary

Modifier and Type	Method and Description
static float	alphaToTranslucency(int alpha) Converts an alpha value to a translucency value.
static Color	createColorFromColorAndTranslucency(Color color, float translucency) Creates a color from a given color and a given translucency.
static float	extractTranslucencyFromColor(Color color) Extracts a translucency value from the alpha channel of a color.
static int	translucencyToAlpha(float translucency) Converts a translucency value to an alpha value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

alphaToTranslucency

public static float alphaToTranslucency(int alpha)

Converts an alpha value to a translucency value. When the alpha is 255 or greater, the translucency is 0.0f. When the alpha is 0 or less, the translucency is 1.0f. When the alpha is in between these values, the translucency is linearly ramped between 0.0f and 1.0f accordingly.

Parameters:

alpha - The alpha value to convert to a translucency.

Returns:

The translucency value.

translucencyToAlpha

public static int translucencyToAlpha(float translucency)

Converts a translucency value to an alpha value. When the translucency is 1.0f or greater, the alpha is 0. When the translucency is 0.0f or less, the alpha is 255. When the translucency is in between these values, the alpha is linearly ramped between 0 and 255 accordingly.

Parameters:

translucency - The translucency value to convert to an alpha.

Returns:

The alpha value.

extractTranslucencyFromColor

public static float extractTranslucencyFromColor(@Nonnull
                                                 Color color)

Extracts a translucency value from the alpha channel of a color. This is equivalent to calling TranslucencyHelper.alphaToTranslucency(int) on the alpha component of the color.

Parameters:

color - The color from which to extra translucency.

Returns:

The translucency value.

createColorFromColorAndTranslucency

@Nonnull
public static Color createColorFromColorAndTranslucency(@Nonnull
                                                                  Color color,
                                                                  float translucency)

Creates a color from a given color and a given translucency. The alpha channel of the color is ignored, and instead the alpha value for the returned color is computed by calling TranslucencyHelper.translucencyToAlpha(float) on the provided translucency value.

Parameters:

color - The base color.

translucency - The translucency value.

Returns:

The base color with its alpha value replaced with a value computed from the translucency.