mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-26 07:33:47 +00:00
Code Issues Releases Activity

Improve documentation of color-related functions

Browse Source 
* doc/lispref/frames.texi (Color Names): Document
'color-name-to-rgb' and 'color-dark-p'.
This commit is contained in:
Eli Zaretskii 2023-06-09 10:28:36 +03:00
parent 90eadc3e23
commit f4ee696b88
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/lispref/frames.texi
View 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