From 4a66bf3b60ef268ae9414888548be88c07e69d77 Mon Sep 17 00:00:00 2001 From: GamesTrap Date: Sun, 5 Feb 2023 04:19:15 +0100 Subject: [PATCH] Added documentation to window.dox --- docs/window.dox | 17 ++++++++++++++++- src/win32_window.c | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/window.dox b/docs/window.dox index f464d3c9..fc8bf8ad 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -1161,7 +1161,22 @@ attention, the system will automatically end the request. @subsection window_taskbar_progress Window taskbar progress -TBD +If you whish to display the progress of some action on the taskbar, you can +do this with @ref glfwSetWindowTaskbarProgress. + +@code +glfwSetWindowTaskbarProgress(window, GLFW_TASKBAR_PROGRESS_NORMAL, 50); +@endcode + +There are different taskbar progress states available for you to use: + - @ref GLFW_TASKBAR_PROGRESS_NOPROGRESS + - @ref GLFW_TASKBAR_PROGRESS_INDETERMINATE + - @ref GLFW_TASKBAR_PROGRESS_NORMAL + - @ref GLFW_TASKBAR_PROGRESS_ERROR + - @ref GLFW_TASKBAR_PROGRESS_PAUSED + +The last argument is the progress percentage to display. +It has a valid range of 0 to 100. @subsection window_refresh Window damage and refresh diff --git a/src/win32_window.c b/src/win32_window.c index 0d393f4b..fe4c2b56 100644 --- a/src/win32_window.c +++ b/src/win32_window.c @@ -1603,7 +1603,7 @@ void _glfwSetWindowTaskbarProgressWin32(_GLFWwindow* window, const int progressS if(!IsWindows7OrGreater()) { - _glfwInputErrorWin32(GLFW_FEATURE_UNAVAILABLE, "Win32: Taskbar progress is only supported on Windows 7 or newer"); + _glfwInputError(GLFW_FEATURE_UNAVAILABLE, "Win32: Taskbar progress is only supported on Windows 7 or newer"); return; }