From ccbf185aa9c7b9f65f84706690b438c39614575e Mon Sep 17 00:00:00 2001 From: Doug Binks Date: Sun, 11 Feb 2024 17:34:27 +0000 Subject: [PATCH] Added pointer lifetime documentation --- include/GLFW/glfw3.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index bd8994ee..e8a0f904 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -3252,6 +3252,10 @@ GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value); * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED * + * @pointer_lifetime The returned string is allocated and freed by GLFW. You + * should not free it yourself. It is valid until the next call to @ref + * glfwSetWindowTitle, or until the library is terminated. + * * @thread_safety This function must only be called from the main thread. * * @sa @ref window_title