diff --git a/docs/configuration.rst b/docs/configuration.rst index 547ee179cf040d328b4869352107b9af6dd8a484..787693cee21b6aeb9ab2c0bcbd3c320911ead387 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -73,6 +73,13 @@ generating the identicons. Each element of list/tuple should be a string conformant to colour specification from the `Pillow `_ library. +In addition to regular RGB, you can also use the RGBA (RGB with alpha channel) +scheme to introduce partial or complete transparency when specyfing +colour. Alpha channel value ranges between 0 (full transparency) to 255 (no +transparency). For example ``rgba(224,224,224,0)`` will result in fully +transparent background, while ``rgba(224,224,244,128)`` will result in +approximatelly 50% transparency. + **Default value:** ``("rgb(45,79,255)", "rgb(254,180,44)", "rgb(226,121,234)", "rgb(30,179,253)", "rgb(232,77,65)", "rgb(49,203,115)", "rgb(141,69,170)")`` @@ -84,6 +91,14 @@ identicons. This should be a string conformant to colour specification from the `Pillow `_ library. The value should be a string. +In addition to regular RGB, you can also use the RGBA (RGB with alpha channel) +scheme to introduce partial or complete transparency when specyfing +colour. Alpha channel value ranges between 0 (full transparency) to 255 (no +transparency). For example ``rgba(224,224,224,0)`` will result in fully +transparent foreground, while ``rgba(224,224,244,128)`` will result in +approximatelly 50% transparency. Different foreground colours can have different +values for alpha channel. + **Default value:** ``"rgb(224,224,224)"`` ``PYDENTICON_DIGEST``