Sync SDL3 wiki -> header

[ci skip]
This commit is contained in:
SDL Wiki Bot 2025-03-23 15:58:18 +00:00
parent fa0a86409c
commit b8381b3a2e
1 changed files with 7 additions and 6 deletions

View File

@ -2824,8 +2824,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOp
* Sets the state of the progress bar for the given windows taskbar icon. * Sets the state of the progress bar for the given windows taskbar icon.
* *
* \param window the window whose progress state is to be modified. * \param window the window whose progress state is to be modified.
* \param state the progress state. * \param state the progress state. `SDL_PROGRESS_STATE_NONE` stops displaying
* `SDL_PROGRESS_STATE_NONE` stops displaying the progress bar. * the progress bar.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
@ -2838,12 +2838,13 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressState(SDL_Window *window,
/** /**
* Sets the value of the progress bar for the given windows taskbar icon. * Sets the value of the progress bar for the given windows taskbar icon.
* *
* If the state is `SDL_PROGRESS_STATE_NONE` or `SDL_PROGRESS_STATE_INDETERMINATE`, * If the state is `SDL_PROGRESS_STATE_NONE` or
* it gets changed to `SDL_PROGRESS_STATE_NORMAL`. * `SDL_PROGRESS_STATE_INDETERMINATE`, it gets changed to
* `SDL_PROGRESS_STATE_NORMAL`.
* *
* \param window the window whose progress value is to be modified. * \param window the window whose progress value is to be modified.
* \param value the progress value (0.0f - start, 1.0f - end). * \param value the progress value (0.0f - start, 1.0f - end). If the value is
* If the value is outside the valid range, it gets clamped. * outside the valid range, it gets clamped.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *