diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-04-27 17:53:56 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2019-05-01 00:18:43 +0200 |
| commit | afd947e0c3b34a0dc36140a373af46aa31d8f1ab (patch) | |
| tree | 7e05d87f9ed4b0ee3df54fb18472ac1979c5e812 /runtime/doc/api.txt | |
| parent | e22c47515680d4286695df1449576783b9320509 (diff) | |
| download | rneovim-afd947e0c3b34a0dc36140a373af46aa31d8f1ab.tar.gz rneovim-afd947e0c3b34a0dc36140a373af46aa31d8f1ab.tar.bz2 rneovim-afd947e0c3b34a0dc36140a373af46aa31d8f1ab.zip | |
doc [ci skip]
ref #9886
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index b2e37a6d60..44dc3a2011 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -763,10 +763,26 @@ 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 |