diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 43e2091a..e12b4072 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -978,6 +978,9 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun); * occurred. * @return An array of monitor handles, or `NULL` if an error occurred. * + * @note The returned array is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned array is valid only until the monitor configuration * changes. See @ref glfwSetMonitorCallback to receive notifications of * configuration changes. @@ -1040,6 +1043,9 @@ GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* width, int* h * @return The UTF-8 encoded name of the monitor, or `NULL` if an error * occurred. * + * @note The returned string is allocated and freed by GLFW. You should not + * free it yourself. + * * @ingroup monitor */ GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor); @@ -1072,6 +1078,9 @@ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun); * if an error occurred. * @return An array of video modes, or `NULL` if an error occurred. * + * @note The returned array is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned array is valid only until this function is called again * for the specified monitor. * @@ -1090,6 +1099,9 @@ GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count); * @param[in] monitor The monitor to query. * @return The current mode of the monitor, or `NULL` if an error occurred. * + * @note The returned struct is allocated and freed by GLFW. You should not + * free it yourself. + * * @sa glfwGetVideoModes * * @ingroup monitor @@ -1115,6 +1127,9 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma); * @param[in] monitor The monitor to query. * @return The current gamma ramp. * + * @note The value arrays of the returned ramp are allocated and freed by GLFW. + * You should not free them yourself. + * * @ingroup gamma */ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor); @@ -1953,6 +1968,9 @@ GLFWAPI int glfwJoystickPresent(int joy); * @param[out] count The size of the returned array. * @return An array of axis values, or @c NULL if the joystick is not present. * + * @note The returned array is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned array is valid only until the next call to @ref * glfwGetJoystickAxes for that joystick. * @@ -1965,6 +1983,9 @@ GLFWAPI const float* glfwGetJoystickAxes(int joy, int* count); * @param[out] count The size of the returned array. * @return An array of axis values, or @c NULL if the joystick is not present. * + * @note The returned array is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned array is valid only until the next call to @ref * glfwGetJoystickButtons for that joystick. * @@ -1980,6 +2001,9 @@ GLFWAPI const unsigned char* glfwGetJoystickButtons(int joy, int* count); * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick * is not present. * + * @note The returned string is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned string is valid only until the next call to @ref * glfwGetJoystickName for that joystick. * @@ -2015,6 +2039,9 @@ GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string); * * @note This function may only be called from the main thread. * + * @note The returned string is allocated and freed by GLFW. You should not + * free it yourself. + * * @note The returned string is valid only until the next call to @ref * glfwGetClipboardString or @ref glfwSetClipboardString. *