Skip to content

Commit af16f78

Browse files
marler8997marler8997
committed
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.
1 parent 44f4400 commit af16f78

14 files changed

+14
-14
lines changed

‎parser/output/raylib_api.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3280,7 +3280,7 @@
32803280
},
32813281
{
32823282
"name": "RestoreWindow",
3283-
"description": "Set window state: not minimized/maximized",
3283+
"description": "Restore window from being minimized/maximized",
32843284
"returnType": "void"
32853285
},
32863286
{

‎parser/output/raylib_api.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -3223,7 +3223,7 @@ return {
32233223
},
32243224
{
32253225
name = "RestoreWindow",
3226-
description = "Set window state: not minimized/maximized",
3226+
description = "Restore window from being minimized/maximized",
32273227
returnType = "void"
32283228
},
32293229
{

‎parser/output/raylib_api.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1085,7 +1085,7 @@ Function 017: MinimizeWindow() (0 input parameters)
10851085
Function 018: RestoreWindow() (0 input parameters)
10861086
Name: RestoreWindow
10871087
Return type: void
1088-
Description: Set window state: not minimized/maximized
1088+
Description: Restore window from being minimized/maximized
10891089
No input parameters
10901090
Function 019: SetWindowIcon() (1 input parameters)
10911091
Name: SetWindowIcon

‎parser/output/raylib_api.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@
720720
</Function>
721721
<Function name="MinimizeWindow" retType="void" paramCount="0" desc="Set window state: minimized, if resizable">
722722
</Function>
723-
<Function name="RestoreWindow" retType="void" paramCount="0" desc="Set window state: not minimized/maximized">
723+
<Function name="RestoreWindow" retType="void" paramCount="0" desc="Restore window from being minimized/maximized">
724724
</Function>
725725
<Function name="SetWindowIcon" retType="void" paramCount="1" desc="Set icon for window (single image, RGBA 32bit)">
726726
<Param type="Image" name="image" desc="" />

‎projects/Notepad++/raylib_npp_parser/raylib_npp.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<Overload retVal="void" descr="Set window state: minimized, if resizable"></Overload>
6666
</KeyWord>
6767
<KeyWord name="RestoreWindow" func="yes">
68-
<Overload retVal="void" descr="Set window state: not minimized/maximized"></Overload>
68+
<Overload retVal="void" descr="Restore window from being minimized/maximized"></Overload>
6969
</KeyWord>
7070
<KeyWord name="SetWindowIcon" func="yes">
7171
<Overload retVal="void" descr="Set icon for window (single image, RGBA 32bit)">

‎projects/Notepad++/raylib_npp_parser/raylib_to_parse.h

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

‎src/platforms/rcore_android.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ void MinimizeWindow(void)
337337
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
338338
}
339339

340-
// Set window state: not minimized/maximized
340+
// Restore window from being minimized/maximized
341341
void RestoreWindow(void)
342342
{
343343
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

‎src/platforms/rcore_desktop_glfw.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ void MinimizeWindow(void)
292292
glfwIconifyWindow(platform.handle);
293293
}
294294

295-
// Set window state: not minimized/maximized
295+
// Restore window from being minimized/maximized
296296
void RestoreWindow(void)
297297
{
298298
if (glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE)

‎src/platforms/rcore_desktop_rgfw.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ void MinimizeWindow(void)
339339
RGFW_window_minimize(platform.window);
340340
}
341341

342-
// Set window state: not minimized/maximized
342+
// Restore window from being minimized/maximized
343343
void RestoreWindow(void)
344344
{
345345
if (!(CORE.Window.flags & FLAG_WINDOW_UNFOCUSED)) RGFW_window_focus(platform.window);

‎src/platforms/rcore_desktop_sdl.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ void MinimizeWindow(void)
508508
if ((CORE.Window.flags & FLAG_WINDOW_MINIMIZED) == 0) CORE.Window.flags |= FLAG_WINDOW_MINIMIZED;
509509
}
510510

511-
// Set window state: not minimized/maximized
511+
// Restore window from being minimized/maximized
512512
void RestoreWindow(void)
513513
{
514514
SDL_RestoreWindow(platform.window);

‎src/platforms/rcore_drm.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ void MinimizeWindow(void)
277277
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
278278
}
279279

280-
// Set window state: not minimized/maximized
280+
// Restore window from being minimized/maximized
281281
void RestoreWindow(void)
282282
{
283283
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

‎src/platforms/rcore_template.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ void MinimizeWindow(void)
114114
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
115115
}
116116

117-
// Set window state: not minimized/maximized
117+
// Restore window from being minimized/maximized
118118
void RestoreWindow(void)
119119
{
120120
TRACELOG(LOG_WARNING, "RestoreWindow() not available on target platform");

‎src/platforms/rcore_web.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ void MinimizeWindow(void)
350350
TRACELOG(LOG_WARNING, "MinimizeWindow() not available on target platform");
351351
}
352352

353-
// Set window state: not minimized/maximized
353+
// Restore window from being minimized/maximized
354354
void RestoreWindow(void)
355355
{
356356
if ((glfwGetWindowAttrib(platform.handle, GLFW_RESIZABLE) == GLFW_TRUE) && (CORE.Window.flags & FLAG_WINDOW_MAXIMIZED))

‎src/raylib.h

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

0 commit comments

Comments
 (0)