mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-22 13:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documented not freeing returned values.

Browse Source
This commit is contained in:
Camilla Berglund 2013-06-05 16:04:04 +02:00
parent 128e5b4a73
commit c3bb5c9e7b
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
include/GLFW/glfw3.h
View File

@ -978,6 +978,9 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun);
* occurred. * occurred.
* @return An array of monitor handles, or `NULL` if an error 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 * @note The returned array is valid only until the monitor configuration
* changes. See @ref glfwSetMonitorCallback to receive notifications of * changes. See @ref glfwSetMonitorCallback to receive notifications of
* configuration changes. * 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 * @return The UTF-8 encoded name of the monitor, or `NULL` if an error
* occurred. * occurred.
* *
* @note The returned string is allocated and freed by GLFW. You should not
* free it yourself.
*
* @ingroup monitor * @ingroup monitor
*/ */
GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor); GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
@ -1072,6 +1078,9 @@ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun);
* if an error occurred. * if an error occurred.
* @return An array of video modes, or `NULL` 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 * @note The returned array is valid only until this function is called again
* for the specified monitor. * for the specified monitor.
* *
@ -1090,6 +1099,9 @@ GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
* @param[in] monitor The monitor to query. * @param[in] monitor The monitor to query.
* @return The current mode of the monitor, or `NULL` if an error occurred. * @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 * @sa glfwGetVideoModes
* *
* @ingroup monitor * @ingroup monitor
@ -1115,6 +1127,9 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
* @param[in] monitor The monitor to query. * @param[in] monitor The monitor to query.
* @return The current gamma ramp. * @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 * @ingroup gamma
*/ */
GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor); GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
@ -1953,6 +1968,9 @@ GLFWAPI int glfwJoystickPresent(int joy);
* @param[out] count The size of the returned array. * @param[out] count The size of the returned array.
* @return An array of axis values, or @c NULL if the joystick is not present. * @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 * @note The returned array is valid only until the next call to @ref
* glfwGetJoystickAxes for that joystick. * 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. * @param[out] count The size of the returned array.
* @return An array of axis values, or @c NULL if the joystick is not present. * @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 * @note The returned array is valid only until the next call to @ref
* glfwGetJoystickButtons for that joystick. * 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 * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick
* is not present. * 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 * @note The returned string is valid only until the next call to @ref
* glfwGetJoystickName for that joystick. * 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 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 * @note The returned string is valid only until the next call to @ref
* glfwGetClipboardString or @ref glfwSetClipboardString. * glfwGetClipboardString or @ref glfwSetClipboardString.
* *