1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-09-10 10:49:41 +02:00

Update/Edit documentation

This commit is contained in:
Jesus Fuentes 2018-04-01 09:05:56 -05:00
parent a9ca1a0989
commit 63de8abde5
2 changed files with 4 additions and 4 deletions

View file

@ -10,14 +10,14 @@ 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](https://xmpp.org/extensions/xep-0392.html).
##Usage
## 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
## 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.
@ -33,5 +33,5 @@ ConsistentColor.activateBlueBlindnessCorrection();
To deactivate color vision deficiency correction, call
```
ConsistenColor.deactivateDeficiencyCorrection();
ConsistentColor.deactivateDeficiencyCorrection();
```