Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2025-11-04 06:15:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation to window.dox

Browse Source
This commit is contained in:
GamesTrap 2023-02-05 04:19:15 +01:00
parent 74dac5cfb4
commit 4a66bf3b60
No known key found for this signature in database
GPG Key ID: 31DFD452434ECDA3
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/window.dox
View File

@ -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

2
src/win32_window.c
View File

@ -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;
}