]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of color-related functions
authorEli Zaretskii <eliz@gnu.org>
Fri, 9 Jun 2023 07:28:36 +0000 (10:28 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 9 Jun 2023 07:28:36 +0000 (10:28 +0300)
* doc/lispref/frames.texi (Color Names): Document
'color-name-to-rgb' and 'color-dark-p'.

doc/lispref/frames.texi

index c78ab1c34ba3a57b1340ba33e514aad202a8accd..a8ac9a214f63d8ffed1e3450cf86efbbb945b2f2 100644 (file)
@@ -4518,6 +4518,20 @@ This function used to be called @code{x-color-values},
 and that name is still supported as an alias.
 @end defun
 
+@defun color-name-to-rgb color &optional frame
+This function does the same as @code{color-values}, but it returns
+color values as floating-point numbers between 0.0 and 1.0 inclusive.
+@end defun
+
+@defun color-dark-p rgb
+This function returns non-@code{nil} if the color described by its RGB
+triplet @var{rgb} is more readable against white background than
+against dark background.  The argument @var{rgb} should be a list of
+the form @w{@code{(@var{r} @var{g} @var{b})}}, with each component a
+floating-point number in the range 0.0 to 1.0 inclusive.  You can use
+@code{color-name-to-rgb} to convert a color's name to such a list.
+@end defun
+
 @node Text Terminal Colors
 @section Text Terminal Colors
 @cindex colors on text terminals