mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-02-16 00:24:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Progress bar comment changes

Browse Source
This commit is contained in:
Petar Popovic
2025-03-26 13:36:58 +01:00
committed by Sam Lantinga
parent e28974124a
commit 00f316737b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
include/SDL3/SDL_video.h
View File

@@ -2840,7 +2840,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressState(SDL_Window *window,
* Get the state of the progress bar for the given window’s taskbar icon.
*
* \param window the window to get the current progress state from.
* \returns the progress state, or SDL_PROGRESS_STATE_INVALID on failure; call
* \returns the progress state, or `SDL_PROGRESS_STATE_INVALID` on failure; call
* SDL_GetError() for more information.
*
* \threadsafety This function should only be called on the main thread.
@@ -2853,7 +2853,7 @@ extern SDL_DECLSPEC SDL_ProgressState SDLCALL SDL_GetWindowProgressState(SDL_Win
* Sets the value of the progress bar for the given window’s taskbar icon.
*
* \param window the window whose progress value is to be modified.
* \param value the progress value (0.0f - start, 1.0f - end). If the value is
* \param value the progress value in the range of [0.0f - 1.0f]. If the value is
* outside the valid range, it gets clamped.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
@@ -2868,7 +2868,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressValue(SDL_Window *window,
* Get the value of the progress bar for the given window’s taskbar icon.
*
* \param window the window to get the current progress value from.
* \returns the progress value in the range of [0.0 - 1.0], or -1 on failure;
* \returns the progress value in the range of [0.0f - 1.0f], or -1.0f on failure;
* call SDL_GetError() for more information.
*
* \threadsafety This function should only be called on the main thread.