Improve description of RestoreWindow

Restore window currently says it sets the window state to:

   "not minimized/maximized"

However, if a window is maximized and then minimized, it's typical that
it would restore back to being maximized, which is what seems to happen
from my testing. I've reworded the description to better reflect
this behavior.
This commit is contained in:
Jonathan Marler 2025-03-28 10:37:32 -06:00
parent 44f4400f5b
commit af16f7823a
14 changed files with 14 additions and 14 deletions

View file

@ -3280,7 +3280,7 @@
}, },
{ {
"name": "RestoreWindow", "name": "RestoreWindow",
"description": "Set window state: not minimized/maximized", "description": "Restore window from being minimized/maximized",
"returnType": "void" "returnType": "void"
}, },
{ {

View file

@ -3223,7 +3223,7 @@ return {
}, },
{ {
name = "RestoreWindow", name = "RestoreWindow",
description = "Set window state: not minimized/maximized", description = "Restore window from being minimized/maximized",
returnType = "void" returnType = "void"
}, },
{ {

View file

@ -1085,7 +1085,7 @@ Function 017: MinimizeWindow() (0 input parameters)
Function 018: RestoreWindow() (0 input parameters) Function 018: RestoreWindow() (0 input parameters)
Name: RestoreWindow Name: RestoreWindow
Return type: void Return type: void
Description: Set window state: not minimized/maximized Description: Restore window from being minimized/maximized
No input parameters No input parameters
Function 019: SetWindowIcon() (1 input parameters) Function 019: SetWindowIcon() (1 input parameters)
Name: SetWindowIcon Name: SetWindowIcon

View file

@ -720,7 +720,7 @@
</Function> </Function>
<Function name="MinimizeWindow" retType="void" paramCount="0" desc="Set window state: minimized, if resizable"> <Function name="MinimizeWindow" retType="void" paramCount="0" desc="Set window state: minimized, if resizable">
</Function> </Function>
<Function name="RestoreWindow" retType="void" paramCount="0" desc="Set window state: not minimized/maximized"> <Function name="RestoreWindow" retType="void" paramCount="0" desc="Restore window from being minimized/maximized">
</Function> </Function>
<Function name="SetWindowIcon" retType="void" paramCount="1" desc="Set icon for window (single image, RGBA 32bit)"> <Function name="SetWindowIcon" retType="void" paramCount="1" desc="Set icon for window (single image, RGBA 32bit)">
<Param type="Image" name="image" desc="" /> <Param type="Image" name="image" desc="" />

View file

@ -65,7 +65,7 @@
<Overload retVal="void" descr="Set window state: minimized, if resizable"></Overload> <Overload retVal="void" descr="Set window state: minimized, if resizable"></Overload>
</KeyWord> </KeyWord>
<KeyWord name="RestoreWindow" func="yes"> <KeyWord name="RestoreWindow" func="yes">
<Overload retVal="void" descr="Set window state: not minimized/maximized"></Overload> <Overload retVal="void" descr="Restore window from being minimized/maximized"></Overload>
</KeyWord> </KeyWord>
<KeyWord name="SetWindowIcon" func="yes"> <KeyWord name="SetWindowIcon" func="yes">
<Overload retVal="void" descr="Set icon for window (single image, RGBA 32bit)"> <Overload retVal="void" descr="Set icon for window (single image, RGBA 32bit)">

View file

@ -20,7 +20,7 @@ RLAPI void ToggleFullscreen(void); // Toggle wind
RLAPI void ToggleBorderlessWindowed(void); // Toggle window state: borderless windowed, resizes window to match monitor resolution RLAPI void ToggleBorderlessWindowed(void); // Toggle window state: borderless windowed, resizes window to match monitor resolution
RLAPI void MaximizeWindow(void); // Set window state: maximized, if resizable RLAPI void MaximizeWindow(void); // Set window state: maximized, if resizable
RLAPI void MinimizeWindow(void); // Set window state: minimized, if resizable RLAPI void MinimizeWindow(void); // Set window state: minimized, if resizable
RLAPI void RestoreWindow(void); // Set window state: not minimized/maximized RLAPI void RestoreWindow(void); // Restore window from being minimized/maximized
RLAPI void SetWindowIcon(Image image); // Set icon for window (single image, RGBA 32bit) RLAPI void SetWindowIcon(Image image); // Set icon for window (single image, RGBA 32bit)
RLAPI void SetWindowIcons(Image *images, int count); // Set icon for window (multiple images, RGBA 32bit) RLAPI void SetWindowIcons(Image *images, int count); // Set icon for window (multiple images, RGBA 32bit)
RLAPI void SetWindowTitle(const char *title); // Set title for window RLAPI void SetWindowTitle(const char *title); // Set title for window

View file

@ -337,7 +337,7 @@ void MinimizeWindow(void)
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform"); TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform"); TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

View file

@ -292,7 +292,7 @@ void MinimizeWindow(void)
glfwIconifyWindow(platform.handle); glfwIconifyWindow(platform.handle);
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
if (glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE) if (glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE)

View file

@ -339,7 +339,7 @@ void MinimizeWindow(void)
RGFW_window_minimize(platform.window); RGFW_window_minimize(platform.window);
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
if (!(CORE.Window.flags & FLAG_WINDOW_UNFOCUSED)) RGFW_window_focus(platform.window); if (!(CORE.Window.flags & FLAG_WINDOW_UNFOCUSED)) RGFW_window_focus(platform.window);

View file

@ -508,7 +508,7 @@ void MinimizeWindow(void)
if ((CORE.Window.flags & FLAG_WINDOW_MINIMIZED) == 0) CORE.Window.flags |= FLAG_WINDOW_MINIMIZED; if ((CORE.Window.flags & FLAG_WINDOW_MINIMIZED) == 0) CORE.Window.flags |= FLAG_WINDOW_MINIMIZED;
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
SDL_RestoreWindow(platform.window); SDL_RestoreWindow(platform.window);

View file

@ -277,7 +277,7 @@ void MinimizeWindow(void)
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform"); TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform"); TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

View file

@ -114,7 +114,7 @@ void MinimizeWindow(void)
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform"); TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform"); TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

View file

@ -350,7 +350,7 @@ void MinimizeWindow(void)
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform"); TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
} }
// Set window state: not minimized/maximized // Restore window from being minimized/maximized
void RestoreWindow(void) void RestoreWindow(void)
{ {
if ((glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE) && (CORE.Window.flags & FLAG_WINDOW_MAXIMIZED)) if ((glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE) && (CORE.Window.flags & FLAG_WINDOW_MAXIMIZED))

View file

@ -987,7 +987,7 @@ RLAPI void ToggleFullscreen(void); // Toggle wind
RLAPI void ToggleBorderlessWindowed(void); // Toggle window state: borderless windowed, resizes window to match monitor resolution RLAPI void ToggleBorderlessWindowed(void); // Toggle window state: borderless windowed, resizes window to match monitor resolution
RLAPI void MaximizeWindow(void); // Set window state: maximized, if resizable RLAPI void MaximizeWindow(void); // Set window state: maximized, if resizable
RLAPI void MinimizeWindow(void); // Set window state: minimized, if resizable RLAPI void MinimizeWindow(void); // Set window state: minimized, if resizable
RLAPI void RestoreWindow(void); // Set window state: not minimized/maximized RLAPI void RestoreWindow(void); // Restore window from being minimized/maximized
RLAPI void SetWindowIcon(Image image); // Set icon for window (single image, RGBA 32bit) RLAPI void SetWindowIcon(Image image); // Set icon for window (single image, RGBA 32bit)
RLAPI void SetWindowIcons(Image *images, int count); // Set icon for window (multiple images, RGBA 32bit) RLAPI void SetWindowIcons(Image *images, int count); // Set icon for window (multiple images, RGBA 32bit)
RLAPI void SetWindowTitle(const char *title); // Set title for window RLAPI void SetWindowTitle(const char *title); // Set title for window