mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-10 00:51:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work.

Browse Source
This commit is contained in:
Camilla Berglund 2013-01-13 21:28:18 +01:00
parent 3863a635f2
commit 1bd59844c8
1 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
include/GL/glfw3.h
View File

@ -925,7 +925,7 @@ typedef struct
* @note This function may take several seconds to complete on some systems, * @note This function may take several seconds to complete on some systems,
* while on other systems it may take only a fraction of a second to complete. * while on other systems it may take only a fraction of a second to complete.
* *
* @note On Mac OS X, this function will change the current directory of the * @note <b>Mac OS X:</b> This function will change the current directory of the
* application to the @c Contents/Resources subdirectory of the application's * application to the @c Contents/Resources subdirectory of the application's
* bundle, if present. * bundle, if present.
* *
@ -1227,16 +1227,16 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* @remarks In order to determine the actual properties of an opened window, * @remarks In order to determine the actual properties of an opened window,
* use @ref glfwGetWindowParam and @ref glfwGetWindowSize. * use @ref glfwGetWindowParam and @ref glfwGetWindowSize.
* *
* @remarks On Microsoft Windows, if the executable has an icon resource named * @remarks <b>Windows:</b> If the executable has an icon resource named @c
* @c GLFW_ICON, it will be set as the icon for the window. If no such icon is * GLFW_ICON, it will be set as the icon for the window. If no such icon is
* present, the @c IDI_WINLOGO icon will be used instead. * present, the @c IDI_WINLOGO icon will be used instead.
* *
* @remarks On Mac OS X the GLFW window has no icon, but programs using GLFW * @remarks <b>Mac OS X:</b> The GLFW window has no icon, as it is not
* will use the application bundle's icon. Also, the first time a window is * a document window, but the dock icon will be the same as the application
* opened the menu bar is populated with common commands like Hide, Quit and * bundle's icon. Also, the first time a window is opened the menu bar is
* About. The (minimal) about dialog uses information from the application's * populated with common commands like Hide, Quit and About. The (minimal)
* bundle. For more information on bundles, see the Bundle Programming Guide * about dialog uses information from the application's bundle. For more
* provided by Apple. * information on bundles, see the Bundle Programming Guide provided by Apple.
* *
* @note This function may only be called from the main thread. * @note This function may only be called from the main thread.
* *
@ -1362,6 +1362,8 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
* @param[in] param The property whose value to return. * @param[in] param The property whose value to return.
* @ingroup window * @ingroup window
* *
* @par Window properties
*
* The @ref GLFW_FOCUSED property indicates whether the window is focused. * The @ref GLFW_FOCUSED property indicates whether the window is focused.
* *
* The @ref GLFW_ICONIFIED property indicates whether the window is iconified. * The @ref GLFW_ICONIFIED property indicates whether the window is iconified.
@ -1378,6 +1380,8 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
* screen position, in pixels, of the upper-left corner of the window's client * screen position, in pixels, of the upper-left corner of the window's client
* area. * area.
* *
* @par Context properties
*
* The @ref GLFW_CLIENT_API property indicates the client API provided by the * The @ref GLFW_CLIENT_API property indicates the client API provided by the
* window's context. * window's context.
* *
@ -1442,12 +1446,14 @@ GLFWAPI void glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun cbf
* @ingroup window * @ingroup window
* *
* This callback is called when the user attempts to close the window, i.e. * This callback is called when the user attempts to close the window, i.e.
* clicks the window's close widget or, on Mac OS X, selects @b Quit from the * clicks the window's close widget. Calling @ref glfwDestroyWindow does not
* application menu. Calling @ref glfwDestroyWindow does not cause this * cause this callback to be called.
* callback to be called.
* *
* The return value of the close callback becomes the new value of the @ref * The return value of the close callback becomes the new value of the @ref
* GLFW_SHOULD_CLOSE window parameter. * GLFW_SHOULD_CLOSE window parameter.
*
* @remarks <b>Mac OS X:</b> Selecting Quit from the application menu will
* trigger the close callback for all windows.
*/ */
GLFWAPI void glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun cbfun); GLFWAPI void glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun cbfun);
@ -1461,8 +1467,9 @@ GLFWAPI void glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun c
* redrawn, for example if the window has been exposed after having been * redrawn, for example if the window has been exposed after having been
* covered by another window. * covered by another window.
* *
* @note On compositing window systems such as Mac OS X, where the window * @note On compositing window systems such as Aero, Compiz or Aqua, where the
* contents are saved off-screen, this callback may never be called. * window contents are saved off-screen, this callback may be called only very
* infrequently or never at all.
*/ */
GLFWAPI void glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun cbfun); GLFWAPI void glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun cbfun);