caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-28 01:25:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation of glfwGetClipboardString

Browse Source 
The reference documentation for glfwGetClipboardString did not link to
GLFW_FORMAT_UNAVAILABLE.

Fixes #605.
This commit is contained in:
Camilla Berglund
2015-09-16 16:27:28 +02:00
parent 7c6a8775eb
commit 0b65053ffd
2 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/input.dox
View File

@@ -544,9 +544,14 @@ converted to one, you can retrieve it with @ref glfwGetClipboardString. See the
reference documentation for the lifetime of the returned string.
@code
const char* clipboard = glfwGetClipboardString(window);
const char* text = glfwGetClipboardString(window);
if (text)
insert_text(text);
@endcode
If the clipboard is empty or if its contents could not be converted, `NULL` is
returned.
The contents of the system clipboard can be set to a UTF-8 encoded string with
@ref glfwSetClipboardString.