diff options
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index b2e37a6d60..fb4818bc2f 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -763,10 +763,28 @@ nvim_unsubscribe({event}) *nvim_unsubscribe()* {event} Event type string nvim_get_color_by_name({name}) *nvim_get_color_by_name()* - TODO: Documentation + Returns the 24-bit RGB value of a |nvim_get_color_map()| color + name or "#rrggbb" hexadecimal string. + + Examples: > + :echo nvim_get_color_by_name("Pink") + :echo nvim_get_color_by_name("#cbcbcb") +< + + Parameters: ~ + {name} Color name or "#rrggbb" string + + Return: ~ + 24-bit RGB value, or -1 for invalid argument. nvim_get_color_map() *nvim_get_color_map()* - TODO: Documentation + Returns a map of color names and RGB values. + + Keys are color names (e.g. "Aqua") and values are 24-bit RGB + color values (e.g. 65535). + + Return: ~ + Map of color names and RGB values. nvim_get_mode() *nvim_get_mode()* Gets the current mode. |mode()| "blocking" is true if Nvim is |