diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-05-01 00:22:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-01 00:22:17 +0200 |
| commit | 53cef34f16635aba04d4443c4d94a18a34a38eca (patch) | |
| tree | 02d3ccdecacaea5046de2367d07e46bced76c3b3 /runtime/doc/api.txt | |
| parent | e22c47515680d4286695df1449576783b9320509 (diff) | |
| parent | c11e6181330e9e27ec8af1712f505b38a00d8ca3 (diff) | |
| download | rneovim-53cef34f16635aba04d4443c4d94a18a34a38eca.tar.gz rneovim-53cef34f16635aba04d4443c4d94a18a34a38eca.tar.bz2 rneovim-53cef34f16635aba04d4443c4d94a18a34a38eca.zip | |
Merge #9946 from justinmk/doc
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 |