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

Merge(#4): Added documentation

Browse Source 
Add documentation for glfwSetWindowBadge and glfwSetWindowBadgeString
This commit is contained in:
Jan Schürkamp 2023-04-04 22:05:07 +02:00 committed by GitHub
commit a734a8bbdb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 56 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
include/GLFW/glfw3.h
View File

@ -3398,11 +3398,64 @@ GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* i
*/ */
GLFWAPI void glfwSetWindowProgressIndicator(GLFWwindow* window, int progressState, double value); GLFWAPI void glfwSetWindowProgressIndicator(GLFWwindow* window, int progressState, double value);
//TODO Documentation /*! @brief Sets the dock or taskbar badge for the specified window or the application.
//Use count = 0 to disable badge icon *
* This function sets the dock or taskbar badge for the specified window
* or the application as a whole. Any badge set with this function
* overrides the string badge set with @ref glfwSetWindowBadgeString.
* If the platform does not support number badges, the string badge
* is not overridden.
*
* @param[in] window The window whose badge to set.
* @param[in] count The number to set, or `0` to disable it.
*
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
* GLFW_PLATFORM_ERROR, and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
*
* @remark @win32 On Windows Vista and earlier, this function will emit
* @ref GLFW_FEATURE_UNAVAILABLE.
*
* @remark @macos Only the Dock icon may contain a badge. Pass a `NULL`
* window handle to set it. Emits @ref GLFW_FEATURE_UNAVAILABLE if a
* valid window handle is passed.
*
* @remark @x11 @wayland @win32 Emits GLFW_FEATURE_UNAVAILABLE if a
* `NULL` window handle is passed.
*
* @thread_safety This function must only be called from the main thread.
*
* @since Added in version 3.4.
*
* @ingroup window
*/
GLFWAPI void glfwSetWindowBadge(GLFWwindow* window, int count); GLFWAPI void glfwSetWindowBadge(GLFWwindow* window, int count);
//TODO Documentation /*! @brief Sets the dock or taskbar badge for the specified window or the application.
*
* This function sets the dock or taskbar badge for the specified window
* or the application as a whole. Any string badge set with this function
* overrides the number badge set with @ref glfwSetWindowBadge.
* If the platform does not support string badges, the number badge
* is not overridden.
*
* @param[in] window The window whose badge to set.
* @param[in] string The text to set, or `NULL` to disable it.
*
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
* GLFW_PLATFORM_ERROR, and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
*
* @remark @macos Only the Dock icon may contain a badge. Pass a `NULL`
* window handle to set it. Emits @ref GLFW_FEATURE_UNAVAILABLE if a
* valid window handle is passed.
*
* @remark @x11 @wayland @win32 Emits GLFW_FEATURE_UNAVAILABLE.
*
* @thread_safety This function must only be called from the main thread.
*
* @since Added in version 3.4.
*
* @ingroup window
*/
GLFWAPI void glfwSetWindowBadgeString(GLFWwindow* window, const char* string); GLFWAPI void glfwSetWindowBadgeString(GLFWwindow* window, const char* string);
/*! @brief Retrieves the position of the content area of the specified window. /*! @brief Retrieves the position of the content area of the specified window.