1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-05 08:05:58 +01:00
Smack/documentation/extensions/consistent_colors.md
2018-04-01 09:05:56 -05:00

1.2 KiB

Consistent Colors

Back

Since XMPP can be used on multiple platforms at the same time, it might be a good idea to render given Strings like nicknames in the same color on all platforms to provide a consistent user experience.

The utility class ConsistentColor allows the generation of colors to a given string following the specification of XEP-0392.

Usage

To generate a consistent color for a given string, call

float[] rgb = ConsistentColor.RGBFrom(input);

The resulting float array contains values for RGB in the range of 0 to 1.

Color Deficiency Corrections

Some users might suffer from color vision deficiencies. To compensate those deficiencies, the API allows for color correction. The color correction mode is a static value, which can be changed at any time.

To correct colors for users with red-green color deficiency use the following code:

ConsistentColor.activateRedGreenBlindnessCorrection();

For color correction for users with blue-blindness, call

ConsistentColor.activateBlueBlindnessCorrection();

To deactivate color vision deficiency correction, call

ConsistentColor.deactivateDeficiencyCorrection();